tap-ga4 - Meltano Hub

Google Analytics (GA4)

tap-ga4 (meltanolabs variant)🥇

App and website analytics platform hosted by Google (GA4)

The tap-ga4 extractor pulls data from Google Analytics (GA4) that can then be sent to a destination using a loader.

Alternate Implementations

Meltano (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-ga4 extractor to your project using
```
meltano add
```
:

meltano add extractor tap-ga4

Configure the tap-ga4 settings using

meltano config

meltano config tap-ga4 set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-ga4 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-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:

about
catalog
discover
schema-flattening
state
stream-maps

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:

client_secrets
end_date
key_file_location
oauth_credentials.access_token
oauth_credentials.client_id
oauth_credentials.client_secret
oauth_credentials.refresh_token
property_id
reports
start_date

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list 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.

Client Secrets (client_secrets)

Environment variable: TAP_GA4_CLIENT_SECRETS

Google Analytics Client Secrets Dictionary

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set client_secrets [value]

End Date (end_date)

Environment variable: TAP_GA4_END_DATE

The last record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set end_date [value]

Key File Location (key_file_location)

Environment variable: TAP_GA4_KEY_FILE_LOCATION

File Path to Google Analytics Client Secrets

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set key_file_location [value]

OAuth Credentials Access Token (oauth_credentials.access_token)

Environment variable: TAP_GA4_OAUTH_CREDENTIALS_ACCESS_TOKEN

Google Analytics Access Token

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set oauth_credentials access_token [value]

OAuth Credentials Client ID (oauth_credentials.client_id)

Environment variable: TAP_GA4_OAUTH_CREDENTIALS_CLIENT_ID

Google Analytics Client ID

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set oauth_credentials client_id [value]

OAuth Credentials Client Secret (oauth_credentials.client_secret)

Environment variable: TAP_GA4_OAUTH_CREDENTIALS_CLIENT_SECRET

Google Analytics Client Secret

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set oauth_credentials client_secret [value]

OAuth Credentials Refresh Token (oauth_credentials.refresh_token)

Environment variable: TAP_GA4_OAUTH_CREDENTIALS_REFRESH_TOKEN

Google Analytics Refresh Token

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set oauth_credentials refresh_token [value]

Property ID (property_id)

Environment variable: TAP_GA4_PROPERTY_ID

Google Analytics Property ID

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set property_id [value]

Reports (reports)

Environment variable: TAP_GA4_REPORTS

Google Analytics Reports Definition. The tap uses the default reports definition if this field is not provided. A project-relative path to JSON file with the definition of the reports to be generated.

See https://ga-dev-tools.google/ga4/dimensions-metrics-explorer/ for valid dimensions and metrics.

The JSON structure expected is as follows:

[
  { "name" : "name of stream to be used",
    "dimensions" :
    [
      "Google Analytics Dimension",
      "Another Google Analytics Dimension",
      // ... up to 7 dimensions per stream ...
    ],
    "metrics" :
    [
      "Google Analytics Metric",
      "Another Google Analytics Metric",
      // ... up to 10 metrics per stream ...
    ]
  },
  // ... as many streams / reports as the user wants ...
]

For example, if you want to extract user stats per day in a users_per_day stream and session stats per day and country in a sessions_per_country_day stream:

[
  { "name" : "users_per_day",
    "dimensions" :
    [
      "date"
    ],
    "metrics" :
    [
      "newUsers",
      "active1DayUsers"
    ]
  },
  { "name" : "sessions_per_country_day",
    "dimensions" :
    [
      "date",
      "country"
    ],
    "metrics" :
    [
      "sessions",
      "sessionsPerUser",
      "avgSessionDuration"
    ]
  }
]

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set reports [value]

Start Date (start_date)

Environment variable: TAP_GA4_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set start_date [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_GA4_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_GA4_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_GA4_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_GA4_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-ga4 set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-ga4 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.

Install

meltano add extractor tap-ga4

Maintenance Status

Repo

https://github.com/MeltanoLabs/tap-google-analytics

Maintainer

Meltano Stats

Keywords