Introduction

本文档介绍了 YouTube 数据分析 API 和 YouTube 报告 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 创作者工作室中相应报告的内容所有者生成一组由系统管理的报告。这些报表让您能够以程序化方式获取广告收入数据。

支持的报告

下表列出了您可以使用 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 数据分析 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 报告包含“枚举”或“CHANNEL”等文本值,用于标识枚举的维度值。 API 报告包含可映射到文本值的整数。
配额 API 服务器会评估每个查询,以确定其配额费用。配额使用部分更详细地介绍了具体方法。 配额使用情况不会造成问题,因为应用只检索一次数据,然后在应用内对数据进行过滤、排序和查询。
唯一身份报告
  • 与字幕相关的用户活动
  • 播放列表的观众黏度数据
  • 面向内容所有者的估算收入报告(提供了 2 个不同的报告)
  • 面向内容所有者的素材资源报告(提供 11 种不同的报告)
唯一维度 (仅过滤维度)
(仅过滤维度)
次大陆(仅过滤维度)

isCurated==1(仅过滤维度)
viewsPerPlaylistStart
averageTimeInPlaylist
annotation_id
annotation_type
asset_id
card_id
card_type
live_or_on_demand
subscribed_status
subtitle_language
特有的指标 唯一身份用户
Relative 留存率 Performance
viewsPerPlaylistStart
averageTimeInPlaylist

API 之间的命名差异

这两个 API 目前使用不同的命名惯例来识别维度和指标。目前,YouTube 数据分析 API 名称使用驼峰式大小写,而 YouTube Reporting API 名称使用下划线分隔。

下表列出了两个 API 用于标识同一指标和维度的不同名称。在某些情况下,两个名称之间的差异大于将名称从驼峰式大小写转换为下划线后得到的值。例如,YouTube Analytics API 中的 video 维度在 YouTube Reporting API 中的名称为 video_id

尺寸

YouTube 数据分析 API 名称 YouTube Reporting API 名称
广告类型 广告类型
ageGroup 年龄段
资产 asset_id
受众群体类型 audience_retention_type [受众群体类型]
channel channel_id
claimedStatus claimed_status
contentOwner content_owner_id
country 国家/地区代码
日期
设备类型 设备类型
elapsedVideoTimeRatio elapsed_video_time_percentage
性别 性别
insightPlaybackLocationDetail playback_location_detail
insightPlaybackLocationType playback_location_type
insighttrafficSourceDetail traffic_source_detail
insighttrafficSourceType traffic_source_type
liveOrOnDemand 直播或点播
操作系统 operating_system
播放列表 playlist_id
province 省份代码
sharingService 分片服务
subscribedStatus subscribed_status
subtitleLanguage subtitle_language
uploaderType uploader_type
视频 video_id

指标

YouTube 数据分析 API 名称 YouTube Reporting API 名称
adRevenue(广告收入) 估算收入
annotationImpressions annotation_impressions
annotationClickableImpression annotation_clickable_impressions
annotationClicks annotation_clicks
annotationClickThroughRate annotation_click_through_rate
annotationClosableImpressions annotation_closable_impressions
annotationCloses annotation_closes
annotationCloseRate annotation_close_rate
audienceWatchRatio audience_retention_percentage
averageViewDuration average_view_duration_seconds
averageViewPercentage average_view_duration_percentage
cardClickRate card_click_rate
cardClicks card_clicks
cardImpressions 卡片展示次数
cardTeaserClickRate card_teaser_click_rate
cardTeaserClicks card_teaser_clicks卡片
cardTeaserImpressions card_teaser_impressions
评论 评论
收入 估算收入
EstimateddMinutesWatched watch_time_minutes
估算的合作伙伴 AdSense 收入 估算收入
估算收入 估算收入
总收入 estimated_youtube_ad_revenue
impressionCC 每千次展示每千次展示费用
展示次数 广告展示次数
monetizedPlaybacks estimated_monetized_playbacks
基于播放的 CPM Estimated_playback_based_cpm
playlistStarts playlist_starts
savesAdded playlist_saves_added
savesRemoved playlist_saves_removed
分享 分享
订阅人数 subscribers_gained
subscribersLost subscribers_lost
videosAddedToplaylist videos_added_to_playlists
videoRemovedFromplaylist video_removed_from_playlist
viewerPercentage 观看次数百分比
观看次数 观看次数