Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-google-search-console
[02]
Import
Initialize and use
PYTHON
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.google_search_console import (
GoogleSearchConsoleConnector,
)
from airbyte_agent_sdk.connectors.google_search_console.models import (
GoogleSearchConsoleAuthConfig,
)
connector = GoogleSearchConsoleConnector(
auth_config=GoogleSearchConsoleAuthConfig(
client_id=(
"<The client ID of your Google Search Console "
"developer application.>"
),
client_secret=(
"<The client secret of your Google Search Console "
"developer application.>"
),
refresh_token="<The refresh token for obtaining new access tokens.>",
)
)
agent = Agent("openai:gpt-4o")
[03]
Tool
Add tools to your agent
python
@agent.tool_plain
@GoogleSearchConsoleConnector.tool_utils
async def google_search_console_execute(
entity: str,
action: str,
params: dict | None = None,
):
return await connector.execute(entity, action, params or {})
Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Sites | [List](./REFERENCE.md#sites-list), [Get](./REFERENCE.md#sites-get), [Search](./REFERENCE.md#sites-search) |\n| Sitemaps | [List](./REFERENCE.md#sitemaps-list), [Get](./REFERENCE.md#sitemaps-get), [Search](./REFERENCE.md#sitemaps-search) |\n| Search Analytics By Date | [List](./REFERENCE.md#search-analytics-by-date-list), [Search](./REFERENCE.md#search-analytics-by-date-search) |\n| Search Analytics By Country | [List](./REFERENCE.md#search-analytics-by-country-list), [Search](./REFERENCE.md#search-analytics-by-country-search) |\n| Search Analytics By Device | [List](./REFERENCE.md#search-analytics-by-device-list), [Search](./REFERENCE.md#search-analytics-by-device-search) |\n| Search Analytics By Page | [List](./REFERENCE.md#search-analytics-by-page-list), [Search](./REFERENCE.md#search-analytics-by-page-search) |\n| Search Analytics By Query | [List](./REFERENCE.md#search-analytics-by-query-list), [Search](./REFERENCE.md#search-analytics-by-query-search) |\n| Search Analytics All Fields | [List](./REFERENCE.md#search-analytics-all-fields-list), [Search](./REFERENCE.md#search-analytics-all-fields-search) |
Example Prompts
Lorem ipsum
List all my verified sites in Search Console - Show me the sitemaps for my website - Get search analytics by date for the last 7 days - Show search performance broken down by country - What devices are people using to find my site? - Which pages get the most clicks? - What queries bring the most traffic to my site? - Which country has the highest CTR for my site? - What are my top 10 search queries by impressions? - Compare mobile vs desktop click-through rates - Which pages have the worst average position? - Show me search performance trends over the last month
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Google Search Console connector supports OAuth 2.0 authentication using a client ID, client secret, and refresh token. In hosted mode, credentials are stored securely in Airbyte Cloud and you authenticate using your Airbyte client ID and client secret instead.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
No, the Google Search Console connector currently only supports read operations. Write operations such as submitting sitemaps, adding or removing sites, inspecting URL index status, or requesting indexing for a page are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Whether you're building Agents or Data Pipelines.