Skip to main content

Ingest aggregated data from Google Analytics

Beta

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Google Analytics Aggregated from the Previews page. See Manage Databricks previews.

Create a managed Lakeflow Connect pipeline that ingests aggregated Google Analytics 4 (GA4) report data into Unity Catalog tables. Use the Databricks UI, Declarative Automation Bundles, or a Databricks notebook.

Requirements​

  • To create an ingestion pipeline, first meet the following requirements:

    • Your workspace must be enabled for Unity Catalog.

    • Serverless compute must be enabled for your workspace. See Serverless compute requirements.

    • To create a new connection, you must have CREATE CONNECTION privileges on the metastore. See Manage privileges in Unity Catalog.

      If the connector supports UI-based pipeline authoring, an admin can create the connection and the pipeline at the same time by completing the steps on this page. However, if the users who create pipelines use API-based pipeline authoring or are non-admin users, an admin must first create the connection in Catalog Explorer. See Connect to managed ingestion sources.

    • To use an existing connection, you must have USE CONNECTION privileges or ALL PRIVILEGES on the connection object.

    • You must have USE CATALOG privileges on the target catalog.

    • You must have USE SCHEMA and CREATE TABLE privileges on an existing schema or CREATE SCHEMA privileges on the target catalog.

  • To ingest from Google Analytics, first configure authentication from Databricks and create a connection. See Configure authentication to Google Analytics and Create a Google Analytics Aggregated connection.

Connector options​

For the options the Google Analytics Aggregated connector accepts, their scope, and the tables they apply to, see Connector options. Set pipeline-scoped options in source_configurations and table-scoped options on the individual object. See Examples for usage.

Create an ingestion pipeline​

For the list of supported source tables, see Supported source tables.

  1. In the sidebar of the Databricks workspace, click Data Ingestion.
  2. On the Add data page, under Databricks connectors, click Google Analytics Aggregated.
  3. On the Connection page of the ingestion wizard, select the connection that stores your Google Analytics credentials. If you have the CREATE CONNECTION privilege on the metastore, click Plus icon. Create connection to create a connection with the credentials from Configure authentication to Google Analytics.
  4. Click Next.
  5. On the Ingestion setup page, enter a name for the pipeline.
  6. Select a catalog and a schema to write event logs to. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  7. Optionally, set a Start date. If you don't set it, ingestion starts 60 days before the first sync. See Connector options.
  8. Click Create pipeline and continue.
  9. On the Source page, select the tables to ingest and set the table options:
    • For each prebuilt report table, enter the Property IDs of the GA4 properties to ingest. Optionally, set a Lookback window (days).
    • For custom_report, enter a Property ID, Dimensions, Metrics, and a Cursor dimension. Optionally, set a Lookback window (days). See Custom reports.
  10. Click Save and continue.
  11. On the Destination page, select a catalog and a schema to load data into. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  12. Click Save and continue.
  13. (Optional) On the Schedules and notifications page, click Plus icon. Create schedule. Set the frequency to refresh the destination tables.
  14. (Optional) Click Plus icon. Add notification to set email notifications for pipeline operation success or failure, then click Save and run pipeline.

Examples​

The Google Analytics Aggregated connector makes its source tables available in the default source schema. For the list of tables, see Supported source tables.

For schema details, see Destination table schemas.

Ingest a prebuilt report table​

The following example ingests the traffic_acquisition_session_source_medium_report table for two GA4 properties.

YAML
resources:
pipelines:
google_analytics_aggregated_pipeline:
name: google_analytics_aggregated_pipeline
catalog: 'main'
target: 'google_analytics_aggregated_data'
ingestion_definition:
connection_name: google_analytics_aggregated_connection
source_configurations:
- api_source_connector_config:
configs:
start_date: '<start-date>'
objects:
- table:
source_schema: 'default'
source_table: 'traffic_acquisition_session_source_medium_report'
destination_catalog: 'main'
destination_schema: 'google_analytics_aggregated_data'
destination_table: 'traffic_acquisition_session_source_medium_report'
connector_options:
api_source_connector_options:
options:
property_ids: '["<property-id-1>", "<property-id-2>"]'
lookback_window_in_days: '<lookback-days>'

Ingest a custom report​

The following example ingests a custom report that aggregates sessions and users by country and device category for each GA4 week. To ingest more than one custom report in the same pipeline, add a custom_report object for each report, each with a different destination_table. For the options, see Custom reports.

YAML
resources:
pipelines:
google_analytics_aggregated_pipeline:
name: google_analytics_aggregated_pipeline
catalog: 'main'
target: 'google_analytics_aggregated_data'
ingestion_definition:
connection_name: google_analytics_aggregated_connection
source_configurations:
- api_source_connector_config:
configs:
start_date: '<start-date>'
objects:
- table:
source_schema: 'default'
source_table: 'custom_report'
destination_catalog: 'main'
destination_schema: 'google_analytics_aggregated_data'
destination_table: 'weekly_sessions_by_country_and_device'
connector_options:
api_source_connector_options:
options:
property_id: '<property-id>'
dimensions: '["country", "deviceCategory"]'
metrics: '["sessions", "totalUsers"]'
cursor_dimension: 'yearWeek'

Ingest prebuilt and custom report tables together​

The following example combines a prebuilt report table and a monthly custom report in a single pipeline. Each object sets only the connector options that its table accepts.

YAML
resources:
pipelines:
google_analytics_aggregated_pipeline:
name: google_analytics_aggregated_pipeline
catalog: 'main'
target: 'google_analytics_aggregated_data'
ingestion_definition:
connection_name: google_analytics_aggregated_connection
source_configurations:
- api_source_connector_config:
configs:
start_date: '<start-date>'
objects:
- table:
source_schema: 'default'
source_table: 'website_overview'
destination_catalog: 'main'
destination_schema: 'google_analytics_aggregated_data'
destination_table: 'website_overview'
connector_options:
api_source_connector_options:
options:
property_ids: '["<property-id>"]'
- table:
source_schema: 'default'
source_table: 'custom_report'
destination_catalog: 'main'
destination_schema: 'google_analytics_aggregated_data'
destination_table: 'monthly_revenue_by_channel'
connector_options:
api_source_connector_options:
options:
property_id: '<property-id>'
dimensions: '["sessionDefaultChannelGroup"]'
metrics: '["totalRevenue", "transactions"]'
cursor_dimension: 'yearMonth'

Declarative Automation Bundles job definition file​

The following is an example job definition file for use with Declarative Automation Bundles. The job runs daily.

YAML
resources:
jobs:
google_analytics_aggregated_job:
name: google_analytics_aggregated_job
schedule:
quartz_cron_expression: '0 0 0 * * ?'
timezone_id: 'UTC'
tasks:
- task_key: google_analytics_aggregated_ingestion
pipeline_task:
pipeline_id: ${resources.pipelines.google_analytics_aggregated_pipeline.id}

Common patterns​

For advanced pipeline configurations, see Common patterns for managed ingestion pipelines.

Next steps​

Start, schedule, and set alerts on your pipeline. See Common pipeline maintenance tasks.

Additional resources​