The tap-ga4 extractor pulls data from Google Analytics (GA4) that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-ga4 extractor to your
project using
:meltano add -
Configure the tap-ga4
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-ga4 --variant singer-iomeltano config tap-ga4 set --interactivemeltano config tap-ga4 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-ga4
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-ga4 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-ga4 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.
Account ID (account_id)
-
Environment variable:
TAP_GA4_ACCOUNT_ID
Google Analytics Account ID
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set account_id [value]OAuth Client ID (oauth_client_id)
-
Environment variable:
TAP_GA4_OAUTH_CLIENT_ID
Google Analytics Client ID
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set oauth_client_id [value]OAuth Client Secret (oauth_client_secret)
-
Environment variable:
TAP_GA4_OAUTH_CLIENT_SECRET
Google Analytics Client Secret
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set oauth_client_secret [value]Property ID (property_id)
-
Environment variable:
TAP_GA4_PROPERTY_ID
The GA4 property ID to sync data from.
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set property_id [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_GA4_REFRESH_TOKEN
Google Analytics Refresh Token
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set refresh_token [value]Report Definitions (report_definitions)
-
Environment variable:
TAP_GA4_REPORT_DEFINITIONS
Google Analytics Reports Definition
Configure this setting directly using the following Meltano command:
meltano config tap-ga4 set report_definitions [value]Start Date (start_date)
-
Environment variable:
TAP_GA4_START_DATE
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-ga4 set start_date [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}
