Dimensions

本文档定义了 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 国家/地区代码,例如 USCN(中国)或 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 应用(例如 YouTube Android 应用)中发生的活动有关。
1 这些数据与在其他网站或应用上发生的活动有关,这些网站或应用使用 <iframe><object> 嵌入代码嵌入了视频。
2 数据与 YouTube 频道页面上发生的活动有关。
5 相应数据涉及无法归类到其他任何列出的地理位置类型的指标。
7 这些数据是指在 YouTube 首页或主屏幕、用户的订阅动态或其他 YouTube 浏览功能中发生的观看次数。
8 这些数据与直接在 YouTube 搜索结果页上发生的观看有关。
10 此数据与在 YouTube Shorts 动态中发生的观看有关。
playback_location_detail
此维度用于指定发生播放的网址或应用。此维度仅支持在嵌入式播放器中发生的观看,这意味着仅当该维度的值为 1 时,系统才会填充相应行的维度值。在其他行中,相应维度值为空。

播放详情

live_or_on_demand
此维度表示相应数据行中的用户活动指标是否与直播观看相关联。此维度的数据从 2014 年 4 月 1 日开始提供。

下表列出了维度值:
live 相应行的数据描述的是直播期间发生的用户活动。
onDemand 相应行的数据描述的是未在直播期间发生的用户活动。
subscribed_status
此维度用于指明数据行中的用户活动指标是否与订阅了相应视频或播放列表所属频道的观看者相关联。 可能的值有 subscribedunsubscribed

请注意,维度值在用户活动发生时是准确的。例如,假设某用户未订阅某个频道,但观看了该频道的一部视频,然后在同一天订阅了该频道并观看了另一部视频。 渠道的报告显示,一次观看的 subscribed_status 值为 subscribed,另一次观看的 subscribed_status 值为 unsubscribed

流量来源

traffic_source_type
此维度用于标识与用户活动指标相关联的引荐来源类型。引荐来源类型用于说明用户是通过何种方式访问报告中相应数据行所关联的视频或频道的。下表列出了维度值:
0 直接或不明来源
此值涵盖了网页的直接流量,以及引荐来源网址不明的网页。在查询报告中,此流量来源类型标识为 NO_LINK_OTHERUNKNOWN_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_VIDEOYT_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 直播跳转
观看次数来自直播跳转
29 播客
观看次数来自 YouTube 播客页面。
30 混剪视频
观看次数来自短视频播放器中的混剪视频链接。
31 竖屏直播推送
源自竖屏直播推送的观看次数。
32 相关视频
观看次数来自 Shorts 播放器中的相关视频链接。
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 电视
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 Fire OS
30 ChromeOS
31 Vidaa
32 VegaOS

受众特征

人口统计学维度可帮助您了解受众群体的年龄段和性别分布情况。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_
This is a core dimension and is subject to the Deprecation Policy.
gender(核心维度)
此维度用于标识与报告数据关联的已登录用户的性别。 有效值为 FEMALEMALEGENDER_OTHERThis 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 Tuenti
20 menéame
21 Wykop
22 Skyrock
25 Fotka
28 hi5
31 Twitter
32 Cyworld
34 Blogger
36 VKontakte (ВКонтакте)
37 Rakuten(楽天市場)
38 LiveJournal
39 Odnoklassniki (Одноклассники)
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 Go 短信
66 LGE 电子邮件地址
67 折线图
68 Viber
69 Kik
70 Skype
71 BlackBerry Messenger
72 WeChat
73 KAKAO Story
74 Dropbox
75 Telegram
76 Facebook 主页
77 GroupMe
78 Android 电子邮件
79 Motorola 信息
80 附近分享
81 Naver
82 iOS 系统活动对话框
83 Google Inbox
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 号召性用语
YouTube 帮助中心详细介绍了不同类型的注释以及向视频添加注释的流程。
annotation_id
YouTube 用于唯一标识注释的 ID。

卡片

card_type
此维度用于标识向用户显示的卡片类型。下表列出了可能的维度值:
0 未知
60 链接
61 募捐筹款
62 视频
63 播放列表
65 粉丝赞助
66 商品
68 关联网站
69 频道
YouTube 帮助中心详细介绍了不同类型的卡片以及向视频添加卡片的流程。
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
此维度用于标识观看期间使用时间最长的隐式字幕语言。如果观看者在观看视频时大多关闭了字幕,则相应观看次数不会计入。如需详细了解包含此维度的报告,请参阅频道报告内容所有者报告的相关文档。
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 上使用过的一些其他广告类型。

内容所有者维度

以下维度仅在内容所有者报告中使用。

claimed_status (仅在内容所有者报告中使用)
此维度表示相应数据行仅包含已声明版权的内容的指标。此维度的唯一有效值为 claimeduploader_type 维度的定义中的表格详细介绍了如何使用此维度。
uploader_type (核心维度) (仅在内容所有者报告中使用)
此维度用于指明相应数据行是否包含指定内容所有者上传的内容和/或第三方(例如用户上传的视频)上传的内容的指标。有效值为 selfthirdParty。这是一个核心维度,受弃用政策的约束。

下表显示了claimed_statusuploader_type维度支持的组合:

claimed_status uploader_type 说明
[未设置] self 相应行包含内容所有者上传的已声明版权和未声明版权的内容的 YouTube 数据分析数据。
已声明 self 相应行包含内容所有者上传的收到版权主张的内容的数据。
已声明 thirdParty 相应行包含第三方上传的已声明版权的内容的数据。