Skip to main content

Connect to Google Search ConsoleBeta

Learn how to connect Google Search Console to Retool.

Enable Google Search Console integration

The Google Search Console integration is an opt-in beta. To enable, navigate to Settings > Beta and enable Google Search Console integration.

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

Sufficient user permissions to create resources

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.

Allow Retool to access the data source

If the data source is behind a firewall or restricts access based on IP address, then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

CIDR IP addresses
3.77.79.248/30
35.90.103.132/30
44.208.168.68/30
Individual IP addresses
3.77.79.249
3.77.79.250
35.90.103.132
35.90.103.133
35.90.103.134
35.90.103.135
44.208.168.68
44.208.168.69
44.208.168.70
44.208.168.71
Google Search Console settings and authentication

You must have sufficient access and familiarity with your Google Search Console data source so you can provide:

  • Required connection settings (e.g., URL and server variables).
  • Authentication credentials (e.g., API keys).

In some cases, you may need to make changes to your Google Search Console configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.

1. Configure the resource

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

Configuration

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

Provide the following configuration settings to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

Name

The name to use for the resource.

Description

A description of the resource.

Type

Whether to restrict access to read only or allow read and write operations.

Override default outbound Retool region

Retool connects to your data source from the us-west-2 region. Choosing a different outbound region can improve performance through geographic proximity.

RegionLocation
us-west-2US West (Oregon)
eu-central-1(Frankfurt, Germany)

Authentication

The Google Search Console integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your Google Search Console configuration.

OAuth 2.0

Authentication is performed using OAuth 2.0. Your users are redirected to Google Search Console to sign in and authorize Retool to access data.

OAuth enables you to quickly authenticate with Google. It also provides some control over the access Retool has to your Google data.

OAuth-based authentication with individual user credentials. Each user is prompted to authenticate with Google using an OAuth flow, and API calls from Retool are made on behalf of the logged-in user. When using apps built using authenticated Google resources, users can only interact with APIs and data to which they have access.

For example, cloud-hosted Retool organizations can grant Retool either Read and write or Read only access to Google Sheets data. This option determines the scopes passed with the OAuth request. Retool recommends Read and write so that Retool can read and write spreadsheet data (e.g., create new sheets or update cell rows).

To create other Google API resources, or to use Retool's Google integrations with self-hosted deployments, you create Google Cloud projects and OAuth 2.0 credentials with scopes you define.

3. Test the connection

Click Test Connection to verify that Retool can successfully connect to the data source. If the test fails, check the resource settings and try again.

Testing only verifies connection

Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.

4. Save the resource

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Google Search Console resource is now ready to use. To start querying data:

  1. Add a Resource query to an app or workflow.
  2. Select the Google Search Console resource from the resources dropdown.
  3. Write and run a query.

Refer to the queries documentation to learn more about interacting with your data.