API Reference

MANAGEMENT API

这是 Management API 3.0 版的参考指南。它提供了与 Google Analytics(分析)配置数据的查询和响应相关的完整详情。如需了解配置数据的概念和结构,请参阅 3.0 版 概览.

本指南中的各个部分针对经过身份验证的用户的配置数据中的一种实体定义了请求方法和响应。所有请求均以 REST 格式显示。在每种方法的介绍页的结尾,您都可以使用“试一试!”链接,在 API Explorer 中以互动的方式试用该请求。

资源类型

  1. 账号摘要
  2. 账号用户关联
  3. 账号
  4. AdWords 关联
  5. 自定义数据源
  6. 自定义维度
  7. 自定义指标
  8. 实验
  9. 过滤条件
  10. 目标
  11. 客户端 ID
  12. 配置文件过滤器关联
  13. 配置文件用户关联
  14. 再营销受众群体
  15. 细分
  16. 非抽样报告
  17. 上传
  18. 数据视图(配置文件)
  19. 网络媒体资源
  20. 网络媒体资源用户关联

帐号摘要

要详细了解“账户摘要”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
list GET  /management/accountSummaries 列出用户有访问权限的帐号摘要(由帐号/媒体资源/配置文件组成的简明树状视图)。

要详细了解“账户用户关联”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/entityUserLinks/linkId 将用户从指定帐号中移除。
插入 POST  /management/accounts/accountId/entityUserLinks 向指定帐号添加新用户,前提是用户的帐号数少于 100 个。
list GET  /management/accounts/accountId/entityUserLinks 列出给定帐号的帐号-用户关联。
update PUT  /management/accounts/accountId/entityUserLinks/linkId 更新现有用户对给定帐号的权限。

账号

如需详细了解账号资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
list GET  /management/accounts 列出用户有访问权限的所有帐号。

要详细了解“AdWords 关联”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 删除一个网络媒体资源-AdWords 关联。
get GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 返回用户有访问权限的一个网络媒体资源-AdWords 关联。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks 创建一个网络媒体资源-AdWords 关联。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks 列出给定网络媒体资源的网络媒体资源-AdWords 关联。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 更新现有的网络媒体资源-AdWords 关联。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 更新现有的网络媒体资源-AdWords 关联。

自定义数据源

要详细了解“自定义数据源”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources 列出用户有权访问的自定义数据源。

自定义维度

有关“自定义维度”资源的详情,请参阅资源表示方法页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 获取用户有权访问的自定义维度。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions 创建新的自定义维度。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions 列出用户有权访问的自定义维度。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 更新现有自定义维度。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 更新现有自定义维度。

自定义指标

有关“自定义指标”资源的详情,请参阅资源表示方法页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId 获取用户有权访问的自定义指标。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics 创建新的自定义指标。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics 列出用户有权访问的自定义指标。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId 更新现有自定义指标。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId 更新现有自定义指标。

实验

要详细了解“实验”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 删除实验。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 返回用户有访问权限的实验。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments 创建新实验。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments 列出用户有访问权限的实验。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 更新一个现有的实验。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 更新现有实验。

过滤器

要详细了解“过滤器”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/filters/filterId 删除过滤条件。
get GET  /management/accounts/accountId/filters/filterId 返回用户有访问权限的一个过滤条件。
插入 POST  /management/accounts/accountId/filters 创建一个新的过滤器。
list GET  /management/accounts/accountId/filters 列出帐号的所有过滤条件
补丁 PATCH  /management/accounts/accountId/filters/filterId 更新现有过滤器。此方法支持补丁语义。
update PUT  /management/accounts/accountId/filters/filterId 更新现有过滤器。

目标

要详细了解“目标”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 获取用户有访问权限的目标。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals 创建一个新目标。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals 列出用户有访问权限的目标。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 更新现有目标。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 更新现有目标。

客户端 ID

有关 Management.clientId 资源的详细信息,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
hashClientId POST  /management/clientId:hashClientId 对给定的客户端 ID 进行哈希处理。

要详细了解“配置文件过滤器关联”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 删除配置文件过滤器关联。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 返回一个配置文件过滤器关联。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks 创建新的配置文件过滤器关联。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks 列出某个配置文件的所有配置文件过滤器关联。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 更新现有的配置文件过滤器关联。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 更新现有的配置文件过滤器关联。

要详细了解“配置文件用户关联”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId 将用户从给定的数据视图(配置文件)中移除。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks 将新用户添加到给定的数据视图(配置文件)。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks 列出给定数据视图(配置文件)的配置文件-用户关联。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId 更新现有用户对给定数据视图(配置文件)的权限。

再营销受众群体

有关再营销受众群体资源的详情,请参阅资源表示方法页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 删除再营销受众群体。
get GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 获取用户有访问权限的再营销受众群体。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences 创建新的再营销受众群体。
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences 列出用户有访问权限的再营销受众群体。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 更新现有再营销受众群体。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 更新现有再营销受众群体。

细分

要详细了解“细分”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
list GET  /management/segments 列出用户有访问权限的细分。

非抽样报告

要详细了解“非抽样报告”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 删除非抽样报告。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 返回单个非抽样报告。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports 创建新的非抽样报告。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports 列出用户有访问权限的非抽样报告。

上传

要详细了解“上传”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
deleteUploadData POST  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData 删除与先前的上传操作相关联的数据。
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId 列出用户有访问权限的上传。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads 列出用户有访问权限的上传。
uploadData POST
https://www.googleapis.com/upload/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads
上传用于自定义数据源的数据。

数据视图(配置文件)

要详细了解“数据视图(配置文件)”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 删除数据视图(配置文件)。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 获取用户有访问权限的数据视图(配置文件)。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/profiles 创建一个新的数据视图(配置文件)。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles 列出用户有访问权限的数据视图(配置文件)。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 更新现有数据视图(配置文件)。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 更新现有数据视图(配置文件)。

网络媒体资源

要详细了解“网络媒体资源”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId 获取用户有访问权限的媒体资源。
插入 POST  /management/accounts/accountId/webproperties 创建一个新的媒体资源。
list GET  /management/accounts/accountId/webproperties 列出用户有权访问的媒体资源。
补丁 PATCH  /management/accounts/accountId/webproperties/webPropertyId 更新现有媒体资源。此方法支持补丁语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId 更新现有媒体资源。

要详细了解“网络媒体资源用户关联”资源,请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 将用户从给定的网络媒体资源中移除。
插入 POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 将新用户添加到给定的网络媒体资源。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 列出给定网络媒体资源的网络媒体资源-用户关联。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 更新现有用户对给定网络媒体资源的权限。