API 参考

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

本指南中的各个部分定义了已验证用户配置数据中每种实体类型的请求方法和响应。所有请求均以 REST 格式显示。在每个方法文档页面尾部,您都可以在 API Explorer 中使用“立即试用!”链接以交互式方式试用该请求。

资源类型

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

帐户摘要

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

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

帐户

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

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

网络媒体资源

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

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId 获取用户有权访问的一个媒体资源。
insert POST  /management/accounts/accountId/webproperties 创建一个新的媒体资源。
list GET  /management/accounts/accountId/webproperties 列出用户有权访问的媒体资源。
patch 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/profiles/profileId 删除数据视图(配置文件)。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 获取用户有访问权限的数据视图(配置文件)。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles 创建一个新的数据视图(配置文件)。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles 列出用户有访问权限的数据视图(配置文件)。
patch 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 的相对地址
delete DELETE  /management/accounts/accountId/filters/filterId 删除过滤器。
get GET  /management/accounts/accountId/filters/filterId 返回用户有访问权限的一个过滤器。
insert POST  /management/accounts/accountId/filters 创建一个新过滤器。
list GET  /management/accounts/accountId/filters 列出帐户的所有过滤器
patch 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 获取用户有访问权限的目标。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals 创建一个新目标。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals 列出用户有访问权限的目标。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 更新现有数据视图(配置文件)。此方法支持修补语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 更新现有数据视图(配置文件)。

细分

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

方法 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/entityUserLinks/linkId 将用户从给定的帐户中移除。
insert 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 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 将用户从给定网络媒体资源中移除。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 将新用户添加到给定网络媒体资源。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 列出给定网络媒体资源的网络媒体资源-用户关联。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 更新某个现有用户对给定网络媒体资源的权限。

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

方法 HTTP 请求 说明
除非另有说明,否则 URI 均为 https://www.googleapis.com/analytics/v3 的相对地址
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId 将用户从给定的数据视图(配置文件)中移除。
insert 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/profiles/profileId/profileFilterLinks/linkId 删除一个配置文件过滤器关联。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 返回一个配置文件过滤器关联。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks 创建一个新的配置文件过滤器关联。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks 列出某个配置文件的所有配置文件过滤器关联。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 更新现有的配置文件过滤器关联。此方法支持修补语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 更新现有的配置文件过滤器关联。

要详细了解“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 关联。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks 创建一个网络媒体资源-AdWords 关联。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks 列出给定网络媒体资源的网络媒体资源-AdWords 关联。
patch 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/customMetrics/customMetricId 获取用户有权访问的自定义指标。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics 创建新的自定义指标。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics 列出用户有权访问的自定义指标。
patch 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 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 获取用户有权访问的自定义维度。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions 创建新的自定义维度。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions 列出用户有权访问的自定义维度。
patch 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 的相对地址
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/experiments/experimentId 删除一个实验。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 返回用户有访问权限的一个实验。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments 创建一个新实验。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments 列出用户有访问权限的实验。
patch 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/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 删除非抽样报告。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 返回单个非抽样报告。
insert 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/v3alpha 的相对地址
get GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 获取该用户具有访问权限的再营销受众群体。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences 创建新的再营销受众群体。
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences 列出该用户具有访问权限的再营销受众群体。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 更新现有再营销受众群体。此方法支持修补语义。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 更新现有再营销受众群体。