Skip to main content

Connect to Google Search Console

Learn how to connect the Google Search Console API to Retool.


The Google Search Console integration is in beta. Navigate to the Beta settings to enable.

You can connect to Google Search Console and make it available as a resource in Retool. Once complete, your users can write queries that interact with Google Search Console data.


All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

To create a Google Search Console resource, you need:

  • A Google Search Console project that is configured with the supported Google Search Console APIs.
  • An OAuth client and credentials, if you deploy using Self-hosted Retool.

1. Create a new resource

Sign in to your Retool organization and navigate to the Resources tab. Click Create new, then select Resource.

Create a new resource

2. Select the resource type

Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Select the Google Search Console resource type.

Create Google Cloud Storage resource

3. Configure the resource

Specify a name and location for the Google Search Console resource. Retool displays the resource name and type in query editors to help users identify them.

Retool Cloud setup

Retool uses OAuth to connect to Google Search Console. You’ll need to decide whether to grant Read and write or Read only access to Retool. Retool uses the option you select here to determine the scopes passed with the OAuth request.

Configure Google Search Console on Retool Cloud

Click Connect to Google Search Console to begin Google's authorization flow. After completing the authorization flow, you should see a message indicating a successful connection.

Self-hosted Retool setup

On self-hosted deployments, you'll need to provide credentials for a Google OAuth2 client. If you do not already have a client configured, see Retool's instructions for creating a Google OAuth2 client. Next, configure the required settings.

Client IDThe OAuth client ID.
Client secretThe OAuth client secret.

Copy the OAuth callback URL to your Google auth client. Click Create Resource.

Configure Google Search Console on Self-hosted Retool

Additional settings

For resources using OAuth 2.0, Retool provides the option to share credentials between users or to require each user to authenticate using their own credentials. The Google Search Console resource defaults to sharing credentials between users. If you want each app user to log in with their own Google account, uncheck Share Google Search Console credentials between users.

To learn more about OAuth 2.0 credentials in Retool, refer to Retool's API Authentication documentation.

4. Save the resource

Click Create resource to complete the setup. You can then click either Create a new app now to immediately start building a Retool app.

Create new app after saving Google Search Console resource

Wrap up

Your Google Search Console resource is now ready to use. To interact with Google Search Console data, select the resource in the query editor.