Google-Search-Console authentication

This page documents the authentication and configuration options for the Google-Search-Console agent connector.

Authentication

Open source execution

In open source mode, you provide API credentials directly to the connector.

OAuth

credentials fields you need:

Field Name	Type	Required	Description
client_id	str	Yes	The client ID of your Google Search Console developer application.
client_secret	str	Yes	The client secret of your Google Search Console developer application.
refresh_token	str	Yes	The refresh token for obtaining new access tokens.

Example request:

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.>"
    )
)

Token

This authentication method isn't available for this connector.

Hosted execution

In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the hosted execution tutorial.

OAuth

Create a connector with OAuth credentials.

credentials fields you need:

Field Name	Type	Required	Description
client_id	str	Yes	The client ID of your Google Search Console developer application.
client_secret	str	Yes	The client secret of your Google Search Console developer application.
refresh_token	str	Yes	The refresh token for obtaining new access tokens.

replication_config fields you need:

Field Name	Type	Required	Description
site_urls	str	Yes	The URLs of the website property attached to your GSC account. Examples: https://example.com/ or sc-domain:example.com
start_date	str (date)	No	UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "<CUSTOMER_NAME>",
    "connector_type": "Google-Search-Console",
    "name": "My Google-Search-Console Connector",
    "credentials": {
      "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.>"
    },
    "replication_config": {
      "site_urls": "<The URLs of the website property attached to your GSC account. Examples: https://example.com/ or sc-domain:example.com
>",
      "start_date": "<UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.
>"
    }
  }'

Bring your own OAuth flow

To implement your own OAuth flow, use Airbyte's server-side OAuth API endpoints. For a complete guide, see Build your own OAuth flow.

Step 1: Initiate the OAuth flow

Request a consent URL for your user.

Field Name	Type	Required	Description
customer_name	string	Yes	Your unique identifier for the customer
connector_type	string	Yes	The connector type (e.g., "Google-Search-Console")
redirect_url	string	Yes	URL to redirect to after OAuth authorization

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initiate" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "<CUSTOMER_NAME>",
    "connector_type": "Google-Search-Console",
    "redirect_url": "https://yourapp.com/oauth/callback"
  }'

Redirect your user to the consent_url from the response.

Step 2: Handle the callback

After the user authorizes access, Airbyte automatically creates the connector and redirects them to your redirect_url with a connector_id query parameter. You don't need to make a separate API call to create the connector.

https://yourapp.com/oauth/callback?connector_id=<connector_id>

Extract the connector_id from the callback URL and store it for future operations. For error handling and a complete implementation example, see Build your own OAuth flow.

Token

This authentication method isn't available for this connector.

Execution

After creating the connector, execute operations using either the Python SDK or API. If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.

Python SDK

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

API

curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
  -H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
  -H 'Content-Type: application/json' \
  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'