Google Analytics Admin API Client Library

Warnings

• breaking Breaking changes occur frequently in pre-1.0 versions. For example, version 0.2.0 introduced several changes including making `update_mask` required for update operations, renaming fields like `country_code` to `region_code` in the `Account` resource, and renaming `url_query_parameter` to `uri_query_parameter` in `EnhancedMeasurementSettings`.
  Fix: Refer to the changelog for each minor version update, especially before upgrading, and test code thoroughly. Always specify the API version in imports (e.g., `v1beta`).
• gotcha The Google Analytics Admin API is designed specifically for Google Analytics 4 (GA4) properties. It is not compatible with Universal Analytics (GA3) properties. Users migrating from GA3 will need to understand the GA4 data model and API structure.
  Fix: Ensure you are targeting GA4 properties when using this API. Familiarize yourself with GA4 concepts and resource types.
• gotcha Resource names often follow specific formats (e.g., `accounts/{account_id}`, `properties/{property_id}`). Incorrectly formatted resource names will result in API errors.
  Fix: Always construct resource names using the helper methods provided by the client library or adhere strictly to the format documented for each API method.
• deprecated Support for Python 2 has been dropped for new client library versions as of January 1, 2020. This library requires Python 3.7 or newer.
  Fix: Upgrade your Python environment to version 3.7 or higher.
• breaking A breaking change was introduced that updated the enum value for `KEY_EVENT` from 32 to 30 within the `ChangeHistoryResourceType`. This could affect code that relies on specific enum integer values.
  Fix: Avoid hardcoding enum integer values; instead, use the symbolic names (e.g., `ChangeHistoryResourceType.KEY_EVENT`) from the library to ensure forward compatibility.

Install

• pip install google-analytics-admin Install stable version

Imports

• AnalyticsAdminServiceClient

  from google.analytics.admin_v1beta import AnalyticsAdminServiceClient

  Always specify the API version (e.g., `_v1beta` or `_v1alpha`) in the import path. The higher-level `google.analytics.admin` module typically exists but might not contain the concrete client or expose the correct version by default. `v1beta` is generally recommended for stable features.
• AnalyticsAdminServiceAsyncClient

  from google.analytics.admin_v1beta import AnalyticsAdminServiceAsyncClient

  For asynchronous operations, import the `AsyncClient`.

Quickstart

This quickstart demonstrates how to instantiate the `AnalyticsAdminServiceClient` and list all accessible Google Analytics account summaries. Authentication is typically handled automatically if the `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the path of a service account key file. Ensure the service account has appropriate permissions (e.g., 'Google Analytics Administrator').

import os
from google.analytics.admin_v1beta import AnalyticsAdminServiceClient

# Ensure GOOGLE_APPLICATION_CREDENTIALS environment variable is set
# or pass credentials explicitly.
# Example: os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = '/path/to/your/key.json'

def list_account_summaries():
    """Lists all accessible account summaries for the authenticated user."""
    try:
        client = AnalyticsAdminServiceClient()
        print("Listing account summaries:")
        for account_summary in client.list_account_summaries():
            print(f"  Account: {account_summary.display_name} ({account_summary.account})")
            for property_summary in account_summary.property_summaries:
                print(f"    Property: {property_summary.display_name} ({property_summary.property}) - Type: {property_summary.property_type}")
    except Exception as e:
        print(f"An error occurred: {e}")
        print("Please ensure you have set up authentication (e.g., GOOGLE_APPLICATION_CREDENTIALS) and enabled the Analytics Admin API.")

if __name__ == '__main__':
    list_account_summaries()