The tap-google-analytics extractor pulls data from Google Analytics (Universal Analytics API - Deprecated) that can then be sent to a destination using a loader.
Alternate Implementations
-
Meltano
(default)
🥇
-
Saïd Tezel
🥈
-
Wise
🥉
-
Andrea Mostosi
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-google-analytics extractor to your
project using
:meltano add -
Configure the tap-google-analytics
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-google-analytics --variant meltanomeltano config tap-google-analytics set --interactivemeltano config tap-google-analytics 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-analytics
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
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-google-analytics 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:
end_datekey_file_locationoauth_credentials.access_tokenoauth_credentials.client_idoauth_credentials.client_secretoauth_credentials.refresh_tokenreportsstart_dateview_id
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-google-analytics 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.
(end_date)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_END_DATE
Date up to when historical data will be extracted.
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set end_date [value]Client Secrets (key_file_location)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_KEY_FILE_LOCATION -
Default Value:
$MELTANO_PROJECT_ROOT/client_secrets.json
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set key_file_location [value]OAuth Access Token (oauth_credentials.access_token)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_OAUTH_CREDENTIALS_ACCESS_TOKEN
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set oauth_credentials access_token [value]OAuth Client ID (oauth_credentials.client_id)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_OAUTH_CREDENTIALS_CLIENT_ID
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set oauth_credentials client_id [value]OAuth Client Secret (oauth_credentials.client_secret)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_OAUTH_CREDENTIALS_CLIENT_SECRET
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set oauth_credentials client_secret [value]OAuth Refresh Token (oauth_credentials.refresh_token)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_OAUTH_CREDENTIALS_REFRESH_TOKEN
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set oauth_credentials refresh_token [value]Reports (reports)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_REPORTS
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set reports [value] (start_date)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_START_DATE
This property determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set start_date [value]View ID (view_id)
-
Environment variable:
TAP_GOOGLE_ANALYTICS_VIEW_ID
Configure this setting directly using the following Meltano command:
meltano config tap-google-analytics set view_id [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
