Google Analytics（分析）Admin API 概览

摘要：本文档简要介绍了 Google Analytics（分析）Admin API 1.0 版。

警告 ：这是该 API 的早期预览版，随时可能会发生变化。虽然我们会尽量通知您即将发生的变更，但您应该能在 API 公开发布之前发生重大变更。

该 API 的 Alpha 和 Beta 渠道仍受支持。Beta 渠道包含 Alpha 版中提供的部分功能，这些功能被视为稳定，预计未来不会发生重大变化。新功能在成熟后会添加到 Beta 版中。

如需了解 Google Analytics（分析）API 的官方公告，请订阅 Google Analytics（分析）API 通知小组。 如需报告 API 问题，请使用 Google Analytics（分析）API 测试人员反馈表单。

简介

Google Analytics Admin API 支持以编程方式访问 Google Analytics（分析）4 (GA4) 配置数据，并且仅与 GA4 媒体资源兼容。详细了解 GA4 媒体资源。

您可以使用 Google Analytics（分析）Admin API 执行以下操作：

• 配置新帐号。
• 管理帐号。
• 管理数据共享设置。
• 列出帐号摘要。
• 搜索更改历史记录事件。
• 管理媒体资源。
• 确认用户数据收集。
• 管理媒体资源的数据保留设置。
• 为媒体资源管理 Google 信号设置（Alpha 版）。
• 管理直播。
• 管理 Measurement Protocol 密钥。
• 管理 SKAdNetwork 转化价值架构（Alpha 版）。
• 为网站数据流生成 Google 代码段（Alpha 版）。
• 管理转化事件。
• 管理自定义维度。
• 管理自定义指标。
• 管理 GA4 媒体资源与 Firebase 项目之间的关联。
• 管理 GA4 媒体资源与 Google Ads 帐号之间的关联。
• 管理针对 GA4 媒体资源与 Display & Video 360 广告客户（Alpha 版）之间的关联的提案。
• 管理 GA4 媒体资源与 Display & Video 360 广告客户（Alpha 版）之间的关联。
• 管理 GA4 媒体资源与 Search Ads 360（Alpha 版）之间的关联。
• 管理 GA4 媒体资源与 BigQuery 项目（Alpha 版）之间的关联。
• 管理帐号层次结构和 GA4 媒体资源（Alpha 版）的用户权限。
• 生成数据访问报告（Alpha 版）。
• 管理受众群体（Alpha 版）。
• 管理展开式数据集（Alpha 版）。
• 管理 GA4 设置流程的自动停用设置（Alpha 版）。

可用的方法

帐号配置

• accounts.provisionAccountTicket

  此方法会返回服务条款 (TOS) 网址中应包含的 accountTicketId 字段：https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID。 一旦用户访问 TOS 网址并接受服务条款，Google Analytics（分析）帐号的创建即告完成（帐号配置示例）。

帐号管理

• accounts.delete
• accounts.get
• accounts.list
• accounts.patch

数据共享设置管理

• accounts.getDataSharingSettings

列出账号摘要

• accountSummaries.list

搜索更改历史记录事件

• accounts.searchChangeHistoryEvents

媒体资源管理

• properties.get
• properties.patch
• properties.delete
• properties.list
• properties.create

用户数据收集确认

• properties.acknowledgeUserDataCollection

数据保留设置管理

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

Google 信号设置管理（Alpha 版）

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

数据流管理

• properties.dataStreams.create
• properties.dataStreams.get
• properties.dataStreams.list
• properties.dataStreams.patch
• properties.dataStreams.delete

Measurement Protocol 密钥管理

• properties.dataStreams.measurementProtocolSecrets.create
• properties.dataStreams.measurementProtocolSecrets.get
• properties.dataStreams.measurementProtocolSecrets.patch
• properties.dataStreams.measurementProtocolSecrets.list
• properties.dataStreams.measurementProtocolSecrets.delete

SKAdNetwork 转化价值架构管理（Alpha 版）

• properties.dataStreams.sKAdNetworkConversionValueSchema.get
• properties.dataStreams.sKAdNetworkConversionValueSchema.create
• properties.dataStreams.sKAdNetworkConversionValueSchema.delete
• properties.dataStreams.sKAdNetworkConversionValueSchema.update
• properties.dataStreams.sKAdNetworkConversionValueSchema.list

转化事件管理

• properties.conversionEvents.create
• properties.conversionEvents.get
• properties.conversionEvents.list
• properties.conversionEvents.delete
• properties.conversionEvents.update

自定义维度管理

• properties.customDimensions.create
• properties.customDimensions.get
• properties.customDimensions.list
• properties.customDimensions.patch
• properties.customDimensions.archive

自定义指标管理

• properties.customMetrics.create
• properties.customMetrics.get
• properties.customMetrics.list
• properties.customMetrics.patch
• properties.customMetrics.archive

Firebase 项目关联

• properties.firebaseLinks.create
• properties.firebaseLinks.list
• properties.firebaseLinks.delete

Google Ads 账号关联

• properties.googleAdsLinks.create
• properties.googleAdsLinks.list
• properties.googleAdsLinks.patch
• properties.googleAdsLinks.delete

Google 代码生成（Alpha 版）

• properties.webDataStreams.getGlobalSiteTag

关于将 GA4 媒体资源与 Display & Video 360 广告客户之间的关联提案（Alpha 版）

• properties.displayVideo360AdvertiserLinkProposals.create
• properties.displayVideo360AdvertiserLinkProposals.approve
• properties.displayVideo360AdvertiserLinkProposals.cancel
• properties.displayVideo360AdvertiserLinkProposals.list
• properties.displayVideo360AdvertiserLinkProposals.get
• properties.displayVideo360AdvertiserLinkProposals.delete

Display & Video 360 广告客户帐号关联（Alpha 版）

• properties.displayVideo360AdvertiserLinks.create
• properties.displayVideo360AdvertiserLinks.get
• properties.displayVideo360AdvertiserLinks.list
• properties.displayVideo360AdvertiserLinks.delete
• properties.displayVideo360AdvertiserLinks.patch

Search Ads 360 帐号关联（Alpha 版）

• properties.searchAds360Links.create
• properties.searchAds360Links.delete
• properties.searchAds360Links.patch
• properties.searchAds360Links.list
• properties.searchAds360Links.get

不妨详细了解如何为 GA4 媒体资源设置 Google Analytics（分析）与 Search Ads 360 的集成。

BigQuery 帐号关联（Alpha 版）

• properties.bigQueryLinks.get
• properties.bigQueryLinks.list

详细了解如何为 GA4 媒体资源设置 BigQuery Export。

用户权限管理（Alpha 版）

• accounts.accessBindings.create
• accounts.accessBindings.delete
• accounts.accessBindings.patch
• accounts.accessBindings.list
• accounts.accessBindings.get
• accounts.accessBindings.batchCreate
• accounts.accessBindings.batchDelete
• accounts.accessBindings.batchUpdate
• accounts.accessBindings.batchGet
• properties.accessBindings.create
• properties.accessBindings.delete
• properties.accessBindings.patch
• properties.accessBindings.list
• properties.accessBindings.get
• properties.accessBindings.batchCreate
• properties.accessBindings.batchDelete
• properties.accessBindings.batchUpdate
• properties.accessBindings.batchGet

数据访问权限报告（Alpha 版）

• properties.runAccessReport

如需详细了解此功能，请参阅数据访问报告指南。

受众群体管理（Alpha 版）

• properties.audiences.create
• properties.audiences.archive
• properties.audiences.patch
• properties.audiences.list
• properties.audiences.get

详细了解 Google Analytics（分析）中的受众群体。

扩展的数据集管理（Alpha 版）

• properties.expandedDataSets.create
• properties.expandedDataSets.delete
• properties.expandedDataSets.patch
• properties.expandedDataSets.list
• properties.expandedDataSets.get

详细了解 Google Analytics 360 中展开式数据集。

自动选择停用 GA4 设置流程（Alpha 版）

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

详细了解如何管理 UA 媒体资源的 GA4 自动设置流程的停用状态。