docs/ai-agents/connectors/google-search-console/README.md
The Google-Search-Console agent connector is a Python package that equips AI agents to interact with Google-Search-Console through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
Connector for the Google Search Console API. Provides access to website search performance data including clicks, impressions, CTR, and average position. Supports listing verified sites, sitemaps, and querying search analytics data broken down by date, country, device, page, and query dimensions.
The Google-Search-Console connector is optimized to handle prompts like these.
The Google-Search-Console connector isn't currently able to handle prompts like these.
uv pip install airbyte-agent-google-search-console
Connectors can run in open source or hosted mode.
In open source mode, you provide API credentials directly to the connector.
from airbyte_agent_google_search_console import GoogleSearchConsoleConnector
from airbyte_agent_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.tool_plain # assumes you're using Pydantic AI
@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 {})
In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
If your Airbyte client can access multiple organizations, also set organization_id.
This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.
from airbyte_agent_google_search_console import GoogleSearchConsoleConnector, AirbyteAuthConfig
connector = GoogleSearchConsoleConnector(
auth_config=AirbyteAuthConfig(
customer_name="<your_customer_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@agent.tool_plain # assumes you're using Pydantic AI
@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 {})
This connector supports the following entities and actions. For more details, see this connector's full reference documentation.
| Entity | Actions |
|---|---|
| Sites | List, Get, Search |
| Sitemaps | List, Get, Search |
| Search Analytics By Date | List, Search |
| Search Analytics By Country | List, Search |
| Search Analytics By Device | List, Search |
| Search Analytics By Page | List, Search |
| Search Analytics By Query | List, Search |
| Search Analytics All Fields | List, Search |
For all authentication options, see the connector's authentication documentation.
See the official Google-Search-Console API reference.