The tap-google-sheets extractor pulls data from Google Sheets that can then be sent to a destination using a loader.
Available Variants
- airbyte
- bytecodeio
- dcaribou
- matatika
- singer-io (default)
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-google-sheets extractor to your project
using
:meltano add
-
Configure the tap-google-sheets settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-google-sheets --variant matatika
meltano config tap-google-sheets set --interactive
meltano config tap-google-sheets 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-sheets
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
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-google-sheets
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:
oauth_credentials.client_id
oauth_credentials.client_secret
oauth_credentials.refresh_token
sheet_id
stream_name
child_sheet_name
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-google-sheets 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.
Client ID (oauth_credentials.client_id)
-
Environment variable:
TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_CLIENT_ID
Google OAuth Client ID
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set oauth_credentials client_id [value]
Client Secret (oauth_credentials.client_secret)
-
Environment variable:
TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_CLIENT_SECRET
Google OAuth Client Secret
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set oauth_credentials client_secret [value]
Refresh Token (oauth_credentials.refresh_token)
-
Environment variable:
TAP_GOOGLE_SHEETS_OAUTH_CREDENTIALS_REFRESH_TOKEN
Google OAuth Refresh Token
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set oauth_credentials refresh_token [value]
Sheet ID (sheet_id)
-
Environment variable:
TAP_GOOGLE_SHEETS_SHEET_ID
Google Sheet ID
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set sheet_id [value]
Stream Name (stream_name)
-
Environment variable:
TAP_GOOGLE_SHEETS_STREAM_NAME
Optionally change the name of the output file or table. By default that tap will use the file name of your Google Sheet.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set stream_name [value]
Child Sheet Name (child_sheet_name)
-
Environment variable:
TAP_GOOGLE_SHEETS_CHILD_SHEET_NAME
Optionally pick a different sheet within your Google Sheet to sync data from. By default the tap will sync data from the first visible sheet in your Google Sheet.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set child_sheet_name [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.