mirror of synced 2025-12-30 12:04:43 -05:00

Files

simonbutt-datatonic af4b0d7244 Update google-analytics-data-api.md (#28081 )

Updating the "Full Refresh - Overwrite" link in `google-analytics-data-api.md` as currently it sends to a page not found link (https://docs.airbyte.com/understanding-airbyte/glossary#full-refresh-sync).

2023-07-11 15:01:41 -05:00

11 KiB

Raw Blame History

Google Analytics 4 (GA4)

This page contains the setup guide and reference information for the Google Analytics 4 source connector.

:::note

Google Analytics Universal Analytics (UA) connector, uses the older version of Google Analytics, which has been the standard for tracking website and app user behavior since 2012.

Google Analytics 4 (GA4) connector is the latest version of Google Analytics, which was introduced in 2020. It offers a new data model that emphasizes events and user properties, rather than pageviews and sessions. This new model allows for more flexible and customizable reporting, as well as more accurate measurement of user behavior across devices and platforms.

:::

Prerequisites

JSON credentials for the service account that has access to Google Analytics. For more details check instructions
OAuth 2.0 credentials for the service account that has access to Google Analytics
Property ID

Step 1: Set up Source

Create a Service Account

First, you need to select existing or create a new project in the Google Developers Console:

Sign in to the Google Account you are using for Google Analytics as an admin.
Go to the Service Accounts page.
Click Create service account.
Create a JSON key file for the service user. The contents of this file will be provided as the credentials_json in the UI when authorizing GA after you grant permissions (see below).

Add service account to the Google Analytics account

Use the service account email address to add a user to the Google analytics view you want to access via the API. You will need to grant Viewer permissions.

Enable the APIs

Go to the Google Analytics Reporting API dashboard in the project for your service user. Enable the API for your account. You can set quotas and check usage.
Go to the Google Analytics API dashboard in the project for your service user. Enable the API for your account.

Step 2: Set up the Google Analytics connector in Airbyte

For Airbyte Cloud:

Login to your Airbyte Cloud account.
In the left navigation bar, click Sources. In the top-right corner, click + new source.
On the source setup page, select Google Analytics 4 (GA4) from the Source type dropdown and enter a name for this connector.
Click Authenticate your account by selecting Oauth or Service Account for Authentication.
Log in and Authorize the Google Analytics account.
Enter the Property ID whose events are tracked.
Enter the Start Date from which to replicate report data in the format YYYY-MM-DD. (Not applied to custom Cohort reports).
Enter the Custom Reports (Optional) a JSON array describing the custom reports you want to sync from Google Analytics.
Enter the Data request time increment in days (Optional). The bigger this value is, the faster the sync will be, but the more likely that sampling will be applied to your data, potentially causing inaccuracies in the returned results. We recommend setting this to 1 unless you have a hard requirement to make the sync faster at the expense of accuracy. The minimum allowed value for this field is 1, and the maximum is 364. (Not applied to custom Cohort reports).

For Airbyte Open Source:

Navigate to the Airbyte Open Source dashboard.
In the left navigation bar, click Sources. In the top-right corner, click + new source.
On the source setup page, select Google Analytics 4 (GA4) from the Source type dropdown and enter a name for this connector.
Select Service Account for Authentication in dropdown list and enter Service Account JSON Key from Step 1.
Enter the Property ID whose events are tracked.
Enter the Start Date from which to replicate report data in the format YYYY-MM-DD. (Not applied to custom Cohort reports).
Enter the Custom Reports (Optional) a JSON array describing the custom reports you want to sync from Google Analytics.
Enter the Data request time increment in days (Optional). The bigger this value is, the faster the sync will be, but the more likely that sampling will be applied to your data, potentially causing inaccuracies in the returned results. We recommend setting this to 1 unless you have a hard requirement to make the sync faster at the expense of accuracy. The minimum allowed value for this field is 1, and the maximum is 364. (Not applied to custom Cohort reports).

Supported sync modes

The Google Analytics source connector supports the following sync modes:

Supported Streams

This connector outputs the following incremental streams:

Preconfigured streams:
Custom stream(s)

Connector-specific features