本页列出了频道所有者可以使用 YouTube Analytics API 检索的报告。频道报告提供指定频道的用户活动指标,并衡量视频观看次数、评分和订阅人数等数据。
检索报告
如需检索渠道报告,您必须在 API 请求中将 ids
参数值设置为以下值之一:
-
channel==MINE
- API 会返回经过身份验证的用户的 YouTube 频道的数据。
-
channel==CHANNEL_ID
- 将 CHANNEL_ID
设置为您要检索数据的渠道的唯一渠道 ID。授权请求的用户必须是频道的所有者。
频道 ID 目前是以字母 UC
开头的字符串,但其格式可能会发生变化。(您可以在 YouTube 频道的高级账号设置页面上找到频道的 ID,也可以使用 YouTube Data API's channels.list
方法以编程方式检索频道的 ID。)
授权
所有 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 数据分析组和组项。 |
注意:渠道报告目前不支持估算收入和广告效果指标。因此,https://www.googleapis.com/auth/yt-analytics-monetary.readonly
范围目前不会授予对这些报告中的货币数据的访问权限。
过滤条件
说明受支持的报告的表格会指明可用于每份报告的过滤条件。在表格中,括号中显示的过滤条件是可选的。例如,对于过滤选项 video(,country)
,视频过滤条件是必需的,而国家/地区过滤条件是可选的。
该 API 还支持为 video
和 playlist
过滤条件指定多个值。如果您确实为其中一个过滤条件指定了多个值,还可以将该过滤条件添加到您为请求指定的维度列表中。即使过滤条件未列为特定报告的受支持维度,也是如此。
如需详细了解如何按特定值或一组值过滤 API 结果,请参阅 filters
参数定义。
了解报告表格
本部分介绍了用于定义 API 支持的报告的表格中所用的格式和术语。下表列出了使用时间维度和 averageViewPercentage 指标时,播放详情视频报告支持的维度、指标和过滤条件。
该表包含两行维度、一行指标和三行过滤器。对于维度和过滤条件,只要组合符合表中的使用规则,API 请求中就可以包含每一行的值。因此,举例来说,此报告的有效 dimensions
参数值包括:
dimensions=day
dimensions=day,subscribedStatus
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
不过,参数值 day,month
无效,因为它使用了两个基于时间的维度,而请求必须使用 0 或 1。
报告表格术语
表格使用以下术语来指明维度是必需的还是可选的:
- 以下术语表示需要提供值:
- 必需:您必须添加相应值。
- 使用 1 个:您必须包含该组中的一个值。
- 使用 1 个或多个:您可以包含群组中的任意值或所有值,但必须至少包含一个值。
- 以下术语表示值是可选的:
- 可选:您可以选择是否包含该值。
- 使用 0 或 1:您可以选择包含该组中的一个值。
- 使用 0 个或更多个:您可以选择包含组中的任意值或所有值。
视频报告
基本统计数据
基本用户活动统计信息
此报告提供与用户在频道中的操作相关的统计信息。您可以过滤报告,以仅返回特定视频或国家/地区的数据。
美国各州的基本用户活动统计信息
此报告提供美国特定州或哥伦比亚特区的统计信息。请注意,此报告仅支持上述特定国家/地区报告中的部分指标。
基于时间
特定时间段内按国家/地区统计的用户活动
此报告提供与特定时间间隔内用户在频道中的操作相关的统计信息。您可以过滤报告,以仅返回特定视频或国家/地区的数据。
美国各州在特定时间段内的用户活动
此报告提供与美国特定州或哥伦比亚特区的用户活动相关的统计信息。请注意,此报告仅支持上述特定国家/地区报告中的部分指标。
用户地理位置
按国家/地区划分的用户活动
此报告按国家/地区提供与频道用户活动相关的统计信息。您可以过滤报告,使其仅返回特定视频的数据。
用户活动(按省份)
此报告提供美国各州和哥伦比亚特区的用户活动统计信息。
对于此报告,您必须将 filters
参数值设置为 country==US
。
按城市统计的用户活动(最多 250 个结果)
注意:此报告要求您将 maxResults
参数设置为不高于 250
的整数值。与大多数其他报告不同,此报告还要求您为 sort
请求参数指定一个值。
此报告按城市提供用户活动统计信息。
按 DMA 划分的用户活动
此报告按指定市场区域 (DMA) 提供用户活动统计信息。对于此报告,您必须将 filters
参数值设置为 country==US
,或者过滤到特定省份(美国州)。
播放详情
播放详情报告提供与以下观看属性相关的统计信息:
- 观看的是直播视频还是点播视频?
- 观看者是否订阅了视频所属的频道?
- 观看发生在哪个 YouTube 产品上?
注意:liveOrOnDemand 维度和过滤条件不能与 averageViewPercentage 指标搭配使用。因此,以下各子部分分别列出了两份报告。一个报告支持 liveOrOnDemand 维度(和过滤条件),而另一个报告支持 averageViewPercentage 指标。
按订阅状态划分的用户活动
此报告提供订阅观看者和未订阅观看者的用户活动指标。统计数据可按时间段(天或月)分组,报告还可以按国家/地区、大洲或subContinent进行过滤。
各省份的用户活动(按订阅状态)
此报告提供美国各州或哥伦比亚特区订阅观看者和未订阅观看者的用户活动指标。此报告支持的指标比之前的报告少。
包含可选时间维度的播放详情
对于这些报告,时间维度(天或月)是可选的,因为无论如何,您都需要使用 startDate
和 endDate
请求参数来指定报告将涵盖的日期范围。如果存在此维度,则表示您希望报告中的数据按天、月等进行汇总。
此报告提供特定时间间隔的播放详细统计信息。它支持 liveOrOnDemand 维度(和过滤条件)。
此报告提供特定时间间隔的播放详细统计信息。它支持 averageViewPercentage 指标。
按国家/地区划分的播放详情
此报告按国家/地区提供播放详细统计信息。它支持 liveOrOnDemand 维度(和过滤条件)。
以下报告与上一个报告类似。它增加了对 averageViewPercentage 指标的支持,但不支持将 liveOrOnDemand 用作维度或过滤条件。
各省的播放详情
此报告提供美国各州和哥伦比亚特区的播放详细统计信息。它支持 liveOrOnDemand 维度(和过滤条件)。
以下报告与上一个报告类似。它增加了对 averageViewPercentage 指标的支持,但不支持将 liveOrOnDemand 用作维度或过滤条件。
播放位置
视频播放位置报告
此报告提供与发生视频播放的网页或应用类型相关的统计信息。
播放位置详情 (最多 25 个结果)
注意:此报告要求您将 maxResults
参数设置为不高于 25
的整数值。与大多数其他报告不同,此报告还要求您为 sort
请求参数指定一个值。
此报告会显示哪些嵌入式视频播放器为频道的视频带来了最多的观看次数或观看时长。
流量来源
流量来源
此报告会根据观看者观看您视频内容的方式汇总观看统计信息。例如,它可以确定来自 Google 搜索或相关视频链接的观看次数。
注意:如果查询的视频数量与日期范围内的天数的乘积超过 50,000,此报告会返回错误。例如,检索 500 个视频 ID 的数据的查询最多可以请求 100 天的数据。如需减少请求返回的行数,请将查询拆分为多个查询,每个查询指定较少的视频或设置较短的日期范围。
流量来源详细信息(最多 25 个结果)
注意:此报告要求您将 maxResults
参数设置为不高于 25
的整数值。与大多数其他报告不同,此报告还要求您为 sort
请求参数指定一个值。
此报告会根据为频道内容带来最多观看次数的引荐来源网址汇总观看统计信息。引荐来源网址按流量来源类型进行分类,insightTrafficSourceDetail 维度的定义指明了哪些流量来源可用于生成报告。例如,如果您将 insightTrafficSourceType 过滤条件设置为 ADVERTISING
,报告将列出为频道内容带来最多观看次数或观看时长的广告类型。
注意:此报告仅支持特定流量来源。VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
和 NO_LINK_EMBEDDED
流量来源是不受支持的流量来源。
设备类型和操作系统
设备类型
此报告会根据观看者观看您视频内容的方式汇总观看统计信息。例如,它可以识别在移动设备或游戏机上发生的观看次数。
操作系统
此报告会根据观看者的操作系统汇总观看统计信息。例如,它可以识别在 Android 设备或 PlayStation 上发生的观看次数。
操作系统和设备类型
此报告会根据观看者的操作系统和设备类型汇总观看统计信息。例如,它可以确定在 Android 平板电脑或 Windows 桌面设备上发生的观看次数。
观看者受众特征
此报告会根据观看者的年龄段和性别汇总观看统计信息。
互动和内容分享
此报告提供的统计信息显示了频道视频在不同社交平台上的分享频率。
观众黏度
此报告用于衡量视频在吸引观众方面的表现,还会显示视频特定部分的观看频率。elapsedVideoTimeRatio
维度用于衡量相应指标值所对应的视频播放时长。这些指标可分为两类:
-
观众黏度
这些指标可显示视频对观众的吸引力。
-
精细的观看统计信息
这些指标提供有关视频特定部分观看次数的信息。
注意:此报告不支持为 video
过滤条件指定以英文逗号分隔的值列表;该值必须指定单个视频 ID。
同时观看人数(针对直播)
此报告会显示单个直播视频在给定位置的同时观看人数。
过滤条件指定视频。位置维度通常表示单个分钟。
热门视频
注意:对于这些报告,您需要将 maxResults
参数设置为不大于 200
的整数值。2013 年 1 月 1 日之前的数据仅适用于前 10 个视频。与大多数其他报告不同,这些报告还要求您为 sort
请求参数指定一个值。
包含可选地区过滤条件的热门视频(最多 200 个结果)
此报告会列出频道的热门视频。您可以过滤报告,按国家/地区、洲或subContinent列出热门视频。
各州的热门视频(最多 200 个结果)
此报告会列出频道在美国特定州或哥伦比亚特区最热门的视频。请注意,此报告仅支持上述特定国家/地区报告中的部分指标。
面向订阅者或非订阅者的热门视频(最多 200 个结果)
此报告会列出频道中订阅者或非订阅者观看次数最多的视频。您可以过滤报告,按国家/地区、洲或subContinent列出热门视频。之前的报告可让您检索美国特定州内订阅者或非订阅者观看次数最多的视频,但它支持的指标比此报告少。
按 YouTube 产品划分的热门视频(最多 200 个结果)
此报告列出了频道的热门视频,并支持播放详情和地理位置过滤条件。此报告与前一种报告类似,但支持的指标较少,并添加了对 youtubeProduct 过滤器的支持。
包含播放详情过滤条件的热门视频(最多 200 个结果)
此报告列出了频道的热门视频,并按以下任意一个或所有播放详情维度进行过滤:liveOrOnDemand、subscribedStatus 和 youtubeProduct。与之前的报告不同,此报告支持 liveOrOnDemand 过滤条件,但不支持 averageViewPercentage 指标。
播放列表报告
播放列表报告包含与频道所有者的播放列表中的视频相关的用户活动指标。这些报告有两个版本,对于每个可用的报告,以下部分都包含对每个版本的说明:
汇总视频指标
这些指标提供用户活动和展示指标,这些指标是针对播放列表中的所有视频(这些视频也归播放列表所属的频道所有)汇总的。聚合中不会计算其他频道所拥有的视频的指标。因此,如果某个频道创建的播放列表仅包含其他频道拥有的视频,则这些播放列表的报告不会提供这些指标的值。
如需查看 YouTube 支持的汇总视频指标列表,请参阅支持的播放列表指标部分。
播放列表内指标
这些指标反映了用户在播放列表页面上的活动和互动情况。这些指标会纳入播放列表中所有视频的观看次数,无论这些视频归哪个频道所有,但只会统计在播放列表环境中发生的观看次数。
支持的播放列表指标
基本统计数据
此报告提供与用户在频道播放列表中的视频上的互动相关的统计信息。您可以过滤报告,使其仅返回特定播放列表的数据。
基于时间
此报告提供与用户在频道播放列表中的视频上的互动相关的统计信息。您可以过滤报告,使其仅返回特定播放列表的数据。
用户地理位置
按国家/地区统计的播放列表活动
此报告提供与特定国家/地区的用户在频道播放列表中与视频的互动相关的统计信息。
各省份的播放列表活动
此报告提供美国各州和哥伦比亚特区的播放列表活动统计信息。
对于此报告,您必须过滤结果,以便仅返回美国的数据。
播放位置
此报告提供与播放列表视频的播放发生所在的网页或应用类型相关的统计信息。
播放位置详情 (最多 25 个结果)
注意:此报告要求您将 maxResults
参数设置为不高于 25
的整数值。与大多数其他报告不同,此报告还要求您为 sort
请求参数指定一个值。
此报告可识别为频道播放列表中的视频带来最多观看次数或观看时长的嵌入式视频播放器。
流量来源
此报告会根据观看者访问播放列表内容的方式汇总观看统计信息。
例如,它可以确定来自 Google 搜索的观看次数。
流量来源详细信息(最多 25 个结果)
注意:此报告要求您将 maxResults
参数设置为不高于 25
的整数值。与大多数其他报告不同,此报告还要求您为 sort
请求参数指定一个值。
此报告会根据为频道播放列表中的视频带来最多观看次数的引荐来源网址汇总观看统计信息。引荐来源网址按流量来源类型进行分类,insightTrafficSourceDetail 维度的定义用于标识报告可用的流量来源。
例如,如果您将 insightTrafficSourceType 过滤条件设置为 ADVERTISING
,报告将列出为频道播放列表带来最多观看次数或观看时长的广告类型。
注意:此报告仅支持特定流量来源。VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
和 NO_LINK_EMBEDDED
流量来源是不受支持的流量来源。
设备类型和操作系统
设备类型
此报告会根据观看者观看播放列表中的视频的方式汇总观看统计数据。例如,它可以识别在移动设备或游戏机上发生的观看次数。
操作系统
此报告会根据观看者的操作系统汇总观看统计信息。例如,它可以识别 Android 设备或 PlayStation 上发生的观看次数。
操作系统和设备类型
此报告会根据观看者的操作系统和设备类型汇总观看统计信息。
例如,它可以确定在 Android 平板电脑或 Windows 桌面设备上发生了多少次观看。
观看者受众特征
表现最好的播放列表
注意:对于这些报告,您需要将 maxResults
参数设置为不大于 200
的整数值。2013 年 1 月 1 日之前的数据仅适用于前 10 个播放列表。与大多数其他报告不同,这些报告还要求您为 sort
请求参数指定一个值。
此报告会根据指定的过滤和排序条件列出频道的热门播放列表。
会员报告
会员资格取消
此报告提供的统计信息显示了用户取消频道会员资格的原因。
注意:广告效果报告需要授权令牌,该令牌授予对 https://www.googleapis.com/auth/yt-analytics-monetary.readonly
范围的访问权限。
广告效果报告提供的是视频播放期间投放的广告的基于展示次数的指标。这些指标会统计每次广告展示,每次视频播放可能会产生多次展示。
基于展示次数的广告效果指标包括:
此外,部分视频报告支持以下基于播放的广告效果指标。不过,这些指标不会包含在广告效果报告中。