README

This package adds an inspector tab for document level nodes, which provides insights into Google Search Console data for the given document, provided by the Google Search Console URL Inspection API.

Installation

composer require netlogix/googlesearchconsoleinspector

Configuration

A JSON credentials file for a Google service account is required. See Create a service account for details. The path to the credentials file should be set in the environment variable GOOGLE_APPLICATION_CREDENTIALS.

Alternatively, the path can be set at the configuration path Netlogix.GoogleSearchConsoleInspector.api.clientConfig.credentials.

At Netlogix.GoogleSearchConsoleInspector.siteUrlMapping add the mapping of Google Search Console Properties to URL prefixes for your site. Please refer to Google's documentation for details.

Netlogix:
  GoogleSearchConsoleInspector:
    api:
      # See https://github.com/googleapis/google-api-php-client/blob/main/src/Client.php#L112
      clientConfig:
        'application_name': 'Neos Search Console Inspector'

        # See https://developers.google.com/workspace/guides/create-credentials?hl=en#create_a_service_account
        'credentials': '%env:GOOGLE_APPLICATION_CREDENTIALS%'

    siteUrlMapping:
      'sc-domain:example.org':
        - 'https://www.example.org'
        - 'https://example.org'

      'https://www.example.com':
        - 'https://www.example.com'

Usage

On document level nodes a new tab will be added in the left-hand inspector window. It provides the following functionality:

The first section offers a button leading directly to Googles own URL Inspection Tool, preconfigured with the current page data.

The second sections provides data about Google's indexing status, mobile usability according to Google, rich results availability and the last time the site was crawled.

The third section displays information about the current Google and user canonicals used.

The fourth section contains a list of Urls for which Google is aware of the current page is being referenced from.

The last section shows information Google has about the structured data the page contains.