Getting Started with Google Analytics Admin API

Enabling the API via Cloud CLI

gcloud

1. Enable the API: Use the Cloud CLI (

   gcloud

   ) to enable

   analyticsadmin.googleapis.com

   .
   bash

   gcloud services enable analyticsadmin.googleapis.com --quiet

   Why: Enabling the API ensures your Cloud project has the necessary quota and permissions allocated for managing Google Analytics configurations.
2. Verify API Enablement:
   bash

   gcloud services list --enabled --filter="analyticsadmin.googleapis.com"

Authentication

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

[!NOTE] Configuration Changes: Methods changing the Google Analytics account/property configuration will need the

https://www.googleapis.com/auth/analytics.edit

scope.

Admin API Use Cases

• Run Data Access reports (see https://developers.google.com/analytics/devguides/config/admin/v1/access-api.md.txt for more info)
• Create Account summaries
• Manage accounts
• Provision new accounts
• Search account change history events
• Manage and create properties
• Manage property data retention settings
• Manage conversion events
• Manage custom dimensions and metrics
• Manage data streams and configure measurement protocol secrets
• Manage Firebase links
• Manage Google Ads links
• Manage key events

v1alpha-Only Use Cases

v1alpha

• Manage account and property access bindings
• Create and manage rollup properties
• Create and manage subproperties
• Acknowledge user data collection
• Change property attribution, data retention, Google signals, reporting identity, and User Provided Data settings
• Manage AdSense links
• Manage BigQuery links
• Manage audiences
• Manage channel groups
• Manage calculated metrics
• Manage DisplayVideo360Advertiser links
• Manage expanded data sets
• Manage reporting data annotations
• Manage SearchAds360 links
• Manage event create rules for a data stream
• Manage SKAdNetwork conversion value schema of an iOS stream
• Submit a request for user deletion for a Google Analytics property.

Calling the Admin API

v1beta

v1alpha

[!IMPORTANT] Mandatory Agent Directive: When the user selects or requires a specific programming language, read the corresponding client library setup reference guide in

references/

listed below.

Supported Client Libraries

Python

• Python Installation Reference (Package:

  google-analytics-admin

  )

Java

• Java Installation Reference (Artifact:

  com.google.cloud:google-cloud-analytics-admin

  )

PHP

• PHP Installation Reference (Package:

  google/analytics-admin

  )

Node.js

• Node.js Installation Reference (Package:

  @google-analytics/admin

  )

Go

• Go Installation Reference (Package:

  cloud.google.com/go/analytics/admin/apiv1beta

  )

.NET

• .NET Installation Reference (Package:

  Google.Analytics.Admin.V1Beta

  )

Ruby

• Ruby Installation Reference (Gem:

  google-analytics-admin-v1alpha

  )

[!NOTE] Additional Resources: For further examples of calling the Admin API with Java, PHP, Node.js, .NET, Python, and REST, as well as hints on authentication with a service account, refer to the official Admin API Quickstart. For complete API reference documentation for both

v1alpha

and

v1beta

, see the Admin API Reference.

Python Quick Start

1. Install the Client Library:
   bash

   pip install google-analytics-admin

   If

   pip

   is not available, prompt the user to install

   pip

   before installing the client library.
2. List Accounts and Properties: Below is a complete example demonstrating how to call the Admin API to list all available accounts and their child properties for the current user using

   list_account_summaries()

   .
   python

   from google.analytics.admin import AnalyticsAdminServiceClient
   
   def sample_list_account_summaries():
       # Initialize the client.
       # Assumes Application Default Credentials (ADC) are configured in your environment.
       client = AnalyticsAdminServiceClient()
   
       # list_account_summaries returns a summary of all accounts accessible to the
       # user and their child properties.
       account_summaries = client.list_account_summaries()
   
       print("Available Google Analytics Accounts and Properties:")
       for summary in account_summaries:
           print(f"Account: {summary.display_name} ({summary.account})")
           for property_summary in summary.property_summaries:
               print(f"  Property: {property_summary.display_name} ({property_summary.property})")
   
   if __name__ == "__main__":
       sample_list_account_summaries()