tap-google-search-console - Meltano Hub

Google Search Console

tap-google-search-console (meltanolabs variant)🥇

Search platform

The tap-google-search-console extractor pulls data from Google Search Console that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-google-search-console extractor to your project using
```
meltano add
```
:

meltano add extractor tap-google-search-console

Configure the tap-google-search-console settings using

meltano config

:

meltano config tap-google-search-console set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-google-search-console test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-google-search-console may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
batch
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-google-search-console settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

backfill_days
client_secrets
include_freshest_data
site_url
start_date

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-google-search-console list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Backfill Days (backfill_days)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_BACKFILL_DAYS
Default Value: 3

Used to backfill the last N days when using fresh data to ensure corrections are applied

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set backfill_days [value]

Client Secrets (client_secrets)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_CLIENT_SECRETS

Google Analytics Client Secrets Dictionary

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set client_secrets [value]

Include Freshest Data (include_freshest_data)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_INCLUDE_FRESHEST_DATA
Default Value: true

Include freshest data as detailed here: https://developers.google.com/search/blog/2019/09/search-performance-fresh-data

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set include_freshest_data [value]

Site URL (site_url)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_SITE_URL

Project IDs to replicate

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set site_url [value]

Start Date (start_date)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set start_date [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-google-search-console extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-google-search-console

Maintenance Status

Repo

https://github.com/MeltanoLabs/tap-google-search-console

Maintainer

Keywords