更新日志

如需了解有关 Google Analytics API 的官方公告，请订阅 Google Analytics API Notify 群组。

2025 年 1 月 20 日 向 DataRetentionSettings 添加了用户数据保留设置

在 Admin API v1alpha 和 v1beta 的 DataRetentionSettings 中添加了 userDataRetention 字段。您可以使用此字段检索或修改用户数据的保留设置。

2024 年 9 月 9 日“访问报告”调查问卷

runAccessReport 方法的文档已更新，其中包含指向 Google Analytics 访问权限报告反馈表单的链接。我们非常重视您的意见，欢迎您分享对此 API 的想法，帮助我们进一步改进。

2024 年 8 月 1 日 添加了 BigQuery 关联管理

添加了 CreateBigQueryLink、UpdateBigQueryLink 和 DeleteBigQueryLink 方法，以便使用 Admin API v1alpha 管理 BigQueryLink 资源。

向 BigQueryLink 资源添加了 dataset_location 字段。

在 ChangeHistoryResourceType 的新 BIGQUERY_LINK 值下，向更改历史记录中添加了 BigQuery 关联更改。

2024 年 8 月 1 日 对 createSubproperty 方法进行了破坏性更改

在 Admin API v1alpha 中将 createSubproperty 自定义方法重命名为 provisionSubproperty，以符合自定义方法准则。

2024 年 8 月 1 日 添加了事件修改规则管理

向 Admin API v1alpha 添加了 GetEventEditRule、CreateEventEditRule、DeleteEventEditRule、ListEventEditRules、UpdateEventEditRules、ReorderEventEditRules 方法。

EventEditRule 用于定义触发条件，以便根据源事件的匹配条件创建全新事件。此外，EventEditRule 还可以定义对来源事件的参数进行的修改。

2024 年 8 月 1 日 其他变更

向 Audience 资源添加了 create_time。

向 ChannelGroup 资源添加了 primary，以指明渠道组是否为报告的默认渠道组。在任何给定时间，只有一个渠道组的 primary 可以设置为 true。将渠道组的 primary 设置为 true 会自动将之前的主渠道组的 primary 设置为 false。

向 Account 资源添加了 gmp_organization，其中包含 Google Marketing Platform 组织资源的 URI（如果账号已与 GMP 组织相关联）。

2024 年 5 月 6 日 添加了关键事件管理方法

重要事件的资源和方法现已推出。

修改您的 API 集成，以使用 KeyEvent 而非 ConversionEvent。ConversionEvent 已弃用。

2023 年 12 月 15 日 现在，所有 Google Analytics 媒体资源均可使用数据访问报告。

数据访问报告功能的某些字段现已面向所有 Google Analytics 媒体资源（标准版和 Google Analytics 360 版客户）提供。

如需了解详情，请参阅架构文档。

2023 年 12 月 15 日 向“数据访问权限”报告架构中添加了 accessDateHour 维度。

向“数据访问权限”报告架构添加了 accessDateHour 维度。其中包含访问 Google Analytics 报告数据的 Google Analytics 用户的日期时间。

2023 年 10 月 5 日：采用“首次点击”“线性”“时间衰减”和“根据位置”归因模型的媒体资源将默认采用跨渠道 DDA。

自 2023 年 10 月中旬起，对于所有媒体资源，首次点击、线性、时间衰减和根据位置归因模型将无法与 UpdateAttributionSettings 方法搭配使用。

如果您的媒体资源目前配置为使用其中某个模型，则会更改为以数据为依据的跨渠道归因。您仍然可以改用“跨渠道最终点击”或“首选 Google Ads 最终点击”归因模型。

2023 年 9 月 1 日 添加了 SKAdNetwork 转化价值架构配置方法。

向 Admin API v1alpha 添加了 GetSKAdNetworkConversionValueSchema、CreateSKAdNetworkConversionValueSchema、DeleteSKAdNetworkConversionValueSchema、UpdateSKAdNetworkConversionValueSchema、ListSKAdNetworkConversionValueSchemas 方法。

借助此功能，您可以管理 iOS 数据流的 SKAdNetwork 转化价值架构配置。

2023 年 9 月 1 日 添加了 UpdateConversionEvent 方法。

向 Admin API v1beta 中添加了 UpdateConversionEvent 方法。

2023 年 9 月 1 日 将 BigQueryLink.enterprise_export_enabled 字段重命名为 fresh_daily_export_enabled。

BigQueryLink 资源的 enterprise_export_enabled 字段已重命名为 fresh_daily_export_enabled。

2023 年 7 月 14 日对 properties.updateAttributionSettings、properties.getAttributionSettings 方法进行了重大更改。

自 2023 年 7 月 24 日起，我们将对 Admin API v1 alpha 版进行重大更改，这将影响 properties.getAttributionSettings、properties.updateAttributionSettings 方法的功能。

ReportingAttributionModel 枚举的成员将重命名如下：

原名称	新名称
CROSS_CHANNEL_DATA_DRIVEN	PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN
CROSS_CHANNEL_LAST_CLICK	PAID_AND_ORGANIC_CHANNELS_LAST_CLICK
CROSS_CHANNEL_FIRST_CLICK	PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK
CROSS_CHANNEL_LINEAR	PAID_AND_ORGANIC_CHANNELS_LINEAR
CROSS_CHANNEL_POSITION_BASED	PAID_AND_ORGANIC_CHANNELS_POSITION_BASED
CROSS_CHANNEL_TIME_DECAY	PAID_AND_ORGANIC_CHANNELS_TIME_DECAY
ADS_PREFERRED_LAST_CLICK	GOOGLE_PAID_CHANNELS_LAST_CLICK

AdsWebConversionDataExportScope 枚举的成员将重命名如下：

原名称	新名称
CROSS_CHANNEL	PAID_AND_ORGANIC_CHANNELS
ADS_PREFERRED	GOOGLE_PAID_CHANNELS

2023 年 7 月 10 日 向 AttributionSettings 类型添加了 ads_web_conversion_data_export_scope 字段

向 AttributionSettings 类型添加了 ads_web_conversion_data_export_scope 字段，该字段可使用 UpdateAttributionSettings 方法进行修改。

2023 年 6 月 5 日 弃用“首次点击”“线性”“时间衰减”和“根据位置”归因模型。

自 2023 年 6 月起，您将无法再使用 UpdateAttributionSettings 方法为 GA4 媒体资源配置首次点击、线性、时间衰减和根据位置归因模型。自 2023 年 9 月起，所有媒体资源都将无法再使用这些模型。

如需了解详情，请参阅 Google Analytics 产品公告。

2023 年 5 月 31 日 添加了 AdSense 关联管理方法。

向 Admin API v1alpha 添加了 GetAdSenseLink、CreateAdSenseLink、DeleteAdSenseLink、ListAdSenseLinks 方法。

借助此功能，您可以管理 GA4 媒体资源的 AdSense 与 Google Analytics 关联。

2023 年 5 月 31 日 添加了用于查找关联的 GA4 媒体资源的方法。

Admin API v1alpha 中新增了 FetchConnectedGa4Property 方法

借助此功能，您可以在 GA4 迁移过程中获取有关与您的 Universal Analytics 媒体资源相关联的 GA4 媒体资源的信息。

2023 年 5 月 31 日 添加了用于管理事件创建规则的方法。

向 Admin API v1alpha 添加了 CreateEventCreateRule、UpdateEventCreateRule、DeleteEventCreateRule、ListEventCreateRules、GetEventCreateRule 方法。

借助此功能，您可以管理事件创建规则，这些规则可根据与来源事件匹配的条件触发全新事件的创建。

2023 年 5 月 31 日 添加了用于管理自定义渠道组的方法。

向 Admin API v1alpha 添加了 GetChannelGroup、ListChannelGroups、CreateChannelGroup、UpdateChannelGroup、DeleteChannelGroup 方法。

借助此功能，您可以为网站的流量来源管理自定义渠道组。

创建自定义渠道组后，您可以使用 Google Analytics Data API v1 对其进行查询。

2023 年 3 月 31 日 添加了增强型衡量设置管理方法。

向 Admin API v1alpha 添加了 properties.dataStreams.updateEnhancedMeasurementSettings、properties.dataStreams.getEnhancedMeasurementSettings 方法。

借助此功能，您可以管理 GA4 媒体资源的网站数据流的增强型衡量设置。

2023 年 3 月 31 日 添加了已关联的网站代码管理方法。

向 Admin API v1alpha 添加了 properties.createConnectedSiteTag、properties.deleteConnectedSiteTag、properties.listConnectedSiteTags 方法。

借助此功能，您可以管理关联的网站代码，这对于将流量从 Universal Analytics 媒体资源转发到 Google Analytics 4 媒体资源非常有用。

2023 年 3 月 31 日 向 Admin API v1beta 添加了账号级和媒体资源级 runAccessReport 方法。

向 Admin API 的 v1beta 版本添加了 properties.runAccessReport 和 accounts.runAccessReport 方法。方法会返回自定义的数据访问记录报告。

2023 年 2 月 24 日 添加了展开式数据集管理方法。

ExpandedDataSet 资源已添加到 API 的 v1alpha 版本，以及相应的 properties.expandedDataSets.create、properties.expandedDataSets.delete、properties.expandedDataSets.patch、properties.expandedDataSets.list、properties.expandedDataSets.get 操作。此功能可用于在 Google Analytics 360 中管理展开式数据集。

2023 年 2 月 24 日：访问绑定将取代用户关联，用于管理用户权限。

AccessBinding 资源已添加到该 API 的 v1alpha 版本，以及以下操作：

• 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

借助此功能，您可以管理 GA4 账号或媒体资源的用户权限，并且应将其用作 User Links 的替代方案。

用户关联功能将于 2023 年 6 月 1 日从 Admin API v1 Alpha 版中移除

2023 年 2 月 24 日 弃用用户权限审核方法。

以下方法已废弃，将于 2023 年 6 月 1 日从 Admin API v1 alpha 中移除：

• accounts.userLinks.audit
• properties.userLinks.audit

2023 年 2 月 24 日 添加了受众群体管理方法。

Audience 资源已添加到 API 的 v1alpha 版本，以及相应的 properties.audience.create、properties.audience.archive、properties.audience.patch、properties.audience.list、properties.audience.get 操作。

借助此功能，您可以管理 GA4 媒体资源的受众群体。

2023 年 2 月 15 日 添加了 GA4 自动设置流程停用方法。

properties.setAutomatedGa4ConfigurationOptOut、properties.fetchAutomatedGa4ConfigurationOptOut 操作已添加到该 API 的 v1alpha 版本。

借助此功能，您可以管理 UA 媒体资源的 GA4 自动设置流程停用状态。

2023 年 2 月 15 日：添加了 BigQuery 关联管理方法。

BigQueryLink 资源已添加到 v1alpha 版 API 中，以及相应的 properties.bigQueryLinks.get、properties.bigQueryLinks.list 操作。

借助此功能，您可以检索有关 GA4 媒体资源与 BigQuery 项目之间的关联的信息。

2023 年 2 月 15 日 添加了 Search Ads 360 关联管理方法。

SearchAds360Link 资源已添加到 API 的 v1alpha 版本，以及相应的 properties.searchAds360Links.create、properties.searchAds360Links.delete、properties.searchAds360Links.patch、properties.searchAds360Links.list、properties.searchAds360Links.get 操作。

借助此功能，您可以管理 GA4 媒体资源与 Search Ads 360 实体之间的关联。

2023 年 2 月 15 日 重大变更。

• 从 NumericFilter.Operation 枚举中移除了 LESS_THAN_OR_EQUAL、GREATER_THAN_OR_EQUAL 值。

• 从 StringFilter.MatchType 枚举中移除了 PARTIAL_REGEXP 值。

2023 年 2 月 15 日：进行了一些其他更改。

• 向 AccessQuota 类型添加了 tokensPerProjectPerHour 字段。
• 向 ChangeHistoryResourceType 枚举添加了 EXPANDED_DATA_SET、CHANNEL_GROUP 值。
• 向 ChangeHistoryResource 添加了 searchAds360Link、expandedDataSet、bigqueryLink 值。

2022 年 8 月 11 日 向 Admin API v1alpha 添加了 runAccessReport 方法。

向 Admin API 的 v1alpha 版本添加了 properties.runAccessReport 方法。它会返回数据访问记录的自定义报告。该报告会记录用户每次读取 Google Analytics 报告数据的情况。Google Analytics 360 版媒体资源的管理员可以使用数据访问报告。

2022 年 7 月 11 日发布了 Admin API v1beta 版本。

Google Analytics Admin API 的 v1beta 版本已发布。

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

2021 年 10 月 12 日 从 API 中移除了 EnhancedMeasurementSettings 方法。

• properties.webDataStreams.getEnhancedMeasurementSettings、properties.webDataStreams.updateEnhancedMeasurementSettings 方法已从 API 中移除，但增强型衡量设置很快将再次可通过 API 修改。
• UserLink 资源的 directRoles 字段不再支持 predefinedRoles/manage-users 角色。应改用新的 predefinedRoles/admin 角色，该角色相当于旧版 predefinedRoles/edit 和 predefinedRoles/manage-users 角色的组合。此更改会影响 accounts.userLinks 和 properties.userLinks 方法的行为，并且与 Google Analytics 中引入的访问权限和数据限制管理变更保持一致。

2021 年 6 月 5 日：添加了功能。

该 API 中添加了以下功能：

• 向 API 添加了 accounts.searchChangeHistoryEvents 方法。此方法会根据指定的一组过滤条件，搜索账号或其子账号的所有更改。常见原因包括在 Google Analytics 界面中进行的更新、客户支持团队所做的更改，或 Google Analytics 系统自动更改。
• 在 properties.webDataStreams.measurementProtocolSecrets 下添加了 Measurement Protocol 密钥管理方法：
  • create 创建 Measurement Protocol 密钥。
  • delete 删除目标 Measurement Protocol Secret。
  • get 查找单个 Measurement Protocol 密钥。
  • list 返回指定父媒体资源下的子级 Measurement Protocol 密钥。
  • patch 更新 Measurement Protocol 密钥。
• 在 properties.conversionEvents 下添加了转化事件管理方法：
  • create 创建具有指定属性的转化事件。
  • delete 删除媒体资源中的转化事件。
  • get 检索单个转化事件。
  • list 返回指定父级媒体资源中的转化事件列表。
• 在 properties.customDimensions 下添加了自定义维度管理方法：
  • archive 归档媒体资源的自定义维度。
  • create 创建自定义维度。
  • get 查找单个自定义维度。
  • list 列出媒体资源的自定义维度。
  • patch 更新媒体资源的自定义维度。
• 在 properties.customMetrics 下添加了自定义指标管理方法：
  • archive 归档媒体资源的自定义指标。
  • create 用于创建自定义指标。
  • get 查找单个自定义指标。
  • list 列出媒体资源的自定义指标。
  • patch 更新媒体资源的自定义指标。
• 添加了 properties.getGoogleSignalsSettings、properties.updateGoogleSignalsSettings 方法，可用于控制 Google Analytics 4 媒体资源的 Google 信号设置。
• delete_time、expire_time 仅输出添加到 Property 类型的字段。

2021 年 6 月 5 日 破坏性更改。

引入了以下破坏性更改：

• 从 API 中移除了 properties.iosAppDataStreams.create、properties.androidAppDataStreams.create 方法。请使用 Firebase 在 Google Analytics 4 媒体资源中创建应用数据流。
• properties.delete 方法现在会将已删除的媒体资源数据返回为 Property 类型，而不是返回空响应。
• Property 类型的 time_zone 字段现已成为必填字段。
• 从 Property 类型中移除了 deleted 字段。
• UserLink 类型的 email_address 字段现已不可变。
• UserLink 类型的 name 字段现在仅用于输出。

2021 年 1 月 28 日 为 ListFirebaseLinks 操作添加了分页支持。

2021 年 1 月 28 日 进行了破坏性更改。

破坏性更改： - 所有更新操作都需要 update_mask 字段。

• Account 中的 country_code 字段已重命名为 region_code。

• EnhancedMeasurementSettings 中的 url_query_parameter 字段已重命名为 uri_query_parameter。

• 已从 GoogleAdsLink 中移除 parent 字段。

2020 年 10 月 20 日 添加了对账号摘要的支持。

添加了对账号摘要方法的支持。

2020 年 10 月 13 日“应用 + 网站”媒体资源已重命名为 Google Analytics 4 (GA4)。

2020 年 8 月 15 日“管理应用 + Web API”已重命名为“Admin API”。

Google Analytics 管理 App + Web API 已重命名为 Google Analytics Admin API。因此，API 端点已更改为 analyticsadmin.googleapis.com。针对旧版 API 端点网址和客户端库编写的现有代码需要相应更新。