本文档介绍了 YouTube Analytics API 和 YouTube Reporting API 在提供 YouTube 数据分析数据访问权限方面存在的异同,以便您为自己的应用选择合适的 API。
这两个 API 都可让您检索 YouTube 数据分析数据。此外,这两个 API 都支持 YouTube 频道所有者和 YouTube 内容所有者,他们各自可以访问一组特定的报告:
-
渠道报告包含指定渠道的用户活动指标。
-
内容所有者报告会汇总与指定 YouTube 内容所有者关联的所有频道的指标。例如,唱片公司可以检索报告,查看公司所有音乐人的 YouTube 频道的综合统计信息。部分内容所有者报告包含用户活动指标,而其他报告则包含与收入和广告效果相关的指标。
此外,部分内容所有者还可以通过 Reporting API 访问系统管理的广告收入报告。系统管理的报告中的数据只能通过 Reporting API 进行检索。
所有 YouTube Analytics 和 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 创作者工作室中查看相应报告的内容所有者自动生成一组由系统管理的报告。这些报告支持以程序化方式访问广告收入数据。
支持的报告
下表列出了您可以使用 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 Analytics API 与 YouTube Reporting API 之间的重要区别。
功能 | YouTube Analytics API | YouTube Reporting API |
---|---|---|
检索数据的流程 | 每个 API 请求都会指定要返回的维度和指标,以及要返回数据的时间段。 | 应用安排报告作业。对于每个作业,YouTube 都会生成每日报告,您可以异步下载这些报告。 |
日期范围 | 部分 API 报告会指定用户活动发生的日期。其中一些报告支持按月汇总用户活动指标的维度。 | 所有 API 报告都会指明用户活动发生的日期。使用该 API 的应用可以实现相关功能,以按周期性间隔汇总数据。 |
过滤数据 | 您可以过滤报告,使其仅包含某个维度的值为特定值的行。该 API 还支持一些仅用作过滤条件的维度,例如 continent 和 subContinent。 | 该 API 支持批量下载完整的数据集。它不支持过滤,也不支持返回仅限过滤的维度的数据。客户端应用存储下载的数据,并实现自己的功能来过滤数据。 |
排序 | 报告可以根据返回的指标值进行排序。某些报告仅支持有限数量的结果。例如,列出频道观看次数最多的视频的报告最多会返回 200 行。 | 此 API 支持批量下载完整的数据集。客户端应用可以实现自己的功能来对下载的数据进行排序。 |
枚举 | API 报告包含文本值(例如“ANDROID”或“CHANNEL”),用于标识枚举的维度值。 | API 报告包含可映射到文本值的整数。 |
配额 | API 服务器会评估每个查询,以确定其配额费用。配额用量部分更详细地介绍了相关方法。 | 配额使用情况不是问题,因为数据只检索一次,然后在应用内进行过滤、排序和查询。 |
唯一身份用户报告 |
|
|
唯一维度 | group(仅限过滤的维度) continent(仅限过滤的维度) subContinent(仅限过滤的维度) month viewsPerPlaylistStart averageTimeInPlaylist |
annotation_id annotation_type asset_id card_id card_type live_or_on_demand subscribed_status subtitle_language |
唯一身份用户指标 | uniques relativeRetentionPerformance viewsPerPlaylistStart averageTimeInPlaylist |
card_click_rate card_clicks card_impressions card_teaser_click_rate card_teaser_clicks card_teaser_impressions estimated_partner_adsense_revenue estimated_partner_doubleclick_revenue playlist_saves_added playlist_saves_removed |
API 之间的命名差异
这两个 API 使用不同的命名惯例来标识维度和指标。YouTube Analytics API 名称采用驼峰式命名法,例如 adType
。YouTube Reporting API 名称采用小写形式,并使用下划线,例如 ad_type
。
下表列出了这两个 API 用于标识相同指标和维度的不同名称。在某些情况下,这两个名称之间的差异比将名称从驼峰式大小写转换为下划线格式后得到的差异更大。例如,YouTube Analytics API 中的 video
维度在 YouTube Reporting API 中称为 video_id
。