API Reference

借助 YouTube Analytics API，您可以检索 YouTube 频道或内容所有者的 YouTube 数据分析数据。该 API 支持实时查询，并根据 API 请求参数生成报告。

该 API 支持两种类型的函数：

  • 报告检索 - API 的 reports.query 方法用于检索 YouTube 数据分析报告。

  • YouTube 数据分析群组管理 - YouTube 数据分析群组是一个由频道、视频、播放列表或资产组成的自定义集合，最多可包含 500 项内容。该 API 支持多种创建、检索和更新 YouTube 数据分析组的方法。然后，频道和内容所有者可以使用 reports.query 方法检索组中所有项的汇总数据，这有助于分析效果。

本页简要介绍了用于启用这些功能的 API 资源和方法。

授权

所有 YouTube Analytics API 请求都必须获得授权。授权指南介绍了如何使用 OAuth 2.0 协议检索授权令牌。

YouTube 数据分析 API 请求使用以下授权范围：

范围
https://www.googleapis.com/auth/yt-analytics.readonly 查看 YouTube 分析工具为您的 YouTube 内容出具的报告。此范围可让您访问用户活动指标，例如观看次数和评分次数。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly 查看 YouTube 分析工具为您的 YouTube 内容出具的财务报告。此范围可让您访问用户活动指标以及估算的收入和广告效果指标。
https://www.googleapis.com/auth/youtube 管理您的 YouTube 账号。在 YouTube Analytics API 中，频道所有者使用此范围来管理 YouTube 数据分析组和组项。
https://www.googleapis.com/auth/youtubepartner 查看和管理您在 YouTube 上的 YouTube 资产和关联内容。在 YouTube Analytics API 中，内容所有者使用此作用域来管理 YouTube 数据分析组和组项。

报告检索

借助该 API 的 reports.query 方法，您可以检索许多不同的 YouTube 数据分析报告。每个请求都使用查询参数来指定渠道 ID 或内容所有者、开始日期、结束日期以及至少一个指标。您还可以提供其他查询参数，例如维度、过滤条件和排序说明。

方法 HTTP 请求 说明
相对于 https://youtubeanalytics.googleapis.com/v2 的 URI
query GET /reports 检索 YouTube 数据分析报告。每个 API 请求都使用查询参数来指定渠道 ID 或内容所有者、开始日期、结束日期以及至少一个指标。您还可以提供其他查询参数，例如维度、过滤条件或排序说明。
  • 指标是用户活动的各项衡量结果，例如视频观看次数或评分（赞和踩）。
  • 维度是用于汇总数据的常用条件，例如用户活动发生的日期或用户所在的国家/地区。在报告中，每行数据都有唯一的维度值组合。
  • 过滤器是维度值，用于指定要检索的数据。 例如，您可以检索特定国家/地区、特定视频或一组视频的数据。
受支持的渠道报告和内容所有者报告列表定义了指标、维度和过滤条件的有效组合。

群组管理

该 API 提供了两个用于创建和管理 YouTube 数据分析组的资源：

社区

group 资源代表 YouTube 数据分析群组，这是一种自定义集合，最多可包含 500 个频道、视频、播放列表或资产。

群组中的所有项都必须代表同一类型的资源。例如，您无法创建包含 100 个视频和 100 个播放列表的群组。

Google Analytics 群组只能包含您上传或声明的资源，或者与您管理的频道相关联的资源。因此，频道所有者可以创建视频和播放列表的群组。内容所有者可以创建视频、播放列表、频道或资产群组。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://youtubeanalytics.googleapis.com/v2 的 URI
list GET /groups 返回与 API 请求参数匹配的群组列表。例如，您可以检索已通过身份验证的用户拥有的所有群组，也可以按唯一 ID 检索一个或多个群组。
insert POST /groups 创建 YouTube 数据分析组。创建组后，使用 groupItems.insert 方法向组中添加项。
update PUT /groups 修改组的元数据。目前，唯一可更新的属性是群组的标题。（使用 groupItems.insert 和 groupItems.delete 添加和移除组项。）
delete DELETE /groups 删除组。

GroupItems

groupItem 资源表示 YouTube 数据分析组中的项。

如需详细了解此资源，请参阅其资源表示形式和属性列表。

方法 HTTP 请求 说明
相对于 https://youtubeanalytics.googleapis.com/v2 的 URI
list GET /groupItems 返回与 API 请求参数匹配的组项集合。
insert POST /groupItems 创建组件项。
delete DELETE /groupItems 从分组中移除内容。