Google Analytics(分析)Management API 变更日志

为了提供新功能并修复以前版本中发现的缺陷,我们会定期更新 Google Analytics(分析)Management API。在大多数情况下,这些更改将对 API 开发人员公开。不过,有时我们所作的更改需要开发人员修改其现有应用。

本页记录了有可能影响您的应用的所有 Google Analytics(分析)Management API 更改。我们建议 API 开发者定期查看此列表,及时了解最新信息。您还可以通过下文订阅一节中列出的 Feed 订阅变更内容。

订阅相关变更日志

包括所有数据收集、配置和报告 API。

包括 Management API 和 Provisioning API。

Management API 中的用户数据保留设置

现在,可以使用 WebProperty 资源中新增的“dataRetentionTtl”和“dataRetentionResetOnNewActivity”字段以编程方式配置用户数据保留设置。

Management API 中的写入操作

Management API 中针对网站媒体资源、数据视图(配置文件)和目标资源的写入操作(例如,create、update、delete、patch)不再需要列入白名单。Management API 中所有写入操作的默认每日限制为每天 50 次写入。如需了解详情,请参阅限制和配额页面。

自定义指标

这是一个问题修复版本;此版本修复了在未设置 min_value 时无法创建类型为 TIME自定义指标的问题。现在,在未设置 min_value 时发出请求可创建自定义指标,其中 min_value 默认为 0

非抽样报告

Unsampled Reports API 不再具有每天 100 份报告的限制。该 API 使用与通过网页界面创建非抽样报告时相同的每媒体资源、每一天令牌系统。

非抽样报告

对于当前用户无法访问的非抽样报告,我们将不再在 Management API 响应消息中提供相应的下载链接。此行为现在与界面信息中心功能一致(在界面信息中心只有报告所有者才能看到已生成文档的下载链接)。

数据视图(配置文件)

此版本为数据视图(配置文件)资源新增了 botFilteringEnabled 属性。此属性可指明是否为数据视图(配置文件)启用了漫游器过滤。如需了解详情,请参阅数据视图(配置文件)参考文档

非抽样报告

此版本为非抽样报告新增了 delete 方法。如需了解详情,请参阅“非抽样报告:delete”参考文档

路段

这是一个问题修复版本;此版本修复了以下问题:在调用细分 list 方法时会导致包含定义中货币值的细分错误地显示。

路段

这是一个问题修复版本;此版本修复了以下问题:在调用细分 list 方法时,会导致将非公开细分固定到多个数据视图(配置文件)的用户获得 500 错误响应。

批量处理

在此版本中,除了常规的批量处理支持之外,我们还新增了对 User Permissions API 的特殊支持。批量处理用户权限请求将获得显著的性能提升,同时减少了配额使用量。

数据视图(配置文件)

在此版本中,数据视图(配置文件)currency 属性现在默认为 USD(如果执行 insert 操作时未设置该属性)。此外,针对之前未使用 currency 属性创建的数据视图(配置文件)执行 getlist 操作也将返回 USD。

过滤条件

在此版本中,已弃用的过滤器字段 IS_MOBILEIS_TABLET 最终被移除,并应替换为 DEVICE_CATEGORY=mobileDEVICE_CATEGORY=tablet。将过滤器字段设置为使用 IS_MOBILEIS_TABLET 的 insert、update 和 patch 请求将返回错误。

过滤条件

此版本新增了以下支持:向所有过滤器详细信息部分添加了 fieldIndex 属性,以便针对过滤器字段使用自定义维度。例如,现在可以使用 "field": "CUSTOM_DIMENSION""fieldIndex": "1" 设置过滤器表达式,以便针对第一个自定义维度进行过滤。

进球数

此版本还解决了使用 "comparisonValue": "0" 创建目标会失败的问题。

  • 如需详细了解如何在 Management API 中使用目标,请参阅目标开发者指南

  • 如需查看目标资源的完整参数列表,请参阅目标参考

在此版本中,dailyUpload 资源最终被停用和移除。dailyUpload 资源已于 2014 年 6 月 20 日被正式弃用;所有费用数据导入现在均应使用“上传”资源完成。

现在,所有集合的 list 方法响应中均包含 items 属性的空列表(如果集合中未包含任何资源)。之前,系统会从响应中省略 items 属性。如需详细了解 Google Analytics(分析)配置数据的查询和响应,请参阅 API 参考文档

新增了 DEVICE_CATEGORY 过滤器字段;IS_MOBILEIS_TABLET 现已弃用。请使用 DEVICE_CATEGORY=mobileDEVICE_CATEGORY=tablet

数据视图(配置文件)资源现在包含 enhancedECommerceTracking 属性,该属性可指明增强型电子商务是已启用 (true) 还是已停用 (false)。

此版本新增了数据导入类型,并弃用了 dailyUpload 资源。

数据导入

如需详细了解如何使用 Management API 将数据导入 Google Analytics(分析)账号,请参阅数据导入开发者指南

上传数量

  • upload 资源现在支持以下上传类型:
    • 广告系列数据
    • 内容数据
    • 费用数据
    • 产品数据
    • 退款数据
    • 用户数据
  • upload 资源新增了 migrateDataImport 方法,用于迁移现有的费用数据 customDataSources

弃用“每日上传”

  • dailyUpload 资源现已弃用!如需详细了解如何改用数据导入功能,请参阅迁移指南
  • dailyUpload 资源将于 6 个月后停用,届时将 uploadType 设置为 analytics#dailyUploads 的任何剩余 customDataSources 均将自动迁移且仅可使用 upload 资源。
  • dailyUpload 资源的现有用户应尽快更新其代码并改用“上传”资源。

此版本新增了两个配置 API。

  • 利用 Management API 中的 AdWords 关联功能,您可以创建、列出、获取、更新、修补和删除 AdWords 账号与 Google Analytics(分析)媒体资源间的关联,以及管理要将哪些数据视图(配置文件)与 AdWords 数据相关联。

过滤器

非抽样报告:Management API

Management API 中新增了一种名为非抽样报告的资源。非抽样报告是一种利用非抽样数据生成的 Google Analytics(分析)(GA) 报告。非抽样报告目前仅面向 Google Analytics Premium 用户提供。

细分:Management API v2.4 和 Management API v3.0

细分集合进行了以下变更:

  • API 现在支持用户细分和顺序细分。
  • 现在,“细分集合”会返回所有内置和自定义的会话级用户级细分。
  • 细分的 definition 属性将开始使用新的细分语法,其中包括现有会话级细分的定义,这些定义将从 definition: "" 变更为 definition: "sessions::condition::"
  • 细分资源中新增了 type 属性,用于指明细分是 CUSTOM(即由用户在网页界面中创建)还是 BUILT_IN(即由 Google Analytics(分析)提供)。

实验

以下 AdSense 指标现在可以用作优化目标:

  • ga:adsenseAdsClicks - 用户在您的网站上点击 AdSense 广告的次数。
  • ga:adsenseAdsViewed - AdSense 广告浏览量。一个广告单元中可展示多个广告。
  • ga:adsenseRevenue - AdSense 广告带来的总收入。

新增了“账号摘要”集合

  • Management API 中新增了 AccountSummaries 集合。该集合提供了授权用户在一个简单快速的请求中有权访问的每个账号、媒体资源和数据视图(配置文件)的相关信息摘要。如需了解详情,请参阅账号摘要开发者指南

由于 ga:isMobilega:isTablet 维度已弃用,因此对默认细分进行了以下变更:

  • 细分 gaid::-11 已从移动设备流量 (Mobile Traffic) 更名为手机和平板电脑流量 (Mobile and Tablet Traffic)。此细分的定义已从 ga:isMobile==Yes 更改为 ga:deviceCategory==mobile,ga:deviceCategory==tablet。请注意,ga:isMobile 之前便包含平板电脑流量,这一点在新定义中得到体现。如果您只想要手机流量而不需要平板电脑流量,可改用新的移动设备流量细分 (gaid::-14)。
  • 细分 gaid::-13 的定义已从 ga:isTablet==Yes 更改为 ga:deviceCategory==tablet。此细分仍表示平板电脑流量
  • 新增了细分 gaid::-14。该细分的名称为移动设备流量 (Mobile Traffic),定义为 ga:deviceCategory==mobile

修复了以下问题:

  • 修复了数据视图(配置文件)的时区信息问题。详细信息:修复此问题之前,在某些情况下,如果在 Management API 中列出数据视图(配置文件),则系统会返回错误的数据视图(配置文件)时区信息。现在,数据视图(配置文件)的时区信息与 Google Analytics(分析)管理界面中设置的信息一致。

此版本针对网络媒体资源、数据视图(配置文件)和目标资源引入了写入操作,并新增了一组包含 3 个支持用户权限管理的资源。

账号设置和配置 API

  • 现在可以创建、更新、修补和删除数据视图(配置文件)。如需详细了解新增的方法,请参阅数据视图(配置文件)参考
  • 现在可以创建、更新和修补网站媒体资源和目标。如需详细了解新增的方法,请参阅网络媒体资源参考目标参考
  • 现在可以使用 get 方法请求单个网站媒体资源、数据视图(配置文件)或目标。
  • 这些功能目前以开发者预览版的形式提供给用户进行小范围测试。如果您有意注册并使用这些功能,可以申请参与测试

Management API 中的用户权限

随着新细分的发布,我们将对细分集合进行以下更改:

  • 所有细分 ID 均将从正整数更改为字母数字字符串。如果您已保存用户的细分 ID,我们建议您进行更新以使用新 ID。
  • 细分集合将仅返回现有的访问级细分。API 目前不支持新的访问者、同类群组和顺序细分。
  • 细分集合将继续返回具有相同负数 ID 的现有默认细分,但目前尚不支持新的默认细分。

此版本为 Webproperty 资源新增了 2 个属性:

  • profileCount - 返回媒体资源的配置文件计数。这样一来,您可以过滤未包含任何配置文件(即 profileCount = 0)的媒体资源。
  • industryVertical - 返回为媒体资源选择的行业/类别。

修复了以下问题:

  • 现在,“配置文件”资源eCommerceTracking 属性与网页界面“管理”部分中的电子商务设置一致。启用电子商务跟踪时返回 true,否则返回 false
  • Webproperty 资源现在包含一个 level 属性,用于指明网站媒体资源是 PREMIUM 还是 STANDARD
  • Management API v3 中新增了一个端点,用于访问和修改实验资源。
  • “配置文件”资源现在包含一个 type 属性,用于确定配置文件是为网站还是为应用配置的。两个可能的值为 WEBAPP

此版本为 Management API 新增了一些实用的错误响应。

  • API 错误响应正文中新增了一些错误代码、原因和相应说明。已针对 Management API 版本 2.4版本 3.0 这两个版本记录了所有代码。

此版本新增了一些数据、更改了现有功能并修复了一个问题。

新数据

  • “高级细分”集合现在包含一个 segmentId 字段,可用于 Data Export API 细分参数。

变更

  • max-results 的数据类型更改成了 integer

  • max-results 的默认值和上限均更改成了 1,000。

bug 修复

  • Google 网站优化工具实验的账号、网络媒体资源和配置文件已不再包含在相应集合中。

此版本新增了 API 的两个版本(其中包含许多新功能),并弃用了旧版本。这些变更会影响您通过 API 请求和处理数据的方式。

版本 3.0

  • 这是我们 API 的最新主要版本,并且不向后兼容。API 的所有后续开发工作都将基于此版本完成。

  • 新数据

    • 事件目标的完整表示形式
    • 内部网络媒体资源 ID,可用于与 Google Analytics(分析)界面建立深层链接
    • 默认网页和网站搜索查询参数的配置文件配置
  • 变更

    • 新增了一项配额政策
    • Google API 控制台集成,以管理 API 访问权限和申请更多配额
    • 新增了对 OAuth 2.0 的支持,我们推荐采用这种新方法向用户授权
    • 新增了一个用于发出请求的网址:https://www.googleapis.com/analytics/v3/management/…
    • 使用 JSON 实现更紧凑的 API 响应
    • 提供了新的 Google API 客户端库,支持更多语言
    • 新增了对 Google Discovery API 的支持

版本 2.4

  • 这是次要版本升级,在大部分情况下与现有的版本 2.3 向后兼容。

  • 变更

    • 新增了一项配额政策
    • Google API 控制台集成,以管理 API 访问权限和申请更多配额
    • 继续对现有授权机制和 OAuth 2.0 提供支持
    • 新增了一个用于发出请求的网址:https://www.googleapis.com/analytics/v2.4/management/…
    • 响应仅采用 XML 格式
    • 不再支持 Google 数据 JavaScript 客户端库
    • 此版本的 XML 输出与版本 2.3 一致,因此其他现有的 Google 数据客户端库将继续正常运行。

弃用

  • 我们宣布将弃用 Management API 的旧版本 2.3。该版本将于 2 个月后停用,之后所有 v2.3 请求都将返回 v2.4 响应。

这是 Google Analytics(分析)Management API 的 Beta 版!

新增了一些 Feed

更新了客户端库

  • Management API 与 Google Analytics(分析)Data Export API 在同一库中发布。更新了 Google 数据 Java 和 JavaScript 库。每种 Feed 均可通过为相应库的 getManagementFeed() 方法指定适当的 Feed URI 来访问。

新文档

  • 在 Google Analytics(分析)开发者文档中新增了一部分,其中介绍了新 Management API 的运作方式。