本文档定义了 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
# 标签页面
由 VOD 标签页面或 Shorts 标签转换页面带来的观看次数。27
音效页面
来自 Shorts 音效页面的观看次数。28
直播跳转
来自直播跳转的观看。30
混剪视频
观看次数是由 Shorts 短视频播放器中的混剪视频链接带来的。31
竖屏直播 Feed
源自竖屏直播 Feed 的观看次数。32
相关视频
由短视频播放器中的相关视频链接带来的观看次数。 - traffic_source_detail
- 此维度可提供关于相应行的 traffic_source_type 维度值的流量来源的更多详情。系统会为以下 traffic_source_type 维度值填充此维度值:
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
黑莓 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
Fire OS 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_
- 性别 (核心维度)
- 此维度用于标识与报告数据关联的已登录用户的性别。
有效值为
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
Digg 4
reddit 5
StumbleUpon 6
mixi 7
Yahoo! 日本 8
goo 9
Ameba 10
Facebook 11
Myspace 12
NUjij 18
图恩 20
中东和北非 21
怀科普 22
天空石 25
福特卡 28
hi5 31
Twitter 32
赛世界 34
Blogger 36
文塔克特语(估算值) 37
乐天(楽天市场) 38
LiveJournal 39
奥德诺克拉斯尼基(឵legacyоклассники) 40
tumblr. 42
LinkedIn 43
Google+ 44
微博 45
Pinterest 46
Email 47
Facebook Messenger 49
WhatsApp 50
Hangouts 51
Gmail 52
卡考 (Kakao Talk) 53
其他 55
复制到剪贴板 59
嵌入地图 60
短信 61
Android 信息 62
Verizon 信息 63
HTC 短信 64
索尼对话 65
启用短信 66
LGE 电子邮件 67
折线图 68
Viber 69
Kik 70
Skype 71
黑莓 Messenger 72
WeChat 73
KAKAO 故事 74
Dropbox 75
Telegram 76
Facebook 主页 77
GroupMe 78
Android 电子邮件 79
摩托罗拉消息功能 80
附近分享 81
Naver 82
iOS 系统活动对话框 83
Google 收件箱 84
Android 版 Messenger 85
YouTube Music 86
YouTube Gaming 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 此行包含第三方上传的已主张版权的内容的相关数据。