本文档定义了 YouTube Analytics API 支持的维度。此 API 支持实时的针对性查询,可生成自定义 YouTube 数据分析报告。
维度是用于汇总数据的常用条件,例如用户活动发生的日期或用户所在的国家/地区。
每个查询报告都会标识其支持的维度。例如,在按时间检索用户活动时,您可以选择报告数据的时间段:天或月。在任何报告中,每行数据都有一个唯一的维度值组合。
如需检索查询报告,请调用 YouTube Analytics API 的 reports.query
方法。在您的请求中,使用 dimensions
参数指定 YouTube 将用于计算报告中的指标值的维度。
核心维度
尽管 YouTube Analytics API 在使用 服务条款,非核心维度(和非核心指标)不包括在内 。在本页的定义中,任何核心维度都属于 已明确指定。
以下列表列出了该 API 的核心维度。
如需了解详情,请参阅受弃用政策约束的 YouTube API 列表。
过滤条件
所有查询报告都支持过滤条件。过滤条件用于标识检索到的数据集内必须存在的维度值。因此,它们将 API 响应限制为仅包含与特定值或一组值匹配的数据。例如,您可以使用过滤器仅检索特定国家/地区的数据,而不是检索所有国家/地区的用户活动指标。
在检索查询报告的请求中,可选的 filters
请求参数可指定要过滤数据的维度值。例如,如需检索欧洲的用户活动指标,您可以将 filters
参数值设为 continent==150
。
重要提示:检索内容所有者报告的 API 请求必须使用以下任一报告实体维度来过滤数据,或者使用支持的 claimedStatus
和 uploaderType
维度组合来过滤数据。
维度
下面几部分介绍了在 YouTube Analytics API 的查询报告中使用的维度。除非另有说明,否则这些维度会同时用于“频道”报告和“内容所有者”报告中。此外,还将确定只能用作过滤条件的维度。
资源
这些维度与频道和内容所有者在 YouTube 上管理的资源相对应:
注意:当您将 video
、playlist
和 channel
维度用作过滤条件时,该 API 允许您为这些维度指定多个值。为此,请将 filters
参数值设为应过滤 API 响应的视频、播放列表或频道 ID 的列表(以英文逗号分隔)。此参数值最多可指定 500 个 ID。
- 视频(核心维度)
- YouTube 视频的 ID。在 YouTube Data API 中,这是
video
的值 资源的id
属性。This is a core dimension and is subject to the Deprecation Policy. - 播放列表
- YouTube 播放列表的 ID。在 YouTube Data API 中,这是
playlist
资源的id
属性的值。 - 渠道(核心维度)(仅在内容所有者报告中使用)
- YouTube 频道的 ID。在 YouTube Data API 中,这是
channel
资源的id
属性的值。This is a core dimension and is subject to the Deprecation Policy.
内容所有者报告中经常使用channel
维度,因为这些报告通常会汇总多个频道的数据。 - group(仅限过滤条件)
- YouTube 数据分析组的 ID。您可以使用 YouTube Analytics API 的
groups.list
方法来检索此值。当您使用group
过滤条件时,API 响应包含该组中所有视频、播放列表或频道的数据。
示例
以下示例请求使用了报告实体维度或过滤条件:
渠道示例
内容所有者示例
地理区域
这些维度用于确定与用户活动、广告效果或估算收入指标相关联的地理区域。
- 国家/地区(核心维度)
- 与报告行中的指标相关联的国家/地区。维度值是一个由两个字母组成的 ISO-3166-1 国家/地区代码,例如
US
、CN
(中国)或FR
(法国)。国家/地区代码ZZ
用于报告 YouTube 无法识别相关国家/地区的指标。This is a core dimension and is subject to the Deprecation Policy. - province
- 与报告行中的指标相关联的美国州或地区。维度值是用于标识美国各州或哥伦比亚特区的 ISO 3166-2 代码,例如
US-MI
(密歇根州)或US-TX
(得克萨斯州)。省代码US-ZZ
用于报告 YouTube 无法识别美国相关州的指标。 如果 API 请求的dimensions
参数值中包含province
,则该请求还必须通过在filters
参数值中添加country==US
来将数据限制为仅限美国。注意:此维度不支持用于标识美国本土外地区的 ISO 3166-2 值,因为这些地区也有自己的 ISO 3166-1 国家/地区代码。也不支持细分美国以外的国家/地区。
- dma
- Nielsen 用于标识特定媒体市场区域 (DMA) 的 3 位数标识符 与数据行中描述的查看事件相关联。
- city
- 与报告行中的指标相关联的估算城市。系统仅提供 2022 年 1 月 1 日以后的此维度数据。
- 大洲(仅限过滤条件)
-
联合国 (UN) 统计区域代码。该 API 支持以下值:
值 002
非洲 019
美洲(北美洲、拉丁美洲、南美洲和加勒比地区) 142
亚洲 150
欧洲 009
大洋洲 filters
参数设为continent==REGION_CODE
,指定表中的REGION_CODE
值。 - subContinent(仅限过滤器)
-
用于标识地理区域次级区域的联合国统计地区代码。联合国统计司列有子区域及其关联的国家/地区。
此维度只能用于过滤数据。如需使用此维度,请将
filters
参数的值设为subContinent==REGION_CODE
,指定 UN 列表中的一个REGION_CODE
值。
示例
以下示例请求使用了地理位置维度或过滤条件:
渠道示例
- 基本统计信息:频道在特定国家/地区的观看次数(以及其他数据)
-
地理位置
<ph type="x-smartling-placeholder">
- </ph>
- 针对特定国家/地区的频道视频的观看时长指标
- 针对特定国家/地区的频道视频的注释指标
- 美国各州和华盛顿特区各省的具体指标
- 频道播放列表在特定国家/地区的观看时长指标
- 美国观看次数最多的 10 大播放列表
- 播放位置:不同播放位置的每日观看次数和观看时长
- 流量来源:来自某个国家/地区不同流量来源的观看次数和观看时长
- 受众特征:加利福尼亚州的观看者受众特征(年龄段和性别)
-
热门视频
<ph type="x-smartling-placeholder">
- </ph>
- 10 大 – 特定国家/地区观看次数最多的视频
- 10 大 – 欧洲观看次数最多的视频
内容所有者示例
- 基本统计信息:在特定国家/地区统计,所有自己上传的视频的观看次数(和其他数据)
-
地理位置
<ph type="x-smartling-placeholder">
- </ph>
- 具体国家/地区针对自行上传内容的观看时长指标
- 适用于自行上传内容的特定国家/地区注释指标
- 美国各州和华盛顿特区各省的具体指标
- 针对内容所有者的播放列表,在特定国家/地区统计的观看时长指标
- 美国观看次数最多的 10 大播放列表
- 播放位置:不同播放位置的每日观看次数和观看时长
- 受众特征:加利福尼亚州的观看者受众特征(年龄段和性别)
- 热门视频:十大热门视频 - 对内容所有者来说,欧洲观看次数最多的视频
- 收入/广告效果:具体国家/地区的收入和广告效果指标
时间段
这些维度表明报告应按时间段(例如天、周或月)汇总数据。startDate
和 endDate
请求参数指定报告包含数据的时间段。请注意,报告实际返回的数据是截至前一天的数据,在进行查询时,请求中指定的所有指标均可用。在报告中,日期以 YYYY-MM-DD
格式列出。
重要提示:所有日期均指从太平洋时间零点(UTC-7 或 UTC-8)开始,到指定日、月和年的晚上 11:59(太平洋时间)结束的时间段。因此,根据夏令时将时钟正向调整的日期表示 23 小时的时间段,将时钟向后调整的日期表示 25 小时的时间段。
月维度是指从指定月份和年份的第一天的太平洋时间零点(UTC-7 或 UTC-8)开始的时间段。
- (核心维度)
- 使用此维度时,报告中的数据会按天汇总,每行都包含一天的数据。您可以使用其他维度进一步细分数据。例如,流量来源报告可以根据用户到达您视频的方式汇总其每日观看统计信息。This is a core dimension and is subject to the Deprecation Policy.
- 月 (核心维度)
- 报告中的数据是按日历月汇总的。与每日报告一样,您可以使用其他过滤器进一步细分数据。在报告中,日期以
YYYY-MM
格式列出。
注意:如果您的 API 查询使用month
维度,则必须将start-date
和end-date
参数都设置为当月的第一天。This is a core dimension and is subject to the Deprecation Policy.
示例
以下示例请求使用了时间维度或过滤条件:
渠道示例
内容所有者示例
播放位置
通过这些维度,您可以深入了解发生用户活动的网页或应用。
- insightPlaybackLocationType
-
此报告中的数据是按视频播放的网页或应用的类型进行汇总的。此维度可能的值包括:
-
BROWSE
– 这些数据描述的是 YouTube 首页或主屏幕、用户的订阅 Feed 中或其他 YouTube 浏览功能中产生的观看次数。 -
CHANNEL
- 此数据描述的是频道页中产生的观看次数。 -
EMBEDDED
– 表示在其他网站或应用中通过<iframe>
或<object>
嵌入代码嵌入视频的网站或应用上产生的观看次数。 -
EXTERNAL_APP
- 此数据描述的是第三方应用中产生的观看次数,并且相应视频是通过<iframe>
或<object>
嵌入以外的其他方法播放视频的。例如,使用 YouTube Android Player API 的应用中的播放将使用此值进行分类。 -
MOBILE
– 数据表示在 YouTube 的移动网站或已获批准的 YouTube API 客户端(包括移动设备)上产生的观看次数。自 2013 年 9 月 10 日起,YouTube 分析工具报告中不再将播放次数归入“
MOBILE
”类别。由于旧数据仍属于该类别,因此此值可能仍会保留在报告中。但在该日期之后,移动播放被归类为WATCH
、EMBEDDED
或EXTERNAL_APP
播放,具体取决于播放所属的应用的类型。 -
SEARCH
– 此数据描述的是直接在 YouTube 搜索结果页上产生的观看次数。 -
WATCH
– 数据表示在视频的 YouTube 观看页面或 YouTube 官方应用(如 Android 版 YouTube 应用)中产生的观看次数。 -
YT_OTHER
- 数据描述的是未以其他方式分类的视图。
-
- insightPlaybackLocationDetail
- 这些数据是根据玩家所在的页面汇总的。请注意,此报告仅支持在嵌入式播放器中产生的观看次数,它会确定为指定视频带来了最多观看次数的嵌入式播放器。因此,它通过识别与热门嵌入式播放器关联的网址或应用,提供比播放位置报告更精细的视图。
示例
以下示例请求使用了播放位置维度:
渠道示例
-
播放位置
<ph type="x-smartling-placeholder">
- </ph>
- 不同播放位置的观看次数和观看时长
- 不同播放位置的每日观看次数和观看时长
- 十大热门 - 为嵌入视频带来最多观看次数的第三方网站
- 不同播放位置的播放列表观看次数和观看时长
- 不同播放位置的每日播放列表观看次数和观看时长
-
播放位置
<ph type="x-smartling-placeholder">
内容所有者示例
-
播放位置
<ph type="x-smartling-placeholder">
- </ph>
- 不同播放位置的观看次数和观看时长
- 不同播放位置的每日观看次数和观看时长
- 十大热门 - 为嵌入视频带来最多观看次数的第三方网站
- 不同播放位置的播放列表观看次数和观看时长
- 不同播放位置的每日播放列表观看次数和观看时长
-
播放位置
<ph type="x-smartling-placeholder">
播放详情
- creatorContentType
- 此维度用于标识与数据行中用户活动指标相关联的内容类型。系统只提供 2019 年 1 月 1 日至今的此维度数据。
下表列出了维度值:
值 LIVE_STREAM
查看的内容是 YouTube 直播。 SHORTS
查看的内容是 YouTube 短视频。 STORY
查看的内容是 YouTube 短片故事。 VIDEO_ON_DEMAND
观看的内容是不属于其他某个维度值的 YouTube 视频。 UNSPECIFIED
所查看内容的内容类型未知。 - liveOrOnDemand
- 此维度用于指明数据行中的用户活动指标是否与直播观看次数相关。系统提供此维度的数据,最早日期为 2014 年 4 月 1 日。
下表列出了维度值:
值 LIVE
此行的数据描述的是直播期间发生的用户活动。 ON_DEMAND
此行的数据描述了在直播期间未发生的用户活动。 - subscribedStatus
- 此维度用于指明数据行中的用户活动指标是否与订阅了视频或播放列表频道的观看者相关联。
可能的值包括
SUBSCRIBED
和UNSUBSCRIBED
。
请注意,维度值在发生用户活动时是准确的。例如,假设一位用户没有订阅某个频道,但观看了该频道的其中一个视频,然后又订阅了该频道并观看了另一个视频,所有操作均在同一天完成。 频道的报告会指出,一个观看的subscribedStatus
值为SUBSCRIBED
,另一个观看的subscribedStatus
值为UNSUBSCRIBED
。 - youtubeProduct
- 此维度用于标识发生用户活动的 YouTube 服务。系统提供截至 2015 年 7 月 18 日的此维度数据。
下表列出了维度值:
值 CORE
不是在特定 YouTube 应用(YouTube Gaming、YouTube Kids 或 YouTube Music)中发生的用户活动。例外情况:2021 年 3 月 1 日之前在 YouTube Music 中发生的用户活动会计入 CORE
。GAMING
用户活动发生在 YouTube 游戏中。 KIDS
用户活动发生在 YouTube Kids 中。 MUSIC
用户活动发生在 2021 年 3 月 1 日当天或之后在 YouTube Music 中。2021 年 3 月 1 日之前的数据包含在 CORE
中。系统不会记录实时数据。UNKNOWN
用户活动发生在 2015 年 7 月 18 日之前。
流量来源
- insightTrafficSourceType
- 此报告中的数据是按引荐来源类型汇总的,该类型说明了用户访问视频的方式。此维度的可取值包括:
ADVERTISING
- 观看者是通过广告了解到的。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段用于标识通告类型。ANNOTATION
– 观看者通过点击其他视频中的注释到达了视频。CAMPAIGN_CARD
– 观看次数源于已声明版权的用户上传视频,内容所有者用于宣传所查看的内容。只有内容所有者报告支持此流量来源。END_SCREEN
- 观看者是通过另一视频的片尾画面引荐而来。EXT_URL
– 观看者是通过其他网站上的链接发现并观看视频的。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段用于标识网页。此流量来源包括来自 Google 搜索结果的引荐。HASHTAGS
- 源自视频点播 # 标签页面或 Shorts 标签透视页面的观看次数。LIVE_REDIRECT
- 视频观看次数是通过直播跳转引来的。NO_LINK_EMBEDDED
- 用户在观看视频时被嵌入其他网站。NO_LINK_OTHER
– YouTube 没有标识流量的引荐来源。此类别包括视频的直接流量和移动应用上的流量。NOTIFICATION
– 观看者是通过 YouTube 发送的电子邮件或通知发现的。PLAYLIST
– 视频作为播放列表的一部分播放时出现。其中包括来自播放列表页面的流量。PRODUCT_PAGE
- 视频观看源于商品页面。PROMOTED
- 视频观看次数源自免费的 YouTube 宣传,例如 YouTube“热点视频”页面。RELATED_VIDEO
– 观看者是通过其他视频观看页面上的相关视频商品详情发现并观看视频的。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段会指定相应视频的视频 ID。SHORTS
- 观看者是通过在 Shorts 短视频观看体验中从上一个视频垂直滑动而推荐的。SOUND_PAGE
- 源自 Shorts 音效跳转页的观看次数。SUBSCRIBER
– 观看者是通过 YouTube 首页上的 Feed 或 YouTube 订阅功能发现的。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段会指定引荐来源的首页 Feed 项或其他网页。YT_CHANNEL
– 视频观看次数出现在频道页上。如果您根据此流量来源进行过滤,insightTrafficSourceDetail
字段会指定相应频道的频道 ID。YT_OTHER_PAGE
– 观看者是通过链接发现的,而并非搜索结果或 YouTube 页面上显示的相关视频链接。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段用于标识网页。YT_SEARCH
– 观看者是通过 YouTube 搜索结果发现并观看视频的。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段会指定搜索字词。VIDEO_REMIXES
– 观看者通过 Shorts 短视频播放器中的混剪视频链接发现并观看视频。如果您根据此流量来源进行过滤,则insightTrafficSourceDetail
字段会指定观看者是通过哪个视频被引荐而来。
- insightTrafficSourceDetail
- 此报告中的数据是按为指定视频和指定的流量来源类型带来最多观看次数的引荐来源网址进行汇总的。下面的列表列出了可以使用此报告的流量来源。对于每个流量来源,此列表分别标识了“
insightTrafficSourceDetail
”维度提供的信息。ADVERTISING
- 带来观看次数的广告类型。可能的值包括:- 点击播放互动广告
- 互动广告
- Google 搜索广告
- 首页视频广告
- 预留的可跳过的插播广告
- TrueView 搜索广告和展示广告
- TrueView 插播广告
- 未分类的 YouTube 广告
- 平铺视频
CAMPAIGN_CARD
– 已主张版权的视频,引导观看者观看的是报告中所指出的视频。END_SCREEN
– 将观看者引导至报告中所标识视频的视频。EXT_URL
– 将观看者推介给视频的网站。HASHTAGS
- 促成观看次数的 # 标签。NOTIFICATION
- 引荐流量的电子邮件或通知。RELATED_VIDEO
- 将观看者吸引到报告中所涵盖视频的相关视频。SOUND_PAGE
– 带来观看次数的视频。SUBSCRIBER
– 将观看者引向报告所涵盖视频的首页 Feed 项或 YouTube 订阅功能。有效值包括:activity
- 由首页订阅 Feed 中由非上传和非社交类频道活动(包括点赞、收藏、公告帖子和播放列表添加)产生的观看次数。blogged
– 由热门博客中的链接产生的首页订阅 Feed 中商品所获得的观看次数。mychannel
– 由首页列出的其他 Feed 中的商品带来的观看次数(例如“赞过的视频”)。“观看记录”和“稍后观看”podcasts
- 源自播客目标网页中内容的观看次数。sdig
- 源自订阅更新电子邮件的观看次数。uploaded
– 由首页“订阅内容”Feed 中uploaded
项带来的观看次数。/
– 源自 YouTube 首页的其他观看次数。/my_subscriptions
- 源自用户的观看YouTube 上的我的订阅页面。
YT_CHANNEL
– 观看者观看视频时所在的频道页。YT_OTHER_PAGE
– 观看者被引荐到视频的 YouTube 页面。YT_SEARCH
– 将观看者吸引到视频的搜索字词。VIDEO_REMIXES
– 带来观看次数的视频。
示例
以下示例请求使用了流量来源维度:
渠道示例
-
流量来源
<ph type="x-smartling-placeholder">
- </ph>
- 一个国家/地区中不同流量来源的观看次数和观看时长
- 来自不同流量来源的每日观看次数和观看时长
- 前 10 名 – 为视频带来最多流量的 YouTube 搜索字词
- 前 10 大 – 为视频带来最多流量的 Google 搜索字词
- 来自一个国家/地区不同流量来源的播放列表观看次数和观看时长
- 不同流量来源的每日播放列表观看次数和观看时长
-
流量来源
<ph type="x-smartling-placeholder">
内容所有者示例
-
流量来源
<ph type="x-smartling-placeholder">
- </ph>
- 不同流量来源的观看次数和观看时长
- 来自不同流量来源的每日观看次数和观看时长
- 前 10 名 – 为视频带来最多流量的 YouTube 搜索字词
- 前 10 大 – 为视频带来最多流量的 Google 搜索字词
- 来自一个国家/地区不同流量来源的播放列表观看次数和观看时长
- 不同流量来源的每日播放列表观看次数和观看时长
-
流量来源
<ph type="x-smartling-placeholder">
设备
- deviceType
- 此维度用于标识视频播放设备的实际尺寸。
以下列表列出了 API 为其返回数据的设备类型。您还可以使用“
deviceType
”维度作为过滤条件,限制操作系统报告仅包含特定类型设备的数据。DESKTOP
GAME_CONSOLE
MOBILE
TABLET
TV
UNKNOWN_PLATFORM
- operatingSystem
- 此维度用于标识观看设备所在的软件系统。
以下列表列出了该 API 会返回哪些操作系统的数据。您还可以使用
operatingSystem
作为过滤条件,限制设备类型报告仅包含特定操作系统的数据。ANDROID
BADA
BLACKBERRY
CHROMECAST
DOCOMO
FIREFOX
HIPTOP
IOS
KAIOS
LINUX
MACINTOSH
MEEGO
NINTENDO_3DS
OTHER
PLAYSTATION
PLAYSTATION_VITA
REALMEDIA
SMART_TV
SYMBIAN
TIZEN
VIDAA
WEBOS
WII
WINDOWS
WINDOWS_MOBILE
XBOX
示例
以下示例请求使用了设备维度:
渠道示例
-
设备/操作系统
<ph type="x-smartling-placeholder">
- </ph>
- Android 操作系统的每日设备类型指标
- 移动设备的每日操作系统指标
- 每日操作系统和设备类型指标
- Android 操作系统上播放列表观看次数的每日设备类型指标
- 移动设备上的播放列表观看次数的每日操作系统指标
-
设备/操作系统
<ph type="x-smartling-placeholder">
内容所有者示例
-
设备/操作系统
<ph type="x-smartling-placeholder">
- </ph>
- 已主张版权的视频的每日设备类型指标
- 通过移动设备观看且已声明版权的视频的每日操作系统指标
- 每日操作系统和设备类型指标
- Android 操作系统上播放列表观看次数的每日设备类型指标
- 移动设备上的播放列表观看次数的每日操作系统指标
-
设备/操作系统
<ph type="x-smartling-placeholder">
受众特征
受众特征维度可帮助您了解受众群体的年龄段和性别分布情况。YouTube 帮助中心在 YouTube Analytics 报告中提供了有关受众特征数据的更多信息。
- ageGroup(核心维度)
- 此维度用于标识报告数据对应的已登录用户的年龄段。该 API 使用以下年龄段:
- age13-17
- age18-24
- age25-34
- age35-44
- age45-54
- age55-64
- age65-
- gender(核心维度)
- 此维度用于标识报告数据所关联的已登录用户的性别。
有效值为
female
、male
和user_specified
。 This is a core dimension and is subject to the Deprecation Policy.
示例
以下示例请求使用了受众特征维度:
渠道示例
-
受众特征
<ph type="x-smartling-placeholder">
- </ph>
- 加利福尼亚州的观看者受众特征(年龄段和性别)
- 加利福尼亚州的播放列表观看者受众特征(年龄段和性别)
-
受众特征
<ph type="x-smartling-placeholder">
内容所有者示例
-
受众特征
<ph type="x-smartling-placeholder">
- </ph>
- 加利福尼亚州的观看者受众特征(年龄段和性别)
- 加利福尼亚州的播放列表观看者受众特征(年龄段和性别)
-
受众特征
<ph type="x-smartling-placeholder">
互动和内容分享
- sharingService (核心维度)
- 此维度用于标识分享视频时所用的服务,您可以使用“分享”功能在 YouTube(或通过 YouTube 播放器)上分享视频按钮。This is a core dimension and is subject to the Deprecation Policy.
下表列出了有效的维度值:
分享服务 API 值 Ameba AMEBA
Android 电子邮件 ANDROID_EMAIL
Android Messenger ANDROID_MESSENGER
Android 消息功能 ANDROID_MMS
黑莓 Messenger BBM
Blogger BLOGGER
复制到剪贴板 COPY_PASTE
赛车世界 CYWORLD
挖 DIGG
Dropbox DROPBOX
嵌入 EMBED
电子邮件 MAIL
Facebook FACEBOOK
Facebook Messenger FACEBOOK_MESSENGER
Facebook 主页 FACEBOOK_PAGES
福特卡 FOTKA
Gmail GMAIL
goo GOO
Google+ GOOGLEPLUS
开始使用短信 GO_SMS
GroupMe GROUPME
Hangouts HANGOUTS
hi5 HI5
HTC 短信 HTC_MMS
Google 收件箱 INBOX
iOS 系统活动对话框 IOS_SYSTEM_ACTIVITY_DIALOG
KAKAO 的故事 KAKAO_STORY
Kakao (Kakao Talk) KAKAO
Kik KIK
LGE 电子邮件 LGE_EMAIL
折线图 LINE
LinkedIn LINKEDIN
LiveJournal LIVEJOURNAL
梅尼阿姆 MENEAME
mixi MIXI
Motorola Messaging MOTOROLA_MESSAGING
Myspace MYSPACE
Naver NAVER
附近分享 NEARBY_SHARE
NUjij NUJIJ
奥德诺克拉斯尼基 (或更高版本) ODNOKLASSNIKI
其他 OTHER
Pinterest PINTEREST
楽天市场 RAKUTEN
reddit REDDIT
Skype SKYPE
Skyrock SKYBLOG
Sony Conversations SONY_CONVERSATIONS
StumbleUpon STUMBLEUPON
Telegram TELEGRAM
短信 TEXT_MESSAGE
Tuenti TUENTI
Tumblr。 TUMBLR
Twitter TWITTER
未知 UNKNOWN
Verizon 消息 VERIZON_MMS
Viber VIBER
VKontakte (Datalabонтакте) VKONTAKTE
微信文章 WECHAT
微博 WEIBO
WhatsApp WHATS_APP
Wykop WYKOP
Yahoo! 日本 YAHOO
YouTube 游戏 YOUTUBE_GAMING
YouTube Kids YOUTUBE_KIDS
YouTube Music YOUTUBE_MUSIC
YouTube TV YOUTUBE_TV
如需了解详情,请参阅帮助文档。
示例
以下示例请求使用了社交维度:
观众黏度
- elapsedVideoTimeRatio
- 此维度用于指定视频的已播放部分与视频时长的比率。“留存率”维度和指标用于衡量观众黏度随时间变化的情况,
elapsedVideoTimeRatio
维度用于衡量时间。例如,值0.4
表示相应的报告数据在视频播放 40% 之后显示留存率数据。
该 API 会针对比率值介于0.01
到1.0
之间的每个视频返回 100 个数据点。在视频播放期间测量数据的时间对于每个视频均等。这意味着,对于时长为 2 分钟的视频,数据点之间的时间间隔为 1.2 秒。但是,对于时长为 2 小时的视频,数据点之间的间隔为 72 秒。该维度的值表示间隔的不含边界值。 - audienceType (仅限过滤条件)
- 维度值用于标识与报告数据相关联的流量类型。
支持的值包括
ORGANIC
、AD_INSTREAM
和AD_INDISPLAY
。 有关这些流量来源类型的说明,请访问 YouTube 帮助中心。
请注意,“audienceType
”过滤器的数据截至 2013 年 9 月 25 日。对于使用过滤器尝试检索更早日期的数据的查询,API 不会返回数据。不使用过滤器的查询适用于 2008 年 7 月 1 日之后的任何日期。
示例
以下示例请求使用了观众黏度维度:
直播
- livestreamPosition
- 此维度用于指定直播视频串流中的特定分钟。报告指标 表示当时有多少用户正在观看直播。
取消会员资格
- membershipsCancellationSurveyReason
- 在
报告期内的指定渠道。下表列出了有效的维度值:
API 值 说明 UNKNOWN
用户没有完成调查问卷。 DISLIKE_PERKS
用户不喜欢该会员的福利。 PERKS_NOT_DELIVERED
用户表示承诺的会员福利未兑现。 CANNOT_ACCESS_PERKS
用户无法享受福利。 NO_LONGER_INTERESTED
用户对频道会员不再感兴趣。 FEEL_UNAPPRECIATED
用户感觉自己不被重视, FINANCIAL_REASONS
用户因财务原因取消了订阅。 JOIN_LIMITED_TIME
用户仅打算加入有限的一段时间。 OTHER
用户有其他取消原因。
广告效果
- adType
adType
维度用于广告效果报告,根据在视频播放期间投放的广告类型汇总所请求的指标。 以下列表介绍了可能的维度值。如需详细了解 YouTube 广告格式,请访问 YouTube 帮助中心。
-
auctionBumperInstream
– 通过竞价投放的不可跳过的视频广告,时长上限为 6 秒,用户必须先看完广告才能观看视频。 -
auctionDisplay
– 作为富媒体广告或图片广告,以重叠式广告的形式展示在视频播放器底部,在视频观看页面上显示为 300x250 广告单元,或两者兼具。叠加层运行时,会在显示一定时间后自动关闭,用户也可以关闭叠加层。如果重叠式广告和横幅广告一起显示,则每个广告都会计为一次单独的展示。 -
auctionInstream
– 在主视频播放前、播放过程中或播放后展示的不可跳过的视频广告。 -
auctionTrueviewInslate
– 观看者从视频播放前显示的选项中选择多个视频广告中的一个。See the TrueView documentation for more information. -
auctionTrueviewInstream
– 在主视频播放前或播放中展示的可跳过视频广告。 有关详情,请参阅 TrueView 文档。 -
auctionUnknown
– 通过 AdWords 竞价购买但未划分到其他广告类型的广告。 -
reservedBumperInstream
– 不可跳过的视频广告,通过预订方式出售,最长为 6 秒,用户必须看完广告才能观看视频。 -
reservedClickToPlay
- 用户必须点击才能启动播放的视频广告。无论用户是否开始播放点击播放广告,只要点击播放广告单元显示,系统就会记录一次广告展示。这类广告通过预留方式出售。 -
reservedDisplay
– 作为富媒体广告或图片广告,以重叠式广告的形式展示在视频播放器底部,在视频观看页面上显示为 300x250 广告单元,或两者兼具。叠加层运行时,会在显示一定时间后自动关闭,用户也可以关闭叠加层。如果重叠式广告和横幅广告一起显示,则每个广告都会计为一次单独的展示。 -
reservedInstream
– 在主视频播放前、播放过程中或播放后插入的不可跳过的视频广告。 -
reservedInstreamSelect
-
reservedMasthead
– 展示在首页上的大型广告,可以包含视频和图形元素。 -
reservedUnknown
– 通过预留方式销售的广告,无法归类为其他广告类型。 -
unknown
– YouTube 无法对此广告类型进行分类。
-
示例
以下示例报告检索了广告效果或收入指标:
渠道示例
-
收入/广告
<ph type="x-smartling-placeholder">
- </ph>
- 频道收入和广告效果指标
- 每日收入和广告效果指标
- 具体国家/地区的收入和广告效果指标
- 10 大 – 收益最高的视频
- 不同广告类型的广告效果指标
-
收入/广告
<ph type="x-smartling-placeholder">
内容所有者示例
-
收入/广告
<ph type="x-smartling-placeholder">
- </ph>
- 已声明版权的内容的收入和广告效果指标
- 每日收入和广告效果指标
- 具体国家/地区的收入和广告效果指标
- 10 大 – 收益最高的视频
- 不同广告类型的广告效果指标
-
收入/广告
<ph type="x-smartling-placeholder">
播放列表
- isCurated(仅限过滤条件)
- 此过滤器指示请求正在检索 播放列表的上下文。
示例
检索播放列表报告的所有示例请求都使用 isCurated
过滤条件。
内容所有者维度
以下维度仅适用于内容所有者报告。
- claimStatus(仅用于内容所有者报告)
- 您可以使用此维度指明 API 响应应仅包含与已声明版权的内容相关的指标。此维度的唯一有效值是
claimed
。如果filters
参数将查询限制为claimedStatus==claimed
,该 API 将仅检索已声明版权的内容的数据。uploaderType
维度定义中的表格提供了有关如何使用此维度的更多详细信息。
- UploaderType(核心维度)(仅在内容所有者报告中使用)
- 您可以使用此维度指明 API 响应是否应包含针对指定内容所有者上传的内容和/或第三方上传的内容(如用户上传的视频)的指标。有效值为
self
和thirdParty
。这是核心维度,需要遵守弃用政策。
下表显示了支持在filters
参数中使用的claimedStatus
和uploaderType
维度组合:
claimedStatus
值uploaderType
值说明 [未设置] 自身 检索由内容所有者上传且已声明和未声明版权的内容的 YouTube 数据分析数据。 已声明 [未设置] 检索由内容所有者或第三方上传的已声明版权的内容的数据。 已声明 自身 检索由内容所有者上传的已声明版权的内容的数据。 已声明 thirdParty 检索由第三方上传且已声明版权的内容的数据。
示例
内容所有者报告的许多示例 API 请求都使用受支持的 claimedStatus
和 uploaderType
维度组合来过滤数据。