google-analytics-admin-api-basics

Google Analytics Admin API 入门

Google Analytics Admin API 提供对 Google Analytics 账号和媒体资源配置的程序化访问。它可让你自动执行账号管理、管理数据流、配置自定义维度以及处理产品集成。

通过 Cloud CLI 启用 API

在调用 API 之前，请确保已在 Google Cloud 项目中启用 Google Analytics Admin API。

如果找不到 gcloud，请先提示用户安装 Google Cloud CLI，再运行这些命令。

1. 启用 API： 使用 Cloud CLI（gcloud）启用 analyticsadmin.googleapis.com。

   gcloud services enable analyticsadmin.googleapis.com --quiet
   

   原因：启用 API 可确保你的 Cloud 项目已分配管理 Google Analytics 配置所需的配额和权限。

2. 验证 API 是否已启用：

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

身份验证

若要对 API 请求进行身份验证，你必须生成应用默认凭据（ADC），并为账号授予必要的范围。在终端中运行以下命令：

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

原因：此操作会在本地环境中配置 ADC，并设置所需的 Cloud Platform 和 Google Analytics 只读范围，使客户端库能够自动对请求进行身份验证。

说明

配置更改：更改 Google Analytics 账号/媒体资源配置的方法需要 https://www.googleapis.com/auth/analytics.edit 范围。

Admin API 使用场景

你可以使用 Google Analytics Admin API 来：

• 运行数据访问报告（更多信息请参阅 https://developers.google.com/analytics/devguides/config/admin/v1/access-api.md.txt）
• 创建账号摘要
• 管理账号
• 配置新账号
• 搜索账号更改历史事件
• 管理和创建媒体资源
• 管理媒体资源的数据保留设置
• 管理转化事件
• 管理自定义维度和指标
• 管理数据流并配置 Measurement Protocol 密钥
• 管理 Firebase 链接
• 管理 Google Ads 链接
• 管理关键事件

仅限 v1alpha 的使用场景

以下功能目前仅在 Admin API 的 v1alpha 版本中提供：

• 管理账号和媒体资源访问权限绑定
• 创建和管理汇总媒体资源
• 创建和管理子媒体资源
• 确认用户数据收集
• 更改媒体资源归因、数据保留、Google 信号、报告身份和用户提供的数据设置
• 管理 AdSense 链接
• 管理 BigQuery 链接
• 管理受众群体
• 管理渠道组
• 管理计算指标
• 管理 DisplayVideo360Advertiser 链接
• 管理扩展数据集
• 管理报告数据注释
• 管理 SearchAds360 链接
• 管理数据流的事件创建规则
• 管理 iOS 数据流的 SKAdNetwork 转化值架构
• 为 Google Analytics 媒体资源提交用户删除请求。

调用 Admin API

若要与 Admin API 交互，请使用官方 Google Analytics Admin 客户端库。请注意，v1beta 是最稳定的 Admin API 版本。若要使用最新功能，请考虑使用 v1alpha。

重要

Agent 强制指令： 当用户选择或要求使用特定编程语言时，请阅读下方 references/ 中列出的相应客户端库设置参考指南。

支持的客户端库

Python

如果需要安装或设置适用于 Python 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• Python 安装参考 （软件包： google-analytics-admin）

Java

如果需要安装或设置适用于 Java 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• Java 安装参考 （制品： com.google.cloud:google-cloud-analytics-admin）

PHP

如果需要安装或设置适用于 PHP 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• PHP 安装参考 （软件包： google/analytics-admin）

Node.js

如果需要安装或设置适用于 Node.js 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• Node.js 安装参考 （软件包： @google-analytics/admin）

Go

如果需要安装或设置适用于 Go 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• Go 安装参考 （软件包： cloud.google.com/go/analytics/admin/apiv1beta）

.NET

如果需要安装或设置适用于 .NET / C# 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• .NET 安装参考 （软件包： Google.Analytics.Admin.V1Beta）

Ruby

如果需要安装或设置适用于 Ruby 的 Google Analytics Admin API 客户端库，请阅读设置指南：

• Ruby 安装参考 （Gem： google-analytics-admin-v1alpha）

说明

其他资源：如需了解如何使用 Java、PHP、Node.js、.NET、Python 和 REST 调用 Admin API 的更多示例，以及有关使用服务账号进行身份验证的提示，请参阅官方的 Admin API 快速入门。 如需查看 v1alpha 和 v1beta 的完整 API 参考文档，请参阅 Admin API 参考。

Python 快速入门

1. 安装客户端库：

   pip install google-analytics-admin
   

   如果无法使用 pip，请提示用户先安装 pip，再安装客户端库。

2. **列出账号和媒体资源：**下面是一个完整示例，演示如何使用 list_account_summaries() 调用 Admin API，列出当前用户可用的所有账号及其子级媒体资源。

   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()