The tap-google-sheets extractor pulls data from Google Sheets that can then be sent to a destination using a loader.
Alternate Implementations
- Airbyte
🥈
- Bytecode IO
- David Caribou🥈
- Matatika (default)
- Stitch Data🥈
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 singer-iomeltano config tap-google-sheets set --interactivemeltano config tap-google-sheets testNext 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:
- catalog
- discover
- state
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:
You can also list these settings using
with the meltano configlist
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 (client_id)
-
Environment variable:
TAP_GOOGLE_SHEETS_CLIENT_ID
This is the ID setup via the Google Cloud API.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_GOOGLE_SHEETS_CLIENT_SECRET
This is generated when the client ID is created via the Google Cloud API.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set client_secret [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_GOOGLE_SHEETS_REFRESH_TOKEN
This is the token used to generate new access_tokens. It is manually generated by making an API call to the Google Cloud API. See the documentation for more information.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set refresh_token [value]Spreadsheet ID (spreadsheet_id)
-
Environment variable:
TAP_GOOGLE_SHEETS_SPREADSHEET_ID
The unique identifier for a spreadsheet.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set spreadsheet_id [value]Start Date (start_date)
-
Environment variable:
TAP_GOOGLE_SHEETS_START_DATE
The absolute minimum start date to check if a file was modified.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_GOOGLE_SHEETS_USER_AGENT -
Default Value:
tap-google-sheets via Meltano
Used to identify the tap in the Google Remote API logs.
Configure this setting directly using the following Meltano command:
meltano config tap-google-sheets set user_agent [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-brightgreen){kind=icon}
-64,447-c0c0c4){kind=icon}
-12-c0c0c4){kind=icon}
