本文介绍了 YouTube Analytics API 和 YouTube Reporting API 在访问 YouTube 数据分析数据的方式上的异同。本文档旨在帮助您选择适合自己应用的 API。
开发者可以通过这两种 API 来检索 YouTube 数据分析数据。此外，这两种 API 都支持 YouTube 频道所有者和 YouTube 内容所有者，他们各自可以访问一组特定的报告：
-
渠道报告包含指定渠道的用户活动指标。
-
内容所有者报告汇总了与指定的 YouTube 内容所有者相关联的所有频道的指标。例如，唱片公司可以提取一份报告，其中包含该唱片公司所有音乐人的 YouTube 频道的综合统计信息。有些内容所有者报告包含用户活动指标，有些则包含与收入和广告效果相关的指标。
Reporting API 还允许部分内容所有者访问系统管理的广告收入报告。系统管理的报告中的数据只能通过 Reporting API 检索。
所有 YouTube 数据分析请求和 YouTube Reporting API 请求都必须获得所请求数据所属频道或内容所有者的授权。
报告内容
这些 API 检索到的报告包含两种类型的数据：
-
维度是用于汇总数据的常用条件，例如用户活动发生的日期或用户所在的国家/地区。
在报告中，每一行数据都有一个唯一的维度值组合。因此，每行的维度值组合都会充当该行的主键。
-
指标是对用户活动、广告效果或估算收入的各种衡量。用户活动指标包括视频观看次数和评分（顶和踩）等内容。
为您的应用选择合适的 API
- YouTube Analytics API
- YouTube Analytics API 支持实时定向查询，可生成自定义 YouTube 数据分析报告。该 API 提供过滤和排序参数，因此发起调用的应用不需要原生支持这些函数。
每个 API 请求都会指定返回数据的日期范围。您还可以使用该 API 检索每周和每月数据集。因此，发起调用的应用不需要存储检索的数据集，也不需要跨日期范围的汇总统计信息。 - YouTube Reporting API
- YouTube Reporting API 可以检索批量报告，其中包含频道或内容所有者的 YouTube 数据分析数据。它专为可导入大型数据集并提供工具，对数据进行过滤、排序和挖掘其数据而设计。
每份报告都包含一组预定义的字段。开发者使用该 API 安排报告作业，每个作业用于标识 YouTube 应生成的报告。然后，YouTube 会生成可异步下载的每日报告。每个报告包含 24 小时时间段的数据。
此外，YouTube 还会为有权访问 YouTube 创作者工作室中相应报告的内容所有者自动生成一组由系统管理的报告。通过这些报告，您可以编程方式访问广告收入数据。 - 与字幕相关的用户活动
- 播放列表的观众黏度数据
- 适用于内容所有者的估算收入报告（提供 2 种不同的报告）
- 面向内容所有者的资产报告（提供 11 种不同的报告）
支持的报告
下表列出了您可以使用这些 API 检索的不同类型的报告。您可以通过 YouTube Analytics API 获取定位查询，通过 YouTube Reporting API 获取批量报告。
一个 API 中可用的数据在另一个 API 中可能不可用。例如，YouTube Analytics API 可让您每周或每月检索用户活动指标，但 YouTube Reporting API 则要求您自行汇总这些数据。另一方面，YouTube Reporting API 支持内容所有者的资产报告，但是 YouTube Analytics API 中没有这些数据。
| 报告类型 | |
|---|---|
| 视频报告 | 支持频道（查询或批量）和内容所有者（查询或批量）。 视频报告提供与频道的视频或内容所有者的视频相关的所有用户活动的统计信息。例如，这些报告中包含您的视频获得的观看次数。在 YouTube Analytics API 中，一些内容所有者视频报告还包含估算收入和广告效果指标。 |
| 播放列表报告 | 支持频道（查询或批量）和内容所有者（查询或批量）。 播放列表报告可提供与播放列表中出现的视频观看次数密切相关的统计信息。YouTube Reporting API 支持针对播放列表生成观众黏度报告，但 YouTube Analytics API 不支持类似的报告。 |
| 广告效果报告 | 支持内容所有者（查询或批量）。 广告效果报告会针对视频播放期间投放的广告，提供基于展示次数的指标。这些指标统计了每次广告展示，每次视频播放可产生多次展示。 |
| 估算的收入报告 | 支持内容所有者（批量）。 估算收入报告会显示视频从 Google 出售的广告源和非广告来源带来的总收入估算。这些报告还包含一些广告效果指标。请注意，系统管理的报告包含实际收入。 |
| 资产报告 | 支持内容所有者（批量）。 资产报告可提供有关与内容所有者的资产相关联的视频的用户活动指标。如果内容所有者声明某视频与其某项资产相匹配，那么该视频就会被包含在内容所有者的报告中。视频可能是由内容所有者或其他 YouTube 用户上传的。 |
| 系统管理的报告 | 如果内容所有者有权在 YouTube 创作者工作室的报告部分中查看相应的报告，则可以使用此功能。 系统管理的报告可提供通过资产和视频赚取的实际收入数据。另一份报告列出了已声明版权的视频以及与这些视频匹配的资产。请注意，目前并非所有创作者工作室报告都可以在 API 中提供。 注意：YouTube 会自动为有权访问创作者工作室中的相应报告的内容所有者生成由系统管理的报告。因此，检索这些报告的过程与此列表中其他类型的报告不同。如需了解详情，请参阅系统管理的报告文档。 |
主要区别
下表重点介绍了 YouTube 数据分析 API 和报告 API 之间的重要区别。
| 特征 | YouTube Analytics API | YouTube Reporting API |
|---|---|---|
| 处理数据 | 每个 API 请求都会指定要返回的维度和指标，以及要返回数据的时间段。 | 应用安排报告作业。对于每项任务，YouTube 都会生成可异步下载的每日报告。 |
| 日期范围 | 有些 API 报告会指明用户活动发生的日期。其中部分报告支持按月汇总用户活动指标的维度。 | 所有 API 报告都会指明用户活动发生的日期。使用该 API 的应用可实现定期汇总数据的功能。 |
| 过滤数据 | 您可以对报告进行过滤，以便仅包含维度具有特定值的行。该 API 还支持某些仅用作过滤条件的维度，例如大洲和次大陆。 | 此 API 支持批量下载完整的数据集。不支持对仅限过滤条件的维度进行过滤或返回数据。客户端应用会存储下载的数据，并实现自己的功能来过滤数据。 |
| 排序 | 报告可以根据返回的指标值进行排序。某些报告仅支持有限数量的结果。例如，列出某个频道观看次数最多的视频的报告最多会返回 200 行。 | 此 API 支持批量下载完整的数据集。客户端应用可以实现自己的功能来对下载的数据进行排序。 |
| 枚举 | API 报告包含用于标识枚举维度值的文本值，例如“ANDROID”或“CHANNEL”。 | API 报告包含可映射到文本值的整数。 |
| 配额 | API 服务器会对每个查询进行评估以确定其配额费用。有关此方法的详情，请参阅配额使用情况部分。 | 配额使用情况不是问题，因为数据只会检索一次，然后在应用中进行过滤、排序和查询。 |
| 唯一身份报告 |
|
|
| 唯一维度 | 组（仅限过滤条件的维度） 大洲（仅适用于过滤条件的维度） subContinent（仅限过滤条件的维度） 月 isCurated==1（仅限过滤条件的维度） viewsPerPlaylistStart averageTimeInPlaylist |
annotation_id annotation_type asset_id card_id card_type live_or_on_demand subscribed_status subtitle_language |
| 独特指标 | 唯一身份观看者人数 relative 保留政策 viewsPerPlaylistStart averageTimeInPlaylist |
card_click_rate card_clicks card_impressions card_teaser_click_rate card_teaser_clicks card_teaser_playlists estimated_partner_adsense_revenues estimated_partner_adsense_revenues estimated_partner_adsense_revenues 非常有用 saved_partner_6} |
API 之间的命名差异
这两种 API 目前使用不同的命名惯例来识别维度和指标。目前，YouTube Analytics API 的名称使用的是驼峰式大小写形式，而 YouTube Reporting API 的名称使用的是以下划线分隔的名称。
下表列出了这两种 API 用来标识相同的指标和维度的不同名称。在某些情况下，两个名称之间的区别大于将名称从驼峰式大小写形式转换为下划线后得到的差异。例如，YouTube Analytics API 中的 video 维度在 YouTube Reporting API 中名为 video_id。