Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
The Google Search Console Batch source
Info
Note

This plugin is available in the Hubno longer available as of July 26, 2024.

Reads given dimensions from a Google Search Console API in JSON format. Outputs records with dimensions provided in configuration.

Configuration

Property

Macro Enabled?

Description

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.

Authentication Method

Yes

Required. The Google Search Console Batch source plugin supports the following authentication methods:

  • OAuth Client ID

  • Service Account

  • Service Account JSON

Default is Service Account.

OAuth Client ID

Client ID

Yes

Google Search Console client ID for authentication.

Client Secret

Yes

Google Search Console client secret for authentication.

Client Access Token

Yes

Google Search Console client access token.

Client Application Name

Yes

Google Search Console application name.

Service Account

Service account requires only the Service Account File Path.

Service Account File Path

Yes

Path on the local file system of the service account key used for authorization. Can be set to auto-detect when running on a Dataproc cluster. When running on other clusters, the file must be present on every node in the cluster.

Default is auto-detect.

Service Account JSON

Service Account JSON

Yes

Service Account JSON string.

Sites

Yes

Required. List of sites to query from. Can be set to All Sites, which will retrieve list of sites from Search Console API.

Default is All URLs.

Start date

Yes

Required. Start date in ​YYYY-MM-DD format, in PT time (UTC - 7:00/8:00).

End date

Yes

Required. Start date in ​YYYY-MM-DD format, in PT time (UTC - 7:00/8:00).

Dimension(s)

Yes

Required. List of comma separated dimensions to read from Google Search Console.

Number of Splits

Yes

Required. Number of splits to divide the number of sites into when reading from Google Search Console. Fewer splits might be created if the number of sites cannot be divided into the specified number of splits.

Default is 1.

Site List

Yes

Optional. List of sites to query from. Is active only when Site URL List option is selected.