更新日志

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

2024 年 10 月 15 日reportTasks 方法添加了“采样”级别功能

您可以使用 properties.runReportTask 方法的 samplingLevel 字段来控制报告的抽样级别

借助此功能,Google Analytics 360 媒体资源可以使用更高的抽样上限,即 10 亿个事件。此外,对于事件数较多的未抽样结果,可以将抽样限制设置为 UNSAMPLED

2024 年 9 月 18 日 添加了媒体资源配额概况功能

使用 properties.getPropertyQuotasSnapshot 方法,您可以获取指定媒体资源的所有媒体资源配额的当前快照,这些配额按配额类别进行分类。

2024 年 6 月 28 日 添加了“每个项目每项媒体资源的客户端错误数”配额

现在,每个项目每项媒体资源在 15 分钟内允许的 API 服务器错误数上限为 10,000 个。这包括所有导致响应代码为 500200 以外的代码的请求。属于此配额的错误示例:使用不兼容的维度和指标组合、所有身份验证错误。

如果超出此限制,系统将暂时阻止关联的 Google Cloud 项目对该媒体资源的进一步 API 调用,直到 15 分钟的时间段结束。

2024 年 5 月 14 日 添加了“比较”功能

借助比较项,您可以并排评估数据的不同子集。

Data API v1beta 的核心报告方法已更新,以支持 comparisons 字段(如果包含此字段,则用于指定所请求比较的配置配置)。

在请求中,您可以通过在请求中提供 dimensionFilter 表达式来指定基本比较,也可以通过在 comparison 字段中提供比较项的资源名称来使用已保存的比较项。

getMetadata 方法将会更新,以在 comparisons 响应字段下列出可用于某个属性的所有已保存比较项。

如果请求中指定了至少一个比较项,则响应中将包含用于标识每个比较项的 comparison 列。

目前,您只能使用 Google Analytics 界面创建已保存的比较。

2024 年 5 月 8 日 向 Data API v1alpha 添加了报告任务(一种异步报告功能)。

您可以使用报告任务发起长时间运行的异步请求,以便根据 Google Analytics 事件数据生成自定义报告。

Data API v1alpha 中新增了以下报告任务操作方法:

2024 年 5 月 6 日 新增了关键事件维度

关键事件的维度和指标现已推出。

将使用 isConversionEvent 维度的报告请求修改为使用 isKeyEvent 维度。

修改使用下表中已废弃的指标的所有报告请求,改为使用关键事件指标

已弃用的指标 关键事件指标
advertiserAdCostPerConversion advertiserAdCostPerKeyEvent
conversions keyEvents
firstTimePurchaserConversionRate firstTimePurchaserRate
purchaserConversionRate purchaserRate
sessionConversionRate sessionKeyEventRate
userConversionRate userKeyEventRate

对报告请求中一种关键事件的关键事件指标的任何用法进行类似修改。

properties/getMetadata 方法的响应反映了 DimensionMetadataMetricMetadata 对象中引入了关键事件维度和指标,如下所示:

  • apiNameuiNamedescription 包含按键事件 API 名称、界面名称和说明。
  • deprecatedApiNames 重复字段包含使用已废弃的转化 API 名称的条目。

2024 年 3 月 25 日 添加了主要渠道组、手动流量来源和集成专用维度。

向 Data API 架构添加了主要渠道组、人工流量来源以及 CM360、DV360、SA360 集成专用维度。

受众群体维度

  • audienceId 受众群体 ID。受众群体的数字标识符。

“主要渠道组”维度

  • firstUserPrimaryChannelGroup 带来用户首次互动的主渠道组

  • primaryChannelGroup 主渠道组

  • sessionPrimaryChannelGroup 带来会话的主渠道组

人工流量来源维度

  • manualCampaignId 人工广告系列 ID

  • manualCampaignName 人工广告系列名称

  • manualCreativeFormat 手动创建的广告素材格式

  • manualMarketingTactic 人工营销策略

  • manualMedium 人工媒介

  • manualSource 人工来源

  • manualSourceMedium 人工来源 / 媒介

  • manualSourcePlatform 个人工来源平台

  • firstUserManualCampaignId 带来用户首次互动的人工广告系列 ID

  • firstUserManualCampaignName 带来用户首次互动的人工广告系列名称

  • firstUserManualCreativeFormat 带来用户首次互动的手动创建的广告素材格式

  • firstUserManualMarketingTactic 带来用户首次互动的人工营销策略

  • firstUserManualMedium 带来用户首次互动的人工媒介

  • firstUserManualSource 带来用户首次互动的人工来源

  • firstUserManualSourceMedium 带来用户首次互动的人工来源 / 媒介

  • firstUserManualSourcePlatform 带来用户首次互动的人工来源平台

  • sessionManualCampaignId 个带来会话的人工广告系列 ID

  • sessionManualCampaignName 带来会话的人工广告系列名称

  • sessionManualCreativeFormat 带来会话的人工广告素材格式

  • sessionManualMarketingTactic 带来会话的人工营销策略

  • sessionManualMedium 带来会话的人工媒介

  • sessionManualSource 带来会话的人工来源

  • sessionManualSourceMedium 个带来会话的人工来源 / 媒介

  • sessionManualSourcePlatform 个带来会话的人工来源平台

Campaign Manager 360 (CM360) 集成维度

  • cm360AccountId 个 CM360 账号 ID

  • cm360AccountName CM360 账号名称

  • cm360AdvertiserId CM360 广告客户 ID

  • cm360AdvertiserName CM360 广告客户名称

  • cm360CampaignId 个 CM360 广告系列 ID

  • cm360CampaignName CM360 广告系列名称

  • cm360CreativeFormat 种 CM360 广告素材格式

  • cm360CreativeId CM360 广告素材 ID

  • cm360CreativeName 个 CM360 广告素材名称

  • cm360CreativeType CM360 广告素材类型

  • cm360CreativeTypeId 个 CM360 广告素材类型 ID

  • cm360CreativeVersion CM360 广告素材版本

  • cm360Medium CM360 媒介

  • cm360PlacementCostStructure CM360 展示位置费用结构

  • cm360PlacementId 个 CM360 展示位置 ID

  • cm360PlacementName CM360 展示位置名称

  • cm360RenderingId 个 CM360 呈现 ID

  • cm360SiteId CM360 网站 ID

  • cm360SiteName CM360 网站名称

  • cm360Source 个 CM360 来源

  • cm360SourceMedium CM360 来源 / 媒介

  • firstUserCm360AccountId 带来用户首次互动的 CM360 账号 ID

  • firstUserCm360AccountName 带来用户首次互动的 CM360 账号名称

  • firstUserCm360AdvertiserId 带来用户首次互动的 CM360 广告客户 ID

  • firstUserCm360AdvertiserName 带来用户首次互动的 CM360 广告客户名称

  • firstUserCm360CampaignId 带来用户首次互动的 CM360 广告系列 ID

  • firstUserCm360CampaignName 带来用户首次互动的 CM360 广告系列名称

  • firstUserCm360CreativeFormat 带来用户首次互动的 CM360 广告素材格式

  • firstUserCm360CreativeId 带来用户首次互动的 CM360 广告素材 ID

  • firstUserCm360CreativeName 带来用户首次互动的 CM360 广告素材名称

  • firstUserCm360CreativeType 带来用户首次互动的 CM360 广告素材类型

  • firstUserCm360CreativeTypeId 带来用户首次互动的 CM360 广告素材类型 ID

  • firstUserCm360CreativeVersion 带来用户首次互动的 CM360 广告素材版本

  • firstUserCm360Medium 带来用户首次互动的 CM360 媒介

  • firstUserCm360PlacementCostStructure 带来用户首次互动的 CM360 展示位置费用结构

  • firstUserCm360PlacementId 带来用户首次互动的 CM360 展示位置 ID

  • firstUserCm360PlacementName 带来用户首次互动的 CM360 展示位置名称

  • firstUserCm360RenderingId 带来用户首次互动的 CM360 呈现 ID

  • firstUserCm360SiteId 带来用户首次互动的 CM360 网站 ID

  • firstUserCm360SiteName 带来用户首次互动的 CM360 网站名称

  • firstUserCm360Source 带来用户首次互动的 CM360 来源

  • firstUserCm360SourceMedium 带来用户首次互动的 CM360 来源 / 媒介

  • sessionCm360AccountId 带来会话的 CM360 账号 ID

  • sessionCm360AccountName 带来会话的 CM360 账号名称

  • sessionCm360AdvertiserId 带来会话的 CM360 广告客户 ID

  • sessionCm360AdvertiserName 个带来会话的 CM360 广告客户名称

  • sessionCm360CampaignId 个带来会话的 CM360 广告系列 ID

  • sessionCm360CampaignName 个带来会话的 CM360 广告系列名称

  • sessionCm360CreativeFormat 带来会话的 CM360 广告素材格式

  • sessionCm360CreativeId 带来会话的 CM360 广告素材 ID

  • sessionCm360CreativeName 带来会话的 CM360 广告素材名称

  • sessionCm360CreativeType 带来会话的 CM360 广告素材类型

  • sessionCm360CreativeTypeId 带来会话的 CM360 广告素材类型 ID

  • sessionCm360CreativeVersion 个带来会话的 CM360 广告素材版本

  • sessionCm360Medium 带来会话的 CM360 媒介

  • sessionCm360PlacementCostStructure 带来会话的 CM360 展示位置费用结构

  • sessionCm360PlacementId 带来会话的 CM360 展示位置 ID

  • sessionCm360PlacementName 带来会话的 CM360 展示位置名称

  • sessionCm360RenderingId 带来会话的 CM360 呈现 ID

  • sessionCm360SiteId 个带来会话的 CM360 网站 ID

  • sessionCm360SiteName 带来会话的 CM360 网站名称

  • sessionCm360Source 个带来会话的 CM360 来源

  • sessionCm360SourceMedium 带来会话的 CM360 来源 / 媒介

Google Display & Video 360 (DV360) 集成维度

  • dv360AdvertiserId 个 DV360 广告客户 ID

  • dv360AdvertiserName DV360 广告客户名称

  • dv360CampaignId DV360 广告系列 ID

  • dv360CampaignName DV360 广告系列名称

  • dv360CreativeFormat DV360 广告素材格式

  • dv360CreativeId DV360 广告素材 ID

  • dv360CreativeName DV360 广告素材名称

  • dv360ExchangeId DV360 广告交易平台 ID

  • dv360ExchangeName 个 DV360 广告交易平台名称

  • dv360InsertionOrderId DV360 广告订单 ID

  • dv360InsertionOrderName DV360 广告订单名称

  • dv360LineItemId 个 DV360 订单项 ID

  • dv360LineItemName 个 DV360 订单项名称

  • dv360Medium 个 DV360 媒介

  • dv360PartnerId DV360 合作伙伴 ID

  • dv360PartnerName DV360 合作伙伴名称

  • dv360Source DV360 来源

  • dv360SourceMedium DV360 来源 / 媒介

  • firstUserDv360AdvertiserId 带来用户首次互动的 DV360 广告客户 ID

  • firstUserDv360AdvertiserName 带来用户首次互动的 DV360 广告客户名称

  • firstUserDv360CampaignId 带来用户首次互动的 DV360 广告系列 ID

  • firstUserDv360CampaignName 带来用户首次互动的 DV360 广告系列名称

  • firstUserDv360CreativeFormat 带来用户首次互动的 DV360 广告素材格式

  • firstUserDv360CreativeId 带来用户首次互动的 DV360 广告素材 ID

  • firstUserDv360CreativeName 带来用户首次互动的 DV360 广告素材名称

  • firstUserDv360ExchangeId 带来用户首次互动的 DV360 广告交易平台 ID

  • firstUserDv360ExchangeName 带来用户首次互动的 DV360 广告交易平台名称

  • firstUserDv360InsertionOrderId 带来用户首次互动的 DV360 广告订单 ID

  • firstUserDv360InsertionOrderName 带来用户首次互动的 DV360 广告订单名称

  • firstUserDv360LineItemId 带来用户首次互动的 DV360 订单项 ID

  • firstUserDv360LinteItemName 带来用户首次互动的 DV360 订单项名称

  • firstUserDv360Medium 带来用户首次互动的 DV360 媒介

  • firstUserDv360PartnerId 带来用户首次互动的 DV360 合作伙伴 ID

  • firstUserDv360PartnerName 带来用户首次互动的 DV360 合作伙伴名称

  • firstUserDv360Source 带来用户首次互动的 DV360 来源

  • firstUserDv360SourceMedium 带来用户首次互动的 DV360 来源 / 媒介

  • sessionDv360AdvertiserId 带来会话的 DV360 广告客户 ID

  • sessionDv360AdvertiserName 带来会话的 DV360 广告客户名称

  • sessionDv360CampaignId 带来会话的 DV360 广告系列 ID

  • sessionDv360CampaignName 带来会话的 DV360 广告系列名称

  • sessionDv360CreativeFormat 带来会话的 DV360 广告素材格式

  • sessionDv360CreativeId 带来会话的 DV360 广告素材 ID

  • sessionDv360CreativeName 带来会话的 DV360 广告素材名称

  • sessionDv360ExchangeId 带来会话的 DV360 广告交易平台 ID

  • sessionDv360ExchangeName 带来会话的 DV360 广告交易平台名称

  • sessionDv360InsertionOrderId 个带来会话的 DV360 广告订单 ID

  • sessionDv360InsertionOrderName 带来会话的 DV360 广告订单名称

  • sessionDv360LineItemId 个带来会话的 DV360 订单项 ID

  • sessionDv360LineItemName 带来会话的 DV360 订单项名称

  • sessionDv360Medium 带来会话的 DV360 媒介

  • sessionDv360PartnerId 带来会话的 DV360 合作伙伴 ID

  • sessionDv360PartnerName 带来会话的 DV360 合作伙伴名称

  • sessionDv360Source 带来会话的 DV360 来源

  • sessionDv360SourceMedium 带来会话的 DV360 来源 / 媒介

Google Search Ads 360 (SA360) 集成维度

  • firstUserSa360AdGroupId 带来用户首次互动的 SA360 广告组 ID

  • firstUserSa360AdGroupName 带来用户首次互动的 SA360 广告组名称

  • firstUserSa360CampaignId 带来用户首次互动的 SA360 广告系列 ID

  • firstUserSa360CampaignName 带来用户首次互动的 SA360 广告系列

  • firstUserSa360CreativeFormat 带来用户首次互动的 SA360 广告素材格式

  • firstUserSa360EngineAccountId 带来用户首次互动的 SA360 引擎账号 ID

  • firstUserSa360EngineAccountName 带来用户首次互动的 SA360 引擎账号名称

  • firstUserSa360EngineAccountType 带来用户首次互动的 SA360 引擎账号类型

  • firstUserSa360KeywordText 带来用户首次互动的 SA360 关键字文字

  • firstUserSa360ManagerAccountId 带来用户首次互动的 SA360 经理账号 ID

  • firstUserSa360ManagerAccountName 带来用户首次互动的 SA360 经理账号名称

  • firstUserSa360Medium 带来用户首次互动的 SA360 媒介

  • firstUserSa360Query 带来用户首次互动的 SA360 查询

  • firstUserSa360Source 带来用户首次互动的 SA360 来源

  • firstUserSa360SourceMedium 带来用户首次互动的 SA360 来源 / 媒介

  • sa360AdGroupId SA360 广告组 ID

  • sa360CampaignId SA360 广告系列 ID

  • sa360AdGroupName SA360 广告组名称

  • sa360CampaignName 个 SA360 广告系列

  • sa360CreativeFormat SA360 广告素材格式

  • sa360EngineAccountId SA360 引擎账号 ID

  • sa360EngineAccountName SA360 引擎账号名称

  • sa360EngineAccountType SA360 引擎账号类型

  • sa360KeywordText SA360 关键字文字

  • sa360ManagerAccountId SA360 经理账号 ID

  • sa360ManagerAccountName SA360 经理账号名称

  • sa360Medium SA360 媒介

  • sa360Query SA360 查询

  • sa360Source SA360 来源

  • sa360SourceMedium SA360 来源 / 媒介

  • sessionSa360AdGroupId 个带来会话的 SA360 广告组 ID

  • sessionSa360CampaignId 带来会话的 SA360 广告系列 ID

  • sessionSa360ManagerAccountId 带来会话的 SA360 经理账号 ID

  • sessionSa360ManagerAccountName 带来会话的 SA360 经理账号名称

  • sessionSa360SourceMedium 带来会话的 SA360 来源 / 媒介

2024 年 3 月 6 日:受众群体导出功能支持非活跃用户受众群体。

“受众群体导出”功能更好地支持导出非活跃用户受众群体。用户无需触发任何符合条件的事件即可进入这些受众群体;例如,用户只要连续 7 天不访问您的网站,即可进入相应受众群体。不活跃用户受众群体的示例包括“7 天不活跃的购买者”“7 天不活跃的用户”和“7 天内未收到通知的用户”。如需详细了解这些建议的受众群体,请参阅建议的受众群体

2024 年 2 月 28 日 受众群体导出功能会返回代码植入中指定的用户 ID。

现在,即使您的媒体资源启用了用户提供的数据,受众群体导出功能也会返回代码中指定的用户 ID。如果开启了“收集用户提供的数据”功能,则可以在代码植入过程中将用户提供的数据及 User-ID 发送到 Google Analytics,以改进衡量结果。如需了解详情,请参阅“收集用户提供的数据”功能

2024 年 1 月 30 日 为 Data API v1 alpha 中的受众群体名单和周期性受众群体名单引入了 Webhook 通知支持。

创建受众群体名单(使用 properties.audienceLists.create)或周期性受众群体名单(使用 properties.recurringAudienceLists.create)时,可以指定 AudienceList.webhookNotificationRecurringAudienceList.webhookNotification 字段。

借助此功能,您可以在有受众群体名单可用时异步接收 Webhook 通知。

2024 年 1 月 18 日:提高了包含查询字符串或分钟组件的维度的兼容性。

包含查询字符串的维度现在与大多数字段都兼容。pagePathPlusQueryStringunifiedPageScreenpageLocationfullPageUrl 等维度现在与许多其他字段(包括 sessionSourcebrowsercitylandingPage)兼容。

包含分钟部分的维度现在与大多数字段兼容。minutenthMinutedateHourMinute 等维度现在与一组类似的其他字段兼容。

如需获取全面的兼容性信息,请参阅 GA4 维度和指标浏览器

2023 年 12 月 13 日 商品级范围的自定义参数

现在,您可以使用以下语法在 Google Analytics Data API 查询中添加商品级范围的自定义维度:

通用 API 名称 说明
customItem:parameter_name 适用于 parameter_name 的商品级范围自定义维度

如需了解详情,请参阅 API 维度和指标

2023 年 12 月 5 日:受众群体名单在 Data API v1 Beta 版中作为受众群体导出功能提供

受众群体名单功能已重命名为受众群体导出,并已添加到 Data API v1 Beta 版中。

向 Data API v1 Beta 版添加了以下方法:

2023 年 11 月 28 日 在报告回复中添加了 samplingMetadatas

ResponseMetaData 添加了 samplingMetadatas。对于请求中的抽样结果的每个日期范围,此集合都将包含一个 SampleMetadata。只有在 Google Analytics 预计基数限制会降低数据质量时,才会应用抽样。

2023 年 11 月 28 日:向 Data API v1 Alpha 版中添加了定期导出受众群体名单功能

向 Data API v1 alpha 添加了 properties.recurringAudienceLists.createproperties.recurringAudienceLists.createproperties.recurringAudienceLists.list 方法。

借助此功能,您可以根据受众群体成员资格变化,每天生成受众群体名单。定期生成的受众群体名单可确保您处理的是最新的受众群体成员资格结果。

2023 年 11 月 8 日:Data API v1 Alpha 版中新增了将受众群体名单导出至 Google 表格的功能

在 Data API v1 Alpha 版中添加了 properties.audienceLists.exportSheet 方法,可让您将受众群体名单导出到 Google 表格。

2023 年 10 月 13 日 添加了对成员资格有效期为 1 天的受众群体的支持

受众群体名单导出功能现已支持成员资格时长为 1 天的受众群体。

2023 年 9 月 12 日 AudienceList 默认排序规则

默认情况下,使用受众群体名单导出功能创建的报告遵循与 Data API 的其他报告方法相同的排序规则:先按第一列降序排列,然后按第二列降序排列,依此类推。

在此次变更之前,您可能收到了以下报告:

deviceId isAdsPersonalizationAllowed
ABC true
DAC false
ABC false
AAA true

此次变更生效后,您将收到以下报告:

deviceId isAdsPersonalizationAllowed
AAA true
ABC false
ABC true
DAC false

2023 年 8 月 15 日 向受众群体名单导出架构添加了 isLimitedAdTracking 维度

  • isLimitedAdTracking设备的“限制广告跟踪”设置。可能的值包括:truefalse(not set)

    如需了解详情,请参阅受众群体名单维度

2023 年 8 月 15 日 添加了 currencyCode 维度和 itemDiscountAmount 指标

  • currencyCode 电子商务事件的本地货币代码(基于 ISO 4217 标准)。例如“USD”或“GBP”。

  • itemDiscountAmount 电子商务事件中的商品折扣的货币价值。 此指标在代码植入时由“discount”商品参数填充。

如需了解详情,请参阅 Data API 报告架构

2023 年 8 月 10 日 向受众群体名单导出架构添加了 isAdsPersonalizationAllowed 维度

  • isAdsPersonalizationAllowed是否允许广告个性化。 如果用户符合广告个性化条件,isAdsPersonalizationAllowed 会返回 true。如果用户不符合广告个性化条件,isAdsPersonalizationAllowed 会返回 false

    如需了解详情,请参阅受众群体名单维度

2023 年 7 月 10 日 受众群体名单

向 Data API v1 alpha 版添加了受众群体名单支持。受众群体名单包含受众群体在受众群体名单创建时所包含的用户的快照。

Data API v1 Alpha 版中添加了以下方法:

2023 年 5 月 19 日 自定义渠道组

向 Data API 添加了自定义渠道组支持。

2023 年 5 月 11 日:令牌配额发生变更。

更新了 Data API 的配额系统,以便更精确地计算费用。

我们已根据配额变更更新了针对每个请求收取的令牌数量,并重新平衡了令牌分配,以便允许执行更多简单的报告查询,同时针对大型日期报告收取更多配额令牌。

此次变更生效后,虽然部分请求的费用将保持不变,但更复杂的查询的费用将明显增加。例如,如果请求超过 6 个月的数据,则可能需要支付 1,000 个或更多配额令牌。

标准媒体资源

配额名称 旧限额 新限额
每项媒体资源每天的核心令牌数 25000 200000
每项媒体资源每小时的核心令牌数 5000 4 万
每个项目每项媒体资源每小时的核心令牌数 1,750 14,000
每天每个媒体资源的实时令牌数 25000 200000
每小时每项媒体资源的实时令牌数 5000 40,000
每个项目每项媒体资源每小时的实时令牌数 1,750,000 14,000
每项媒体资源每天的漏斗令牌数 25000 200000
每小时每项媒体资源的漏斗令牌数 5000 40,000
每个项目每项媒体资源每小时的漏斗令牌数 1,750,000 14,000

Analytics 360 媒体资源

配额名称 旧限额 新限额
每天每项媒体资源的核心令牌数 250000 2,000,000
每项媒体资源每小时的核心令牌数 5 万 400,000
每个项目每项媒体资源每小时的核心令牌数 17,500 140,000
每项媒体资源每天的实时令牌数 250000 2,000,000
每项媒体资源每小时的实时令牌数 5 万 400,000
每个项目每项媒体资源每小时的实时令牌数 17,500 14 万
每项媒体资源每天的漏斗令牌数 250000 2,000,000
每小时每项媒体资源的漏斗令牌数 5 万 400,000
每个项目每项媒体资源每小时的漏斗令牌数 17,500 14 万

2023-03-02 添加了日期维度。

  • dayOfWeekName周几名称。星期几(英文)。此维度的值为 SundayMonday 等。

  • isoWeek 年份的 ISO 周序号。ISO 周序号,每周从星期一开始。如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_week_date。示例值包括 010253

  • isoYear ISO 年份。事件的 ISO 格式年份。如需了解详情,请参阅 https://en.wikipedia.org/wiki/ISO_week_date。示例值包括 20222023

  • isoYearIsoWeek ISO 年份的 ISO 周数。isoWeekisoYear 的组合值。示例值包括 201652201701

  • yearMonth 年份月份。yearmonth 的组合值。示例值包括 202212202301

  • yearWeek 年份周序号。yearweek 的组合值。示例值包括 202253202301

2023 年 2 月 27 日 添加了电子商务维度。

  • itemListPosition 商品列表位置。商品(例如您销售的产品)在列表中的位置。在代码植入过程中,此维度会通过 items 数组中的“index”参数进行填充。

  • itemLocationID 商品位置 ID。与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。此字段在添加代码时由 items 数组中的“location_id”参数填充。

  • itemPromotionCreativeSlot 个商品推广活动的广告素材位。与商品相关的促销广告素材投放到的广告位的名称。您可以在事件级或商品级通过 creative_slot 参数在代码植入中指定此维度。如果同时在事件级和商品级指定了该参数,系统会使用商品级参数。

2023 年 2 月 21 日:添加了“着陆页 + 查询字符串”维度。

  • landingPagePlusQueryString 着陆页 + 查询字符串。与会话的首次网页浏览相关联的网页路径 + 查询字符串。

此字段取代了 landingPage 维度,该维度已被弃用,并将于 2023 年 5 月 14 日更新为不返回查询字符串。

2023 年 1 月 28 日 添加了“每位用户的浏览量”“滚动用户数”指标。

  • screenPageViewsPerUser 每位用户的浏览量。每位活跃用户浏览的应用屏幕或网页的数量。对同一网页或屏幕的重复浏览也会计入。(screen_view + page_view events) / active users

  • scrolledUsers 执行了滚动操作的用户。至少滚动到网页 90% 的唯一身份用户数。

2023 年 1 月 23 日 添加了“大洲”“大洲 ID”维度。

  • continent 大洲。用户发起活动时所处的大洲。例如 AmericasAsia

  • continentId 大洲 ID。用户发起活动时所处的大洲的地理 ID,基于其 IP 地址派生而来。

2023 年 1 月 23 日 添加了“测试数据过滤器 ID”维度。

  • testDataFilterId 测试数据过滤器 ID。处于测试状态的数据过滤器的数字标识符。您可以使用数据过滤器根据事件参数值在报告中包含或排除事件数据。如需了解详情,请参阅 https://support.google.com/analytics/answer/10108813

2022 年 10 月 18 日:添加了 Google Ads 指标。

  • advertiserAdClicks 广告点击次数。用户点击广告访问媒体资源的总次数。
  • advertiserAdCost 广告费用。您为广告支付的总金额。
  • advertiserAdCostPerClick广告的每次点击费用。广告的每次点击费用是指广告费用除以广告点击次数,通常缩写为 CPC。
  • advertiserAdCostPerConversion 每次转化费用。每次转化费用是指广告费用除以转化次数。
  • advertiserAdImpressions 广告展示次数。总展示次数。
  • returnOnAdSpend的广告支出回报率。广告支出回报率 (ROAS) 是指总收入除以广告客户的广告费。

2022 年 10 月 17 日 添加了商品级范围的指标。

  • itemsAddedToCart 商品已加入购物车。添加到购物车的单件商品的数量。
  • itemsCheckedOut 结账的商品数。单件商品的结账数量。
  • itemsClickedInList 在列表中点击过的商品数。在列表中点击过的单件商品的数量。
  • itemsClickedInPromotion 在促销活动中获得点击的商品数。促销活动中获得点击的单件商品的数量。
  • itemsViewed 查看过的商品数。单件商品的查看次数。
  • itemsViewedInList 在列表中查看过的商品数。在列表中查看的单件商品的数量。
  • itemsViewedInPromotion 件商品在促销活动中查看过。促销活动中查看过的单件商品的数量。

2022 年 9 月 13 日:架构兼容性变更公告。

2022 年 12 月 1 日,将发生以下重大变更:

  1. itemName 等商品级范围的维度与 eventCount 等事件级范围的指标将变得不兼容。商品级范围的维度仍可与商品级范围的指标(例如 itemRevenue)、基于用户的指标(例如 activeUsers)以及基于会话的指标(例如 sessions)搭配使用。

  2. source 等归因维度与 eventCount 等事件级范围的指标变得不兼容。归因维度仍可与 conversions 等可归因指标、activeUsers 等基于用户的指标以及 sessions 等基于会话的指标搭配使用。

  3. 包含查询字符串(例如 pagePathPlusQueryString)的维度只能与一小部分维度和指标兼容。

如需了解详情,请参阅有关兼容性变更的详细说明

2022 年 9 月 1 日 配额更改。

  • 从 Data API 中移除了 Requests per dayRequests Per MinuteRequests Per Minute Per User 配额。

  • 该 API 中新增了 Tokens Per Project Per Property Per Hour 配额。

  • 每个请求都会消耗 Tokens Per Property Per HourTokens Per Project Per Property Per Hour 的配额。

    如需详细了解新配额,请参阅配额文档

2022 年 8 月 3 日 添加了会话级范围的 SA360 维度。

  • sessionSa360AdGroupName 带来会话的 SA360 广告组名称。促成此会话的 Search Ads 360 广告组名称。

  • sessionSa360CampaignName 带来会话的 SA360 广告系列。促成此会话的 Search Ads 360 广告系列的名称。

  • sessionSa360CreativeFormat 带来会话的 SA360 广告素材格式。促成此会话的 Search Ads 360 广告素材类型。例如“自适应搜索广告”或“加大型文字广告”。

  • sessionSa360EngineAccountId 带来会话的 SA360 引擎账号 ID。促成此会话的 SA360 引擎账号的 ID。

  • sessionSa360EngineAccountName 带来会话的 SA360 引擎账号名称。促成此会话的 SA360 引擎账号的名称。

  • sessionSa360EngineAccountType 带来会话的 SA360 引擎账号类型。Search Ads 360 中促成此会话的引擎账号的类型。例如“google ads”“bing”或“baidu”。

  • sessionSa360Keyword 带来会话的 SA360 关键字文字。促成此会话的 Search Ads 360 搜索引擎关键字。

  • sessionSa360Medium带来会话的 SA360 媒介。促成此会话的 Search Ads 360 搜索引擎关键字。例如,“cpc”。

  • sessionSa360Query 带来会话的 SA360 查询。促成此会话的 Search Ads 360 搜索查询。

  • sessionSa360Source 带来会话的 SA360 来源。促成此会话的 Search Ads 360 流量的来源。例如“example.com”或“google”。

  • sessionCampaignIdsessionCampaignName 维度现在支持 Search Ads 360 广告系列。

2022 年 7 月 11 日 添加了转化率指标。

转化率

  • sessionConversionRate 触发了任意转化事件的会话所占的百分比。

  • userConversionRate 表示有多大比例的用户触发了任意转化事件。

“每次转化”转化率指标

  • sessionConversionRate:event_name:触发了特定转化事件的会话所占的百分比。

  • userConversionRate:event_name 触发了特定转化事件的用户所占的百分比。

2022 年 5 月 5 日 向 Alpha 渠道添加了漏斗报告功能。

  • v1alpha 版 API 添加了 runFunnelReport 方法,该方法会返回您的 Google Analytics 事件数据的自定义漏斗报告

  • 此方法是在 Alpha 版稳定性阶段推出的,目的是在进入 Beta 版之前收集有关语法和功能的反馈。欢迎填写 Google Analytics Data API 漏斗报告反馈,提供您对此 API 的反馈。

2022 年 2 月 16 日:添加了新的维度。

手动添加的字词和内容

  • firstUserManualAdContent 带来用户首次互动的人工广告内容。首次获取用户时使用的广告内容。由 utm_content 参数填充。

  • firstUserManualTerm 带来用户首次互动的人工字词。首次获取用户的字词。由 utm_term 参数填充。

  • manualAdContent 人工广告内容。归因于转化事件的广告内容。由 utm_content 参数填充。

  • manualTerm 人工字词。归因于转化事件的字词。 由 utm_term 参数填充。

  • sessionManualAdContent 带来会话的人工广告内容。促成会话的广告内容。由 utm_content 参数填充。

  • sessionManualTerm 带来会话的人工字词。促成会话的字词。 由 utm_term 参数填充。

崩溃分析

  • crashAffectedUsers 受崩溃影响的用户。报告中此行的崩溃记录用户数。

  • crashFreeUsersRate 未遇到崩溃问题的用户占比。

应用/网站

  • averageSessionDuration 用户会话的平均时长(以秒为单位)。

  • newVsReturning新用户 / 回访用户。

  • screenPageViewsPerSession每次会话的浏览次数。

  • landingPage着陆页。与会话中的首次网页浏览相关联的网页路径 + 查询字符串。

  • platformDeviceCategory 您的网站或移动应用在哪个平台和设备上运行。

移动应用

  • averagePurchaseRevenuePerUser 用户平均购买收入。

  • firstTimePurchaserConversionRate:进行首次购买的活跃用户所占的百分比。

  • firstTimePurchasersPerNewUser 首次购买者占新用户的平均比例。

  • dauPerMau 日活 / 月活。既是过去 30 天活跃过的用户又是过去 1 天内活跃用户的用户滚动百分比。

  • dauPerWau 日活 / 周活。既是过去 7 天活跃过的用户又是过去 1 天内活跃用户的用户滚动百分比。

  • wauPerMau WAU / MAU。既是过去 30 天活跃过的用户又是过去 7 天活跃用户的滚动百分比。

  • purchaserConversionRate 进行过一次或多次购买交易的活跃用户所占的百分比。

  • transactionsPerPurchaser 每位购买者的交易次数。

Google Ads 广告系列

  • firstUserGoogleAdsCampaignType 首次获取用户的 Google Ads 广告系列的广告系列类型。

  • googleAdsCampaignType 归因于转化事件的 Google Ads 广告系列的广告系列类型。

  • sessionGoogleAdsCampaignType:促成此会话的 Google Ads 广告系列的广告系列类型。

2021 年 9 月 7 日 添加了新的日期/时间维度。

  • dateHourMinute:日期、小时和分钟的组合值,格式为 YYYYMMDDHHMM。

  • minute 事件记录时刻的小时数(两位数)。

  • nthMinute 自日期范围的起始日期起经过的分钟数。

2021 年 9 月 7 日 添加了由事件参数填充的新维度。

  • achievementId 游戏中针对某个事件的成就 ID。

  • character游戏中针对某个事件的玩家角色。

  • fileExtension 下载文件的扩展名。

  • fileName 已下载文件的网页路径。

  • groupId:游戏中针对某个活动的玩家群组 ID。

  • linkClasses 出站链接的 HTML class 属性。

  • linkDomain:出站链接的目标网域。

  • linkId 出站链接或文件下载的 HTML id 属性。

  • linkText:文件下载的链接文字。

  • linkUrl 出站链接或文件下载的完整网址。

  • method 触发事件的方式。

  • outbound 如果链接指向的网站不属于相应媒体资源的网域,则返回“true”。

  • pageLocation 所访问网页的协议、主机名、网页路径和查询字符串。

  • pageReferrer 包含主机名和路径的完整引荐来源网址。

  • percentScrolled:用户向下滚动页面的百分比(例如“90”)。

  • searchTerm:用户搜索的字词。

  • videoProvider 视频的来源(例如“youtube”)。

  • videoTitle 视频的标题。

  • videoUrl 视频的网址。

  • visible 如果内容可见,则返回“true”。

  • unifiedPagePathScreen 记录事件的网页路径(网站)或屏幕类(应用)。

2021 年 9 月 7 日 API 架构变更。

现有维度的更改

  • unifiedPageScreen 对于网站生成的事件,此维度现在会返回记录事件的网页路径和查询字符串

即将发生的更改公告

  • firstUserTrafficOrigin 首次获取到用户的流量来源。 对于使用 UTM 的流量,请勿依赖此字段返回“Manual”(手动);在即将推出的一项功能中,此字段将从返回“Manual”(手动)更新为返回“(not set)”(未设置)。

  • sessionTrafficOrigin 会话所属广告系列的流量来源。 对于使用 UTM 的流量,请勿依赖返回“Manual”的字段;对于即将发布的功能,此字段将从返回“Manual”更新为返回“(not set)”。

  • trafficOrigin 转化事件所属广告系列的流量来源。 对于使用 UTM 的流量,请勿依赖此字段返回“Manual”(手动);在即将推出的一项功能中,此字段将从返回“Manual”(手动)更新为返回“(not set)”(未设置)。

2021 年 9 月 7 日 向 API 添加了 checkCompatibility 方法。

checkCompatibility 方法会列出可添加到报告请求并保持兼容性的维度和指标。

2021 年 7 月 21 日:实时报告发生了变化。

现在,您可以使用 runRealtimeReport 方法的 minuteRanges 参数指定要读取的事件数据的分钟范围。

2021 年 7 月 21 日:新增了渠道分组维度。

Data API 报告架构中新增了渠道分组维度:

  • firstUserDefaultChannelGrouping带来用户首次互动的默认渠道分组。

  • defaultChannelGrouping:默认渠道分组。

2021 年 6 月 10 日 API 架构变更。

  • 向 Data API 实时架构中添加了 minutesAgo 维度,可用于对 runRealtimeReport 方法的查询。此维度包含事件收集前经过的分钟数。00 表示当前分钟,01 表示前一分钟。

  • 向 Data API 架构中添加了 googleAdsCreativeId 维度。此维度包含归因于转化事件的 Google Ads 广告素材的 ID。

  • 向 Data API 架构添加了“sessionGoogleAdsCreativeId”维度。此维度包含促成您网站或应用中会话的 Google Ads 广告素材的 ID。

  • 在 Data API 架构中,firstUserCreativeId 维度已重命名为 firstUserGoogleAdsCreativeId。此维度包含首次获取用户的 Google Ads 广告素材的 ID。

2021 年 4 月 9 日 Google Analytics Data API v1 Beta 版已发布。

  • API 端点已更新为 https://analyticsdata.googleapis.com/v1beta

  • runReportrunPivotReportbatchRunReportsbatchRunPivotReports 方法现在接受网址路径的 property 参数中的 Google Analytics 4 媒体资源 ID,而不是请求正文的 entity 字段:

    POST https://analyticsdata.googleapis.com/v1beta/GA4_PROPERTY_ID:batchRunReports
    
  • API 客户端库已更新为使用新的 API 端点。

2021 年 2 月 19 日:分页发生变化。

  • 默认报告响应大小从 10 行事件数据增加到了 1 万行。

  • RunReportRequest 不再支持用于指示尝试检索所有行的 "limit" : -1 值。

  • limit 字段的最大值设为 100000。使用分页功能可检索行数超过 100,000 的报告。

2021 年 2 月 8 日:新增了电子商务维度和指标。

API 架构中新增了电子商务维度和指标:

维度adFormatadSourceNameadUnitNameitemBranditemCategoryitemCategory2itemCategory3itemCategory4itemCategory5itemIditemListIditemListNameitemNameitemPromotionCreativeNameitemPromotionIditemPromotionNameorderCoupontransactionId

指标adUnitExposureaddToCartscartToViewRatecheckoutsecommercePurchasesfirstTimePurchasersitemListClickThroughRateitemListClicksitemListViewsitemPromotionClickThroughRateitemPromotionClicksitemPromotionViewsitemPurchaseQuantityitemRevenueitemViewspublisherAdClickspublisherAdImpressionstotalPurchasers

2021 年 2 月 8 日 添加了新的广告系列维度。

API 架构中新增了以下广告系列维度:campaignIdcampaignNamegoogleAdsAccountNamegoogleAdsAdGroupIdgoogleAdsAdGroupNamegoogleAdsAdNetworkTypesourcetrafficOrigin

2021 年 2 月 8 日 dayOfWeekweek 维度发生了变化。

  • dayOfWeek 维度的值现在从 0(而非 1)开始。

  • week 维度的值现在以 01 开头,并返回一个介于 01 到 53 之间的两位数。每周从星期日开始。1 月 1 日始终在第 01 个星期。

2021 年 1 月 28 日 添加了自定义指标的汇总变体。

媒体资源注册的每个自定义指标都会创建三个 API 指标变体:总和、平均值和计数。

2021 年 1 月 28 日 添加了新的日期/时间维度。

API 架构中新增了以下维度:hournthHournthYeardateHour

2021 年 1 月 28 日:Data API 降低了每次查询的配额令牌消耗量。

Data API 减少了每次查询的配额令牌消耗量。每小时和每天的媒体资源配额令牌的配额限制未更改。

2020-11-09 方法 getUniversalMetadata 已被删除。

已删除 getUniversalMetadata 方法。请使用 getMetadata。移除了每项 API 请求的日期范围上限(1 年)。

2020 年 11 月 2 日 添加了实时报告方法。

如需查看示例,请参阅创建实时报告;如需查看 REST 参考文档,请参阅 runRealtimeReport

2020 年 10 月 19 日:更新了客户端库工件。

更新了客户端库工件,并添加了使用说明和代码示例。

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

2020 年 10 月 8 日 向 API 添加了 getMetadata 方法。

getMetadata 方法会返回适用于指定 GA4 媒体资源 ID 的自定义维度和指标,以及通用元数据。

2020 年 10 月 8 日 报告中提供自定义维度和指标。

如需了解自定义维度和指标的文档,请参阅 API 架构文档。此次更新涵盖事件级范围的自定义维度和指标,以及用户级范围的自定义维度。