Google Search Console

Connect to your users' Google Search Console accounts

Setup Guide

You can find your Google app credentials by visiting your Google Cloud Console dashboard.

You'll need the following information to set up your Google App with Paragon Connect:

  • Client ID

  • Client Secret

  • Scopes Requested

Note: You'll need to create a new project in Google Cloud Console if you don't already have one.

Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "Redirect URL" in your integration settings in Paragon. The Redirect URL is:

https://passport.useparagon.com/oauth

2. In your Google Cloud Console dashboard, navigate to APIs & Services > Credentials in the sidebar.

3. Press "+ Create Credentials", then select OAuth client ID.

4. Select "Web application" from the Application type drop-down menu.

Note: You'll need to configure Google's consent screen for access to Client ID and Client Secret if you haven't already.

5. Under Authorized redirect URIs, press the "+ Add URI" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "Create" button.

Google provides you with the Client ID and Client Secret needed for the next steps after adding the redirect URL to your project.

Enable Google Campaign Manager 360 API in Google Cloud Console Dashboard

1. In your Google Cloud Console dashboard, navigate to APIs & Services > Library in the sidebar.

2. Search for "Google Search Console" from the API Library.

3. Select the "Google Campaign Manager 360 API".

4. Press the blue "Enable" button to enable the API for your application.

Add your Google app to Paragon

1. Select Google Search Console from the Integrations Catalog.

2. Under Integrations > Connected Integrations > {YOUR_APP} > Settings, fill out your credentials from the end of Step 1 in their respective sections:

  • Client ID: Found at the end of Step 1.

  • Client Secret: Found at the end of Step 1.

  • Permissions: Select the scopes you've requested for your application. They should contain /auth/.

Press the blue "Connect" button to save your credentials.

Note: Leaving the Client ID and Client Secret blank will use Paragon development keys.

Connecting to Google Search Console

Once your users have connected their Google Search Console account, you can use the Paragon SDK to access the Google Search Console API on behalf of connected users.

See the Google Search Console REST API documentation for their full API reference.

Any Google Search Console API endpoints can be accessed with the Paragon SDK as shown in this example.

// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get top 10 search queries, sorted by click count, descending
await paragon.request(
  "googlesearchconsole",
  "/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query",
  {
    method: "POST",
    body: {
      startDate: "<Start Date>",
      endDate: "<End Date>",
      dimensions: ['query'],
      rowLimit: 10
    }
  }
});
  
// Get top 10 pages, sorted by click count, descending
await paragon.request(
  "googlesearchconsole",
  "/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query",
  {
    method: "POST",
    body: {
      startDate: "<Start Date>",
      endDate: "<End Date>",
      dimensions: ['page'],
      rowLimit: 10
    }
  }
);
  

Building Google Search Console workflows

Once your Google Search Console account is connected, you can add steps to perform the following actions:

  • Query Search Data

  • Inspect Index Info for URL

  • Get All Sites

  • Create Site

  • Delete Site

When creating or getting sites in Google Search Console, you can reference data from previous steps by typing {{ to invoke the variable menu.

Publishing your Google Search Console application

Setting up a Redirect Page in your app

Your Google Search Console integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

  • Receives a GET request with a number of query parameters.

  • Redirect to https://passport.useparagon.com/oauth with the same query parameters.

paragon.connect("googlesearchconsole", {
  overrideRedirectUrl: "https://your-app.url/google-search-console-redirect"
});

Updating the allowed Redirect URL

If you were previously testing with https://passport.useparagon.com/oauth as your Google Search Console Redirect URL, you will need to update this value after implementing a Redirect Page:

  1. Log into your Google Cloud Console dashboard and select your application.

  2. Navigate to APIs & Services > Credentials and select the credentials you use with Paragon.

  3. Under Authorized redirect URIs, provide the URL of your Redirect Page.

Last updated