YouTube Reporting API

借助 YouTube Reporting API，开发者可以安排报告作业，然后下载生成的批量报告。该 API 支持一组预定义的报告，每份报告都包含面向频道或内容所有者的全套 YouTube 数据分析数据。

以下步骤介绍了如何安排报告作业和检索报告：

  1. 调用 reportTypes.list() 方法可检索频道或内容所有者可以检索的报告列表。
  2. 调用 jobs.create() 方法来标识应为频道或内容所有者生成的报告。随后，您可以使用 API 的 jobs.list() 和 jobs.delete() 来检索或更改正在生成的报告列表。
  3. 调用 jobs.reports.list() 方法可检索已针对特定作业生成的一系列报告。响应中的每个资源都包含一个 downloadUrl 属性，用于指定可从中下载报告的网址。
  4. 发送经过授权的 GET 请求，以从下载网址检索报告。

授权

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

YouTube Reporting API 请求使用以下授权范围：

范围
https://www.googleapis.com/auth/yt-analytics.readonly 查看 YouTube 分析工具为您的 YouTube 内容出具的报告。此范围可提供对用户活动指标（例如观看次数和评分次数）的访问权限。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly 查看 YouTube 分析工具为您的 YouTube 内容出具的财务报告。此范围可提供对用户活动指标以及估计收入和广告效果指标的访问权限。

资源类型

以下部分简要介绍了该 API 的资源和方法。表格中显示的所有方法 URI 都是相对于 https://youtubereporting.googleapis.com 的。

作业

方法
create POST /v1/jobs
创建报告作业。创建报告作业后，您即指示 YouTube 每天生成相应报告。报告会在作业创建后的 24 小时内生成。
delete DELETE /v1/jobs/{jobId}
删除报告作业。
get GET /v1/jobs/{jobId}
检索有关已为频道或内容所有者安排的特定报告作业的信息。
list GET /v1/jobs
列出已为频道或内容所有者安排的报告作业。响应中的每个资源都包含一个 id 属性，用于指定 YouTube 用来唯一标识作业的 ID。您需要该 ID 来检索为相应作业生成的报告列表，或删除该作业。

jobs.reports

方法
get GET /v1/jobs/{jobId}/reports/{reportId}
检索特定报告的元数据。
list GET /v1/jobs/{jobId}/reports
列出已为指定报告作业生成的报告。

reportTypes

方法
list GET /v1/reportTypes
返回频道或内容所有者可以检索的报告类型列表。