Google Directory

tap-google-directory (airbyte variant)🥉

Google Directory

The tap-google-directory extractor pulls data from Google Directory 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.

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-directory extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-google-directory
  3. Configure the tap-google-directory settings using
    meltano config
    :
  4. meltano config tap-google-directory set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-google-directory test

Next steps

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

Capabilities

The current capabilities for tap-google-directory 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:

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

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

Settings

The tap-google-directory 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-directory 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 Spec Image (airbyte_spec.image)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-google-directory

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_GOOGLE_DIRECTORY_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-directory set docker_mounts [value]

Airbyte Config Credentials Credentials Title (airbyte_config.credentials.credentials_title)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_CREDENTIALS_TITLE

Web server app, Service accounts


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_config credentials.credentials_title [value]

Airbyte Config Credentials Client Id (airbyte_config.credentials.client_id)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_ID

The Client ID of the developer application.


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_config credentials.client_id [value]

Airbyte Config Credentials Client Secret (airbyte_config.credentials.client_secret)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_SECRET

The Client Secret of the developer application.


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_config credentials.client_secret [value]

Airbyte Config Credentials Refresh Token (airbyte_config.credentials.refresh_token)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_REFRESH_TOKEN

The Token for obtaining a new access token.


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_config credentials.refresh_token [value]

Airbyte Config Credentials Credentials Json (airbyte_config.credentials.credentials_json)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_CREDENTIALS_JSON

The contents of the JSON service account key. See the docs for more information on how to generate this key.


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set airbyte_config credentials.credentials_json [value]

Airbyte Config Credentials Email (airbyte_config.credentials.email)

  • Environment variable: TAP_GOOGLE_DIRECTORY_AIRBYTE_CONFIG_CREDENTIALS_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-directory set airbyte_config credentials.email [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_GOOGLE_DIRECTORY_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-directory set stream_maps [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_GOOGLE_DIRECTORY_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-directory set stream_map_config [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_GOOGLE_DIRECTORY_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-directory set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_GOOGLE_DIRECTORY_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-google-directory set flattening_max_depth [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-directory 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-directory

Maintenance Status

  • Maintenance Status
  • Based on an Airbyte Connector

Repo

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

Maintainer

  • Airbyte

Keywords

  • airbyte_protocol