如需了解有关 Google Analytics API 的官方公告,请订阅 Google Analytics API Notify 群组。
2025-08-20 添加了 GetReportingIdentitySettings
方法
向 Admin API v1alpha 添加了 GetReportingIdentitySettings
方法,可用于检索媒体资源的 ReportingIdentitySettings
。
2025-08-20 移除了旧版 Universal Analytics 方法
以下旧版 Universal Analytics (UA) 方法已从 Admin API v1alpha 中移除:SetAutomatedGa4ConfigurationOptOut
、FetchAutomatedGa4ConfigurationOptOut
、CreateConnectedSiteTag
、DeleteConnectedSiteTag
、ListConnectedSiteTags
和 FetchConnectedGa4Property
。
2025-06-12 添加了子媒体资源同步配置管理方法
添加了 GetSubpropertySyncConfig
、ListSubpropertySyncConfig
和 UpdateSubpropertySyncConfig
方法,用于通过 Admin API v1alpha 管理 SubpropertySyncConfig
资源。
2025-04-16 添加了报告数据注释管理方法
添加了 CreateReportingDataAnnotation
、GetReportingDataAnnotation
、ListReportingDataAnnotations
、UpdateReportingDataAnnotation
和 DeleteReportingDataAnnotation
方法,用于通过 Admin API v1alpha 管理 ReportingDataAnnotation
资源。
借助注释功能,用户可直接在 Google Analytics 报告中添加备注,从而更轻松地记录事件、说明数据变化,或为自己和团队突出显示关键观察结果。
2025-03-07 弃用 sharingWithGoogleAnySalesEnabled
参数
getDataSharingSettings
方法的 sharingWithGoogleAnySalesEnabled
参数现已弃用,并且将始终返回 false
。该字段将于 2025 年 6 月从 Google Analytics Admin API v1beta 中移除。
2025-01-20 向 DataRetentionSettings
添加了用户数据保留
在 Admin API v1alpha 和 v1beta 中,向 DataRetentionSettings
添加了 userDataRetention
字段。使用此字段可检索或修改用户数据的保留设置。
2024 年 9 月 9 日“访问报告”问卷调查表
runAccessReport
方法的文档已更新,其中包含指向 Google Analytics 访问权限报告反馈表单的链接。我们十分重视您的意见,欢迎您分享对该 API 的想法,帮助我们进一步改进它。
2024-08-01 添加了 BigQuery 关联管理
添加了 CreateBigQueryLink
、UpdateBigQueryLink
和 DeleteBigQueryLink
方法,用于通过 Admin API v1alpha 管理 BigQueryLink
资源。
向 BigQueryLink
资源添加了 dataset_location
字段。
在 ChangeHistoryResourceType
中添加了 BigQuery 链接更改,以在新的 BIGQUERY_LINK
值下更改历史记录。
2024-08-01 createSubproperty
方法的重大变更
在 Admin API v1alpha 中,将 createSubproperty
自定义方法重命名为 provisionSubproperty
,以符合自定义方法指南。
2024-08-01 添加了活动编辑规则管理
GetEventEditRule
、CreateEventEditRule
、DeleteEventEditRule
、ListEventEditRules
、UpdateEventEditRules
、ReorderEventEditRules
方法已添加到 Admin API v1alpha。
EventEditRule
用于定义条件,这些条件将根据源事件的匹配条件触发全新事件的创建。此外,EventEditRule
还可以定义对源事件中参数的修改。
2024-08-01 其他方面的更改
向 Audience
资源添加了 create_time
。
向 ChannelGroup
资源添加了 primary
,用于指明相应渠道组是否为报告的默认渠道组。在任何给定时间,只能有一个渠道组的 primary
设置为 true
。将渠道组的 primary
设置为 true
会自动将之前的主渠道组的 primary
设置为 false
。
向 Account
资源添加了 gmp_organization
,其中包含 Google Marketing Platform 组织资源的 URI(如果账号已与 GMP 组织相关联)。
2024-05-06 添加了关键事件管理方法
现在可以使用关键事件的相关资源和方法。
修改您的 API 集成,以使用 KeyEvent
而不是 ConversionEvent
。ConversionEvent
已弃用。
2023-12-15:所有 Google Analytics 媒体资源现均可生成数据访问报告。
数据访问报告功能的某些字段现已面向所有 Google Analytics 媒体资源(包括标准版和 Google Analytics 360 版)的客户提供。
如需了解详情,请参阅架构文档。
2023-12-15 向数据访问权限报告架构添加了 accessDateHour
维度。
已添加到数据访问权限报告架构中的 accessDateHour
维度。它包含访问 GA 报告数据的 GA 用户的日期时间。
2023-10-05:如果媒体资源采用“首次点击”“线性”“时间衰减”和“根据位置”归因模型,则默认采用“跨渠道 DDA”。
自 2023 年 10 月中旬起,所有媒体资源都无法再使用 first-click、linear、time-decay 和 position-based 归因模型以及 UpdateAttributionSettings 方法。
如果您的媒体资源目前配置为使用上述任一模型,则系统会将其更改为以数据为依据的跨渠道归因。 您仍然可以选择使用“跨渠道最终点击”或“首选 Google Ads 最终点击”归因模型。
2023-09-01 添加了 SKAdNetwork 转化价值架构配置方法。
GetSKAdNetworkConversionValueSchema
、CreateSKAdNetworkConversionValueSchema
、DeleteSKAdNetworkConversionValueSchema
、UpdateSKAdNetworkConversionValueSchema
、ListSKAdNetworkConversionValueSchemas
方法已添加到 Admin API v1alpha。
此功能可用于管理 iOS 信息流的 SKAdNetwork 转化价值架构配置。
2023-09-01 添加了 UpdateConversionEvent
方法。
Admin API v1beta 中添加了 UpdateConversionEvent
方法。
2023-09-01 将 BigQueryLink.enterprise_export_enabled
字段重命名为 fresh_daily_export_enabled
。
BigQueryLink
资源的 enterprise_export_enabled
字段已重命名为 fresh_daily_export_enabled
。
2023-07-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-07-10 为 AttributionSettings
类型添加了 ads_web_conversion_data_export_scope
字段
向 AttributionSettings
类型添加了 ads_web_conversion_data_export_scope
字段,该字段可以使用 UpdateAttributionSettings
方法进行修改。
2023-06-05 弃用“首次点击”“线性”“时间衰减”和“根据位置”归因模型。
自 2023 年 6 月起,UpdateAttributionSettings 方法将无法用于配置采用首次点击、线性、时间衰减和根据位置归因模型的 GA4 媒体资源。自 2023 年 9 月起,所有媒体资源都将无法使用这些模型。
如需了解详情,请参阅 Google Analytics 产品公告。
2023-05-31:添加了 AdSense 关联管理方法。
向 Admin API v1alpha 添加了 GetAdSenseLink
、CreateAdSenseLink
、DeleteAdSenseLink
、ListAdSenseLinks
方法。
此功能可用于管理 GA4 媒体资源的 AdSense 与 Google Analytics 之间的关联。
2023-05-31 添加了用于查找已关联 GA4 媒体资源的方法。
Admin API v1alpha 中新增的 FetchConnectedGa4Property
方法
此功能可在 GA4 迁移过程中获取有关与您的 Universal Analytics 媒体资源相关联的 GA4 媒体资源的信息。
2023-05-31 添加了用于管理事件创建规则的方法。
已向 Admin API v1alpha 添加 CreateEventCreateRule
、UpdateEventCreateRule
、DeleteEventCreateRule
、ListEventCreateRules
、GetEventCreateRule
方法。
此功能可用于管理事件创建规则,这些规则可以根据源事件的匹配条件触发全新事件的创建。
2023-05-31 添加了用于管理自定义渠道组的方法。
向 Admin API v1alpha 添加了 GetChannelGroup
、ListChannelGroups
、CreateChannelGroup
、UpdateChannelGroup
、DeleteChannelGroup
方法。
此功能可用于管理网站流量来源的自定义渠道组。
创建自定义渠道组后,可以使用 Google Analytics Data API v1 查询这些渠道组。
2023-03-31 新增了增强型衡量设置管理方法。
向 Admin API v1alpha 添加了 properties.dataStreams.updateEnhancedMeasurementSettings
、properties.dataStreams.getEnhancedMeasurementSettings
方法。
此功能可用于管理 GA4 媒体资源的网站数据流的增强型衡量设置。
2023-03-31 添加了已关联的网站代码管理方法。
向 Admin API v1alpha 添加了 properties.createConnectedSiteTag
、properties.deleteConnectedSiteTag
、properties.listConnectedSiteTags
方法。
此功能可用于管理关联的网站代码,有助于将流量从 Universal Analytics 媒体资源转发到 Google Analytics 4 媒体资源。
2023-03-31 向 Admin API v1beta 添加了账号级和媒体资源级 runAccessReport
方法。
v1beta 版 Admin API 中添加了 properties.runAccessReport
和 accounts.runAccessReport
方法。方法会返回自定义的数据访问记录报告。
2023-02-24 添加了展开式数据集管理方法。
ExpandedDataSet
资源已添加到 API 的 v1alpha 版本中,同时添加了相应的 properties.expandedDataSets.create
、properties.expandedDataSets.delete
、properties.expandedDataSets.patch
、properties.expandedDataSets.list
、properties.expandedDataSets.get
操作。此功能可用于管理 Google Analytics 360 中的展开式数据集。
2023-02-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-02-24 弃用用户权限审核方法。
以下方法已弃用,并将于 2023 年 6 月 1 日从 Admin API v1 alpha 中移除:
2023-02-24 添加了受众群体管理方法。
Audience
资源已添加到 API 的 v1alpha 版本中,同时添加了相应的 properties.audience.create
、properties.audience.archive
、properties.audience.patch
、properties.audience.list
、properties.audience.get
操作。
此功能可用于管理 GA4 媒体资源的受众群体。
2023-02-15 添加了 GA4 自动设置流程的退出方法。
properties.setAutomatedGa4ConfigurationOptOut
、properties.fetchAutomatedGa4ConfigurationOptOut
操作已添加到 v1alpha 版 API 中。
此功能可用于管理 UA 媒体资源的自动 GA4 设置流程的退出状态。
2023-02-15 添加了 BigQuery 关联管理方法。
BigQueryLink
资源已添加到 v1alpha 版 API 中,同时添加了相应的 properties.bigQueryLinks.get
、properties.bigQueryLinks.list
操作。
此功能可用于检索有关 GA4 媒体资源与 BigQuery 项目之间的关联的信息。
2023-02-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-02-15 重大变更。
从
NumericFilter.Operation
枚举中移除了LESS_THAN_OR_EQUAL
、GREATER_THAN_OR_EQUAL
值。从
StringFilter.MatchType
枚举中移除了PARTIAL_REGEXP
值。
2023-02-15 其他方面的变更。
- 已向
AccessQuota
类型添加tokensPerProjectPerHour
字段。 ChangeHistoryResourceType
枚举中添加了EXPANDED_DATA_SET
、CHANNEL_GROUP
值。- 已将
searchAds360Link
、expandedDataSet
、bigqueryLink
值添加到ChangeHistoryResource
。
2022-08-11 向 Admin API v1alpha 添加了 runAccessReport
方法。
添加到 Admin API 的 v1alpha 版本中的 properties.runAccessReport
方法。它会返回数据访问记录的自定义报告。该报告会记录用户每次读取 Google Analytics 报告数据的时间。数据访问报告面向 Google Analytics 360 版媒体资源的管理员提供。
2022-07-11 发布了 Admin API v1beta 版本。
Google Analytics Admin API 的 v1beta 版本已发布。
对于 Admin API,我们仍会继续支持 Alpha 版和 Beta 版渠道的 API。Beta 版包含 Alpha 版中被认为稳定且未来不会发生重大变化的部分功能。新功能成熟后,我们会将其添加到 Beta 版中。
2021-10-12 从 API 中移除了 EnhancedMeasurementSettings 方法。
- 从 API 中移除了
properties.webDataStreams.getEnhancedMeasurementSettings
、properties.webDataStreams.updateEnhancedMeasurementSettings
方法,但很快将再次通过 API 修改增强型衡量设置。 UserLink
资源的directRoles
字段不再支持predefinedRoles/manage-users
角色。 应改用新的predefinedRoles/admin
角色,该角色相当于旧的predefinedRoles/edit
和predefinedRoles/manage-users
角色的组合。此项更改会影响accounts.userLinks
、properties.userLinks
方法的行为,并与 Google Analytics 中引入的访问权限和数据限制管理变更保持一致。
2021-06-05 添加了功能。
此 API 中添加了以下功能:
- 向 API 添加了
accounts.searchChangeHistoryEvents
方法。此方法会根据指定的过滤条件搜索账号或其子级的所有更改。常见原因包括在 Google Analytics 界面中进行的更新、客户支持人员所做的更改,或 Google Analytics 系统自动进行的更改。 - 在
properties.webDataStreams.measurementProtocolSecrets
下添加了 Measurement Protocol 密钥管理方法: - 在
properties.conversionEvents
下添加了转化事件管理方法: - 在
properties.customDimensions
下添加了自定义维度管理方法: - 在
properties.customMetrics
下添加了自定义指标管理方法: - 添加了
properties.getGoogleSignalsSettings
、properties.updateGoogleSignalsSettings
方法,用于控制 Google Analytics 4 媒体资源的 Google 信号设置。 delete_time
、expire_time
添加到Property
类型的仅输出字段。
2021-06-05 重大变更。
引入了以下重大更改:
- 从 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-01-28 为 ListFirebaseLinks
操作添加了分页支持。
2021-01-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-08-15 管理应用 + Web API 重命名为 Admin API。
Google Analytics Management App + Web API 已重命名为 Google Analytics Admin API。因此,API 端点已更改为 analyticsadmin.googleapis.com。针对之前版本的 API 端点网址和客户端库编写的现有代码需要相应地进行更新。