Skip to main content

Airbyte Google-Search-Console Connector for AI platforms

Project description

Google-Search-Console

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.

Example questions

The Google-Search-Console connector is optimized to handle prompts like these.

  • 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

Unsupported questions

The Google-Search-Console connector isn't currently able to handle prompts like these.

  • Submit a new sitemap
  • Add a new site to Search Console
  • Remove a site from Search Console
  • Inspect a URL's index status
  • Request indexing for a page

Installation

uv pip install airbyte-agent-google-search-console

Usage

Connectors can run in open source or hosted mode.

Open source

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 {})

Hosted

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 {})

Full documentation

Entities and actions

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

Authentication

For all authentication options, see the connector's authentication documentation.

Google-Search-Console API docs

See the official Google-Search-Console API reference.

Version information

  • Package version: 0.1.4
  • Connector version: 1.0.0
  • Generated with Connector SDK commit SHA: 6ad04bc3fb66fc474336c37d69c79fb843ea1609
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_google_search_console-0.1.4.tar.gz (157.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file airbyte_agent_google_search_console-0.1.4.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_google_search_console-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1553ff8a29e9ab953d6dc25e9dba3ba85ce5e7fe4f3cafd7d852763a6fb12ed7
MD5 870496450e945521f1989b18f7c40e30
BLAKE2b-256 f6f990ffa0d04ebaaf1b131af95139c5a5879bf512dc3c950ac0340e1af0da34

See more details on using hashes here.

File details

Details for the file airbyte_agent_google_search_console-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_google_search_console-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 878e656f8dc60b1ccbe7a7449b6ae9686d3555f7c8648433514837343157a775
MD5 44ee9885ce7ed3b5e96ade3a1c783a7a
BLAKE2b-256 f6ec15ad31fbb6a39555a63f1b75dffa613ef5ac2b000d997fda3054c891ae83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page