Before configuring the Google Search Console connector, ensure the following:
A Google account
Access to a verified property in Google Search Console (or the list of property URLs)
The Google Search Console API must be enabled for your project in the Google Cloud Console
Authentication Options for Google Search Console
You can authenticate the connector using either OAuth 2.0 or a Service Account with a JSON key.
Option 1: OAuth 2.0
Use this method if you own or have viewing permissions for the Search Console property. It’s the preferred approach for ease of setup and direct integration through the xGen user interface.
To authenticate using OAuth, you’ll need:
Client ID
Client Secret
Refresh Token
Access Token (optional but recommended)
Follow Google’s official instructions to create an OAuth app and generate these credentials. Make sure your Google account has either “Owner” or “Full User” access to the relevant Search Console property.
Option 2: Service Account with JSON Key
If you prefer to use a service account, follow these steps:
Provide a name and (optionally) a description, then proceed.
Assign roles to the account—Viewer is generally sufficient.
Navigate to API Console > Credentials, select the created service account, and open the Keys tab.
Click + Add Key → Create new key, then select JSON.
The system will generate and download the key file. Store it securely, as it cannot be downloaded again.
You can always return to the credentials console to manage keys or create new ones.
(Optional) Enable Domain-Wide Delegation
In enterprise environments using Google Workspace, domain-wide delegation allows service accounts to access data across multiple users and services by impersonating users.
Only a super admin can grant this capability.
The following OAuth scope must be added: https://www.googleapis.com/auth/webmasters.readonly Follow Google’s official documentation for a detailed setup.
How to Connect Google Search Console
On the source configuration screen, choose Google Search Console from the source type dropdown.
Assign a custom name to your connector.
Choose your preferred authentication method:
Service Account (Recommended): Select Service Account Key Authorization, then input:
Admin Email
Service Account JSON Key (ensure it begins with {"type": "service_account", ...})
OAuth: Select OAuth Authorization, then input:
Client ID
Client Secret
Access Token
Refresh Token
Optional Settings
End Date (YYYY-MM-DD): Restrict replication to data between the Start and End Dates. Leave blank to fetch data up to the present.
Custom Reports: You can provide an array of custom queries in JSON format to tailor your data pull. Refer to the Custom Reports section for formatting help.
Data Freshness: Choose whether to include Google’s “fresh” (non-finalized) data. If using Incremental Sync, we strongly recommend leaving this to the default setting (final) to ensure consistency.
Final Step
Click Set up source to validate the configuration and complete the connection process.