SEO Check | Version 4

Enabling Google Search Console

SEO Check can use Google's Search Console API to inquire information about your website. To use this feature, you need to provide a JSON key to a service account for your Google Cloud Platform project. This guide shows how to create a service account and a key.

Requirements

To enable SEO Check's Google Search Console features, you first need to create a project in Google Cloud Platform. Your administrator may have already created a project for your website.

You also need a property in Google Search Console.

Enabling Google Search Console API

In the Google Cloud Platform Console, navigate to your project. Search for Google Search Console API, and select it from the results:

Searching for Google Search Console API in Google Cloud Platform
Searching for Google Search Console API in Google Cloud Platform (Image: subshell GmbH/CC BY)

If the Google Search Console API is not activated for your project, click Enable to activate it.

Enabling the Google Search Console API for a Google Cloud Platform project
Enabling the Google Search Console API for a Google Cloud Platform project (Image: subshell GmbH/CC BY)

If the Google Search Console API is activated for your project, it should look like this:

The Google Search Console API is enabled for a Google Cloud Platform project
The Google Search Console API is enabled for a Google Cloud Platform project (Image: subshell GmbH/CC BY)

Creating a Service Account and a JSON Key

From the main menu, select IAM & Admin, then Service Accounts:

Opening the Service Accounts page of a Google Cloud Platform project
Opening the Service Accounts page of a Google Cloud Platform project (Image: subshell GmbH/CC BY)

To create a new service account, click Create Service Account. Enter the required information.

Creating a service account for a Google Cloud Platform project
Creating a service account for a Google Cloud Platform project (Image: subshell GmbH/CC BY)

Open the newly-created service account, then select the Keys page:

Opening the keys page of a service account in Google Cloud Platform
Opening the keys page of a service account in Google Cloud Platform (Image: subshell GmbH/CC BY)

To create a new JSON key, click Add Key, then select Create new key:

Creating a new key for a service account in Google Cloud Platform
Creating a new key for a service account in Google Cloud Platform (Image: subshell GmbH/CC BY)

Select the JSON key type, then click Create to create the key:

Creating a new key for a service account in Google Cloud Platform
Creating a new key for a service account in Google Cloud Platform (Image: subshell GmbH/CC BY)

When you click Create, a JSON file containing the private key information will be downloaded to your device.

Adding JSON Key to SEO Check Configuration

Place the JSON key file in a directory accessible to the SEO Check application.

In the configuration file for SEO Check, enter the Google Search Console property name and the path to the JSON key file.

seo-check:
  google:
    # Settings for the Search Console API.
    search-console:
      # The web site's property name in Google Search Console.
      property-name: sc-domain:example.com
      # File system path to a JSON key file for a service account that can access the Google Cloud project.
      service-account-key-file: /path/to/key-123456-1234567890ab.json

Last modified on 3/16/22

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon