Google Sheets
Table of Contents
The tap-google-sheets
Meltano extractor pulls data from Google Sheets that can then be sent to a destination using a loader.
Alternative variants #
Multiple
variants
of tap-google-sheets
are available.
This document describes the default singer-io
variant,
which is recommended for new users.
Alternative variants are:
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 usingmeltano add
:meltano add extractor tap-google-sheets
-
Configure the settings below using
meltano config
.
Next steps #
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
Capabilities #
Settings #
tap-google-sheets
requires the
configuration
of the following settings:
The settings for extractor tap-google-sheets
that are known to Meltano are documented below.
To quickly find the
setting you're looking for, use the Table of Contents at
the top of the page.
Client ID (client_id
)
#
-
Environment variable:
TAP_GOOGLE_SHEETS_CLIENT_ID
This is the ID setup via the Google Cloud API.
See https://drive.google.com/open?id=1FojlvtLwS0-BzGS37R0jEXtwSHqSiO1Uw-7RKQQO-C4.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set client_id <client_id>
export TAP_GOOGLE_SHEETS_CLIENT_ID=<client_id>
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.
See https://drive.google.com/open?id=1FojlvtLwS0-BzGS37R0jEXtwSHqSiO1Uw-7RKQQO-C4.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set client_secret <client_secret>
export TAP_GOOGLE_SHEETS_CLIENT_SECRET=<client_secret>
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.
See https://drive.google.com/open?id=1FojlvtLwS0-BzGS37R0jEXtwSHqSiO1Uw-7RKQQO-C4.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set refresh_token <refresh_token>
export TAP_GOOGLE_SHEETS_REFRESH_TOKEN=<refresh_token>
Spreadsheet ID (spreadsheet_id
)
#
-
Environment variable:
TAP_GOOGLE_SHEETS_SPREADSHEET_ID
The unique identifier for a spreadsheet.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set spreadsheet_id <spreadsheet_id>
export TAP_GOOGLE_SHEETS_SPREADSHEET_ID=<spreadsheet_id>
Start Date (start_date
)
#
-
Environment variable:
TAP_GOOGLE_SHEETS_START_DATE
The absolute minimum start date to check if a file was modified.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_GOOGLE_SHEETS_START_DATE=YYYY-MM-DDTHH:MM:SSZ
User Agent (user_agent
)
#
-
Environment variable:
TAP_GOOGLE_SHEETS_USER_AGENT
- Default:
tap-google-sheets via Meltano
Used to identify the tap in the Google Remote API logs.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-google-sheets set user_agent <user_agent>
export TAP_GOOGLE_SHEETS_USER_AGENT=<user_agent>
Looking for help? #
If you're having trouble getting the
tap-google-sheets
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.
Found an issue on this page? #
This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!