A simple Python script for calling GA4 API

README.md

Usage

1. Enable Google Analytics Data API
2. Create ga4api service account
3. Create key(credential) for the service account and save as JSON file
4. Assign ga4api@<project_id>.iam.gserviceaccount.com as GA4 viewer
5. Run ./main.sh <ga4_property_id>

References

• https://developers.google.com/analytics/devguides/migration/api/reporting-ua-to-ga4-dims-mets
• https://developers.google.com/analytics/devguides/reporting/data/v1/basics#group_and_filter_data

main.py

import sys
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
    DateRange,
    Dimension,
    Filter,
    FilterExpression,
    Metric,
    RunReportRequest,
)

def run_report(property_id="YOUR-GA4-PROPERTY-ID"):
    client = BetaAnalyticsDataClient()

    request = RunReportRequest(
        property=f"properties/{property_id}",
        dimensions=[Dimension(name="itemCategory"), Dimension(name="transactionId")],
        metrics=[Metric(name="itemPurchaseQuantity"), Metric(name="itemRevenue")],
        date_ranges=[DateRange(start_date="2024-01-01", end_date="today")],
        dimension_filter=FilterExpression(
            filter=Filter(
                field_name="transactionId",
                string_filter=Filter.StringFilter(match_type="CONTAINS",value="GA4_"),
            )
        ),
    )
    response = client.run_report(request)

    print("Report result:")
    for row in response.rows:
        print(row.dimension_values[0].value, row.dimension_values[1].value, row.metric_values[0].value, row.metric_values[1].value)

def main(argv):
    run_report(argv[1])

if __name__ == "__main__":
    main(sys.argv)

main.sh

#!/usr/bin/env bash

python3 -m venv ga4api
source ga4api/bin/activate
pip install google-analytics-data

# make sure your service account credential is ready
GOOGLE_APPLICATION_CREDENTIALS="$(pwd)/credentials.json" python main.py $1