Google Search Console

tap-google-search-console (airbyte 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.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Alternate Implementations

Getting Started

Prerequisites

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-google-search-console extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-google-search-console --variant airbyte
  2. Configure the tap-google-search-console settings using 
    meltano config
     : 
    3. meltano config tap-google-search-console set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-google-search-console test

Next steps

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
  • 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:

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.

Airbyte Config Authorization Access Token (airbyte_config.authorization.access_token)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_ACCESS_TOKEN

Access token for making authenticated requests. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.access_token [value]

Airbyte Config Authorization Auth Type (airbyte_config.authorization.auth_type)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_AUTH_TYPE

Client, Service


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.auth_type [value]

Airbyte Config Authorization Client Id (airbyte_config.authorization.client_id)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_CLIENT_ID

The client ID of your Google Search Console developer application. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.client_id [value]

Airbyte Config Authorization Client Secret (airbyte_config.authorization.client_secret)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_CLIENT_SECRET

The client secret of your Google Search Console developer application. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.client_secret [value]

Airbyte Config Authorization Email (airbyte_config.authorization.email)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_EMAIL

The email of the user which has permissions to access the Google Workspace Admin APIs.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.email [value]

Airbyte Config Authorization Refresh Token (airbyte_config.authorization.refresh_token)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_REFRESH_TOKEN

The token for obtaining a new access token. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.refresh_token [value]

Airbyte Config Authorization Service Account Info (airbyte_config.authorization.service_account_info)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_AUTHORIZATION_SERVICE_ACCOUNT_INFO

The JSON key of the service account to use for authorization. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config authorization.service_account_info [value]

Airbyte Config Custom Reports (airbyte_config.custom_reports)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_CUSTOM_REPORTS

A JSON array describing the custom reports you want to sync from Google Search Console. See the docs for more information about the exact format you can use to fill out this field.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config custom_reports [value]

Airbyte Config End Date (airbyte_config.end_date)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_END_DATE

UTC date in the format 2017-01-25. Any data after this date will not be replicated. Must be greater or equal to the start date field.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config end_date [value]

Airbyte Config Site Urls (airbyte_config.site_urls)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_SITE_URLS

The URLs of the website property attached to your GSC account. Read more here.


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_config site_urls [value]

Airbyte Config Start Date (airbyte_config.start_date)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_CONFIG_START_DATE

UTC date in the format 2017-01-25. Any data before this date will not be replicated.


Configure this setting directly using the following Meltano command:

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

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-google-search-console

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_GOOGLE_SEARCH_CONSOLE_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-google-search-console set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (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]

Flattening Max 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]

Stream Map Config (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, read the Airbyte connector FAQ, look for an existing issue in the Airbyte 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 --variant airbyte

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-google-search-console
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocolmeltano_sdk