本文档定义了 YouTube Reporting API 支持的维度。此 API 可检索包含频道或内容所有者的 YouTube 数据分析数据的批量报告。
维度是用于汇总数据的常用条件,例如用户活动发生的日期或用户所在的国家/地区。
每个批量报告都支持预定义的维度列表,并且在任何报告中,每行数据都有一个唯一的维度值组合。因此,每一行的维度值组合充当该行的主键。您既不需要指定,也不需要指定包含在报告中的维度。
核心维度
尽管 YouTube Reporting API 在使用 服务条款,非核心维度(和非核心指标)不包括在内 。在本页的定义中,任何核心维度都属于 已明确指定。
以下列表列出了该 API 的核心维度。 所有这些也是 YouTube Analytics API 中的核心维度。
如需了解详情,请参阅受弃用政策约束的 YouTube API 列表。
维度
下面几部分定义了在 YouTube Reporting API 的批量报告中使用的维度。除非另有说明,否则这些维度会同时用于“频道”报告和“内容所有者”报告中。
资源
这些维度与频道和内容所有者在 YouTube 上管理的资源相对应:
- video_id(核心维度)
- YouTube 视频的 ID。在 YouTube Data API 中,这是
video
的值 资源的id
属性。This is a core dimension and is subject to the Deprecation Policy. - playlist_id
- YouTube 播放列表的 ID。在 YouTube Data API 中,这是
playlist
资源的id
属性的值。 - channel_id(核心维度)
- YouTube 频道的 ID。在 YouTube Data API 中,这是
channel
资源的id
属性的值。This is a core dimension and is subject to the Deprecation Policy. - asset_id(仅用于内容所有者报告)
- 在 YouTube 的 Content ID 系统中管理的资产的 ID。资产代表了您的知识产权在相关系统中。在 YouTube 网站上,您可以在 YouTube 内容管理器中查找资产 ID。您还可以使用 YouTube Content ID API 进行检索。
地理区域
这些维度用于确定与用户活动、广告效果或估算收入指标相关联的地理区域。
- country_code(核心维度)
- 与报告行中的指标相关联的国家/地区。维度值是一个由两个字母组成的 ISO-3166-1 国家/地区代码,例如
US
、CN
(中国)或FR
(法国)。国家/地区代码ZZ
用于报告 YouTube 无法识别相关国家/地区的指标。This is a core dimension and is subject to the Deprecation Policy. - province_code
- 与报告行中的指标相关联的美国州或地区。维度值是用于标识美国各州或哥伦比亚特区的 ISO 3166-2 代码,例如
US-MI
(密歇根州)或US-TX
(得克萨斯州)。省代码US-ZZ
用于报告 YouTube 无法识别美国相关州的指标。注意:此维度不支持用于标识美国本土外地区的 ISO 3166-2 值,因为这些地区也有自己的 ISO 3166-1 国家/地区代码。也不支持细分美国以外的国家/地区。
时间段
- 日期(核心维度)
- 此维度用于标识与每个报告行中的指标相关联的日期。批量
报告,日期是指从太平洋时间凌晨 12:00 开始,到
在指定日期、月份和年份的太平洋时间晚上 11:59。根据所处的时节,
太平洋时间采用 UTC-7 或 UTC-8 格式。
请注意,虽然日期通常以 24 小时为单位,但调整时钟的日期 夏令时向前表示 23 小时时间段,以及调整时钟的日期 表示 25 小时的时间段This is a core dimension and is subject to the Deprecation Policy.
播放位置
通过这些维度,您可以深入了解发生用户活动的网页或应用。
- playback_location_type
-
此维度可标识发生用户活动的网页或应用的类型。下表列出了维度值:
值 0
这些数据与在视频的 YouTube 观看页面或 YouTube 官方应用(例如 Android 版 YouTube 应用)中发生的活动有关。 1
这些数据与使用 <iframe>
或<object>
嵌入代码嵌入视频的其他网站或应用中发生的活动有关。2
该数据与 YouTube 频道页上发生的活动有关。 5
这些数据与无法归类为列出的其他地理位置类型的指标有关。 7
这些数据涉及在 YouTube 首页或主屏幕上、用户的订阅 Feed 中或其他 YouTube 浏览功能中产生的观看次数。 8
该数据与 YouTube 搜索结果页上直接产生的观看次数有关。 10
该数据与 YouTube Shorts 动态中产生的观看次数有关。 - playback_location_detail
- 此维度用于指定发生播放的网址或应用。只有嵌入式播放器中发生的观看支持此维度,也就是说,只有在维度值为
1
的行中才会填充该维度值。在其他行中,此维度的值为空。
播放详情
- live_or_on_demand
- 此维度用于指明数据行中的用户活动指标是否与直播观看次数相关。系统提供此维度的数据,最早日期为 2014 年 4 月 1 日。
下表列出了维度值:
值 live
此行的数据描述的是直播期间发生的用户活动。 onDemand
此行的数据描述了在直播期间未发生的用户活动。 - subscribed_status
- 此维度用于指明数据行中的用户活动指标是否与订阅了视频或播放列表频道的观看者相关联。
可能的值包括
subscribed
和unsubscribed
。
请注意,维度值在发生用户活动时是准确的。例如,假设一位用户没有订阅某个频道,但观看了该频道的其中一个视频,然后又订阅了该频道并观看了另一个视频,所有操作均在同一天完成。 频道的报告会指出,一个观看的subscribed_status
值为subscribed
,另一个观看的subscribed_status
值为unsubscribed
。
流量来源
- traffic_source_type
- 此维度用于标识与用户活动指标相关联的引荐来源网址类型。引荐来源类型用于说明用户访问与报告中的相应数据行相关联的视频或频道的方式。下表列出了维度值:
值 0
直接或未知
此值包含对网页的直接流量,以及引荐来源网址未知的网页。在查询报告中,此流量来源类型被标识为NO_LINK_OTHER
或UNKNOWN_MOBILE_OR_DIRECT
。1
YouTube 广告
观看者是通过广告发现了视频的。在流量来源报告中,如果此维度的值为1
,则 traffic_source_detail 维度用于标识向观看者展示的广告的类型。在查询报告中,此流量来源类型被标识为ADVERTISING
。可能的值包括:值 ctp_engagement_ad
点击播放互动广告 engagement_ad
互动广告 googlemediaads
Google 搜索广告 insearch_display
TrueView 搜索广告和展示广告 instream
TrueView 插播广告 instream-select
预留的可跳过的插播广告 unknown
未分类的 YouTube 广告 video_wall
平铺视频 yva
首页视频广告 3
浏览功能
观看者是通过链接到视频或频道的 YouTube 页面引荐而来。在流量来源报告中,如果此维度的值为3
,则 traffic_source_detail 维度用于标识引荐流量的地图项。在查询报告中,此流量来源类型被标识为SUBSCRIBER
。可能的值包括:值 explore
儿童:探索 learning
儿童:学习 music
音乐 Feed my-history
观看记录 my-subscriptions
我的订阅 my-uploads
我上传的内容 podcasts
播客目标网页 shows
儿童:节目 watch-later
稍后观看 what-to-watch
精彩推荐 4
YouTube 频道
观看者是通过 YouTube 频道页引荐而来的。在流量来源报告中,如果此维度的值为4
,则 traffic_source_detail 维度会指定该渠道的渠道 ID。在查询报告中,此流量来源类型被标识为YT_CHANNEL
。5
YouTube 搜索
观看者是通过 YouTube 搜索结果引荐而来的。在流量来源报告中,如果此维度的值为5
,则 traffic_source_detail 维度会指定关联的搜索字词。在查询报告中,此流量来源类型被标识为YT_SEARCH
。7
推荐视频
观看者是通过其他视频观看页面上的相关视频列表引荐而来的。在流量来源报告中,如果此维度的值为7
,则 traffic_source_detail 维度用于标识该视频的视频 ID。在查询报告中,此流量来源类型被标识为RELATED_VIDEO
或YT_RELATED
。8
其他 YouTube 功能
观看者是通过不属于上述任何流量来源类型的 YouTube 页面引荐的。在流量来源报告中,如果此维度的值为8
,则 traffic_source_detail 维度用于标识网页网址。在查询报告中,此流量来源类型被标识为YT_OTHER_PAGE
。可能的值包括:值 g-crec
推荐频道 offline
离线 promotion
合作伙伴推广计划 unknown
未知 widget
Android 主屏幕微件 youtu.be
youtu.be ytremote
YouTube 遥控器 9
外部
观看者是通过其他网站上的链接引荐而来的。此流量来源包括来自 Google 搜索结果的引荐。在流量来源报告中,如果此维度的值为9
,则 traffic_source_detail 维度用于标识外部网页。在查询报告中,此流量来源类型被标识为EXT_URL
。11
视频卡片和注释
观看者是通过点击其他视频中的注释或卡片引荐的。在查询报告中,此流量来源类型被标识为ANNOTATION
。14
播放列表
视频作为播放列表的一部分播放时产生的观看次数。在查询报告中,此流量来源类型为PLAYLIST
。
请注意,此流量来源与18
来源类型不同,后者表明观看次数源自列出播放列表中所有视频的网页。17
通知
观看者是通过 YouTube 发送的电子邮件或通知引荐的。在查询报告中,此流量来源类型被标识为NOTIFICATION
。可能的值包括:值 inbox
push
sdig
源自订阅者摘要中的通知的观看次数 uploaded_other
由非推送通知(例如电子邮件或收件箱通知)带来的观看次数; 在视频上传后发送给订阅者 uploaded_push
观看次数源于在视频发布后向订阅者发送的推送通知 已上传 18
播放列表页面
由列出了播放列表中的所有视频的网页带来的观看次数。在查询报告中,此流量来源类型被标识为YT_PLAYLIST_PAGE
。
请注意,此流量来源类型与14
来源类型不同,后者表示观看次数是在播放列表中播放视频期间发生的。19
由已声明版权的内容进行编排
观看次数源自已声明版权的用户上传视频,内容所有者用于宣传所查看的内容。在查询报告中,此流量来源标识为CAMPAIGN_CARD
。只有内容所有者报告支持此流量来源。20
互动式视频片尾画面
源自另一个视频的片尾画面的观看次数。在查询报告中,此流量来源类型被标识为END_SCREEN
。23
短片故事
观看者是通过在“短片故事”观看体验中从上一个视频垂直滑动来引荐的。24
Shorts 短视频
在 Shorts 短视频观看体验中,观看者在上一个视频上竖向滑动手指。25
商品页面
商品页面上的视频将观看者吸引到了另一个频道。26
# 标签页面
由视频点播的 # 标签页面或 Shorts 的 # 标签转换页产生的观看次数。27
音效页面
源自 Shorts 音效页面的观看次数。28
直播跳转
由直播跳转带来的观看次数。30
混剪视频
由 Shorts 短视频播放器中的混剪视频链接产生的观看次数。31
竖屏直播推送
竖屏直播推送带来的观看次数。32
相关视频
由 Shorts 短视频播放器中的相关视频链接产生的观看次数。 - traffic_source_detail
- 此维度提供了相应行的 traffic_source_type 维度值所依据的流量来源的其他详细信息。系统会针对以下 traffic_source_type 维度值填充此维度值:
<ph type="x-smartling-placeholder">
- </ph>
1
- 维度值用于标识向观看者展示的广告的类型。如需查看可能值的列表,请参阅 traffic_source_type 定义。3
- 维度值用于标识带来了所引荐流量的 YouTube 功能。如需查看可能值的列表,请参阅 traffic_source_type 定义。4
- 维度值用于指定观看者通过哪个频道 ID 被推荐。5
- 维度值用于指定带来了所引荐流量的搜索字词。7
- 维度值用于标识观看者通过哪个视频被推介。8
- 维度值用于标识带来了所引荐流量的 YouTube 网页类型。如需查看可能值的列表,请参阅 traffic_source_type 定义。9
- 维度值用于标识引荐流量的外部网页。17
- 维度值用于标识带来了所引荐流量的通知类型。如需查看可能值的列表,请参阅 traffic_source_type 定义。19
- 维度值用于标识观看者通过哪个视频被推介。20
- 维度值用于标识观看者通过哪个视频被推介。25
- 维度值用于标识商品 ID,也就是 Google 知识图谱 ID。26
- 维度值用于标识带来了所引荐流量的 # 标签。27
- 维度值用于标识观看者通过哪个视频被推介。28
- 维度值用于指定观看者通过直播跳转引荐到的频道 ID。30
- 维度值用于指定观看者从哪个视频被推介给了观看者。
设备
- device_type
- 此维度用于标识视频播放设备的实际尺寸。
下表列出了有效的维度值:
值 100
未知 101
计算机 102
TV 103
游戏机 104
手机 105
平板电脑 - operating_system
- 此维度用于标识观看设备所在的软件系统。
下表列出了有效的维度值:
值 1
其他 2
Windows 3
Windows Mobile 4
Android 5
iOS 6
Symbian 7
Blackberry 9
Macintosh 10
PlayStation 11
Bada 12
WebOS 13
Linux 14
Hiptop 15
MeeGo 16
Wii 17
Xbox 18
PlayStation Vita 19
智能电视 20
任天堂 3DS 21
Chromecast 22
Tizen 23
Firefox 24
RealMedia 25
KaiOS 26
Roku 27
Nintendo Switch 28
Apple tvOS 29
消防操作系统 30
ChromeOS 31
Vidaa
受众特征
受众特征维度可帮助您了解受众群体的年龄段和性别分布情况。YouTube 帮助中心在 YouTube Analytics 报告中提供了有关受众特征数据的更多信息。
- age_group (核心维度)
- 此维度用于标识报告数据对应的已登录用户的年龄段。该 API 使用以下年龄段:
AGE_13_17
AGE_18_24
AGE_25_34
AGE_35_44
AGE_45_54
AGE_55_64
AGE_65_
- gender(核心维度)
- 此维度用于标识报告数据所关联的已登录用户的性别。
有效值为
FEMALE
、MALE
和GENDER_OTHER
。 This is a core dimension and is subject to the Deprecation Policy.
互动和内容分享
- sharing_service (核心维度)
- 此维度用于标识分享视频时所用的服务,您可以使用“分享”功能在 YouTube(或通过 YouTube 播放器)上分享视频按钮。This is a core dimension and is subject to the Deprecation Policy.
下表列出了有效的维度值:
值 0
未知 1
挖 4
reddit 5
StumbleUpon 6
mixi 7
Yahoo! 日本 8
goo 9
Ameba 10
Facebook 11
Myspace 12
NUjij 18
Tuenti 20
梅尼阿姆 21
Wykop 22
Skyrock 25
福特卡 28
hi5 31
Twitter 32
赛车世界 34
Blogger 36
VKontakte (Datalabонтакте) 37
楽天市场 38
LiveJournal 39
奥德诺克拉斯尼基 (或更高版本) 40
Tumblr。 42
LinkedIn 43
Google+ 44
微博 45
Pinterest 46
电子邮件 47
Facebook Messenger 49
WhatsApp 50
Hangouts 51
Gmail 52
Kakao (Kakao Talk) 53
其他 55
复制到剪贴板 59
嵌入 60
短信 61
Android 消息功能 62
Verizon 消息 63
HTC 短信 64
Sony Conversations 65
开始使用短信 66
LGE 电子邮件 67
折线图 68
Viber 69
Kik 70
Skype 71
黑莓 Messenger 72
微信文章 73
KAKAO 的故事 74
Dropbox 75
Telegram 76
Facebook 主页 77
GroupMe 78
Android 电子邮件 79
Motorola Messaging 80
附近分享 81
Naver 82
iOS 系统活动对话框 83
Google 收件箱 84
Android Messenger 85
YouTube Music 86
YouTube 游戏 87
YouTube Kids 88
YouTube TV
如需了解详情,请参阅帮助文档。
注释
- annotation_type
- 此维度用于标识注释在视频播放期间的显示方式。下表列出了可能的维度值:
值 0
未知 1
备注 3
焦点 4
标题 8
气泡 9
标签 10
品牌水印 11
精选视频 12
精选播放列表 30
号召性用语 - annotation_id
- YouTube 用于唯一标识注释的 ID。
卡片
- card_type
- 此维度用于标识向用户显示的卡片的类型。下表列出了可能的维度值:
值 0
未知 60
链接 61
募捐筹款 62
视频 63
播放列表 65
粉丝赞助 66
商品 68
关联网站 69
频道 - card_id
- YouTube 用于唯一标识卡的 ID。
片尾画面
- end_screen_element_type
- 此维度用于标识向用户显示的片尾画面元素的类型。下表列出了片尾画面元素类型及其值:
值 501
视频 - 元素推介其他 YouTube 视频。 502
播放列表 - 元素推介 YouTube 播放列表。 503
网站 - 元素链接到您的关联网站。 504
频道 - 元素链接到其他频道。 505
订阅 - 该元素可鼓励用户订阅您的频道。 506
已关联 507
众筹 - 此元素会链接到已获批准的众筹网站。 508
商品 - 此元素链接到已获批准的商品网站。 509
最近上传的视频 - 元素链接到您频道中最近上传的视频。 510
最契合观看者兴趣的视频 - end_screen_element_id
- YouTube 用来唯一标识片尾画面元素的 ID。
字幕
- subtitle_language_autotranslated
- 此维度用于标识用户在观看过程中使用时间最长的自动翻译字幕语言。字幕几乎不关闭的观看次数不会计算在内。如需详细了解包含此维度的报告,请参阅频道报告或内容所有者报告的相关文档。
广告效果
- ad_type
ad_type
维度用于广告效果报告,根据在视频播放期间投放的广告类型汇总所请求的指标。 下表列出了可能的维度值。如需详细了解 YouTube 广告格式,请访问 YouTube 帮助中心。
值 说明 查询报告中的值 1
可跳过的视频广告(竞价) auctionTrueviewInstream
2
展示广告(竞价) auctionDisplay
3
不可跳过的视频广告(竞价) auctionInstream
5
展示广告(预留) reservedDisplay
6
不可跳过的视频广告(预留) reservedInstream
13
未知 unknown
15
可跳过的视频广告(预留) reservedInstreamSelect
19
导视广告(竞价) auctionBumperInstream
20
导视广告(预留) reservedBumperInstream
注意:系统可能会针对您之前在 YouTube 上使用的一些其他广告类型返回查询报告。
内容所有者维度
以下维度仅在内容所有者报告中使用。
- claim_status(仅用于内容所有者报告)
- 此维度用于指明某行数据仅包含与已声明版权的内容相关的指标。此维度的唯一有效值是
claimed
。uploader_type
维度定义中的表格提供了有关如何使用此维度的更多详细信息。
- Uploader_type(核心维度)(仅在内容所有者报告中使用)
- 此维度用于指明某一行数据是否包含由指定内容所有者上传的内容和/或第三方上传的内容(例如用户上传的视频)的指标。有效值为
self
和thirdParty
。这是核心维度,需要遵守弃用政策。
下表显示了支持的“claimed_status
”和“uploader_type
”维度组合:
claimed_status
值uploader_type
值说明 [未设置] 自身 该行包含与内容所有者上传的已声明和未声明版权的内容相关的 YouTube 数据分析数据。 已声明 自身 该行包含由内容所有者上传且已声明版权的内容的相关数据。 已声明 thirdParty 该行包含由第三方上传且已声明版权的内容的相关数据。