/google-analytics-admin-api-basics

name: google-analytics-admin-api-basics
metadata:
  version: "1.0.0"
  category: GoogleAnalytics
description: >-
  Manages Google Analytics account and property settings, enables the Analytics Admin API via the Cloud CLI, lists accounts and properties, and manages data streams, custom dimensions, conversion events, and integrations. Use when you need to programmatically configure Google Analytics accounts, provision properties, manage data retention, configure Measurement Protocol secrets, or manage Firebase and Google Ads links.

Getting Started with Google Analytics Admin API

The Google Analytics Admin API provides programmatic access to Google Analytics account and property configuration. It lets you automate account management, manage data streams, configure custom dimensions, and handle product integrations.

Enabling the API via Cloud CLI

Before making API calls, ensure the Google Analytics Admin API is enabled in your Google Cloud project.

If `gcloud` is not found, prompt the user to install the Google Cloud CLI before running these commands.

1. **Enable the API:** Use the Cloud CLI (`gcloud`) to enable `analyticsadmin.googleapis.com`.

    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:**

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

Authentication

To authenticate your API requests, you must generate Application Default Credentials (ADC) and give your account the necessary scopes. Run the following command in your terminal:

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

*Why: This configures ADC in your local environment with the required Cloud Platform and Google Analytics read-only scopes, allowing the client library to automatically authenticate your requests.*

> [!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

You can use the Google Analytics Admin API to:

• 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

The following capabilities are currently available only in the `v1alpha` version of the Admin API:

• 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

To interact with the Admin API, use the official Google Analytics Admin client library. Note that `v1beta` is the most stable version of the Admin API. For the latest features, consider using `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

If you need to install or set up the Google Analytics Admin API client library for Python, read the setup guide:

• [Python Installation Reference](references/python.md) *(Package:

`google-analytics-admin`)*

Java

If you need to install or set up the Google Analytics Admin API client library for Java, read the setup guide:

• [Java Installation Reference](references/java.md) *(Artifact:

`com.google.cloud:google-cloud-analytics-admin`)*

PHP

If you need to install or set up the Google Analytics Admin API client library for PHP, read the setup guide:

• [PHP Installation Reference](references/php.md) *(Package:

`google/analytics-admin`)*

Node.js

If you need to install or set up the Google Analytics Admin API client library for Node.js, read the setup guide:

• [Node.js Installation Reference](references/nodejs.md) *(Package:

`@google-analytics/admin`)*

Go

If you need to install or set up the Google Analytics Admin API client library for Go, read the setup guide:

• [Go Installation Reference](references/go.md) *(Package:

`cloud.google.com/go/analytics/admin/apiv1beta`)*

.NET

If you need to install or set up the Google Analytics Admin API client library for .NET / C#, read the setup guide:

• [.NET Installation Reference](references/dotnet.md) *(Package:

`Google.Analytics.Admin.V1Beta`)*

Ruby

If you need to install or set up the Google Analytics Admin API client library for Ruby, read the setup guide:

• [Ruby Installation Reference](references/ruby.md) *(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 we