You need to enable JavaScript to run this app.
导航
短视频埋点说明
最近更新时间:2023.08.29 15:19:16首次发布时间:2021.07.05 21:23:10
概述

该文档针对横版短视频场景,主要介绍了数据回传的通用事件,参数,上报示例等,同时用于开发者自测数据回传是否正确,若自测无误,请务必提供APP给火山引擎进行埋点验收,否则影响推荐效果!

备注
埋点上报用于统计用户的消费行为,进而作用于模型训练,进行个性化推荐。
其它参数见:数据回传参数说明

参数说明
字段名字段类型说明
req_idstring请求内容推荐接口返回的RequestId
enter_fromstring固定值:click_category
category_namestring场景id,在内容管理平台控制台-场景管理-获取场景id
group_idlong内容id,对应内容推荐接口返回的GroupId
__itemsstring该id同group_id,用于内容特征分析;[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_specialstring固定值:content_manager_system
durationlong视频播放实际时长,非进度条位置时长,单位ms。
percentlong当前播放的最大百分比,拖动进度条也算,范围0-100。自动重播同一视频,percent报100。
stay_timelong阅读时长,单位ms
root_gidlong进入内流场景的第一个视频的GroupId
事件说明

核心场景

频道列表页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
频道列表页image.png曝光展现第一个像素上报cms_client_showreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
下拉刷新展现新内容上报
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报
频道列表页image.png视频播放(手动点击起播)点击开始播放上报cms_video_playreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
频道列表页image.png视频时长(手动点击起播)点击其他内容离开播放页面上报cms_video_overreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报
频道列表页image.png视频播放(自动起播)进入频道列表页视频自动播发上报cms_video_play_autoreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
滑动屏幕,然后停留在新视频上,开始自动播放上报
滑动回刚才播放过的视频,重新开始播放上报
暂停后重新播放不上报
频道列表页image.png视频时长(自动起播)自动播放的视频退出播放上报cms_video_over_autoreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
锁屏或切换后台不上报
暂停播放不上报

视频详情页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
视频详情页image.png点击进入详情页点击进入详情页上报cms_go_detailreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
从相关阅读返回详情页不上报
锁屏或切换后台回到详情页不上报
视频详情页image.png退出详情页退出详情页上报cms_stay_pagereq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
stay_time:阅读时长,单位ms
点击其他内容离开详情页上报
锁屏或切换后台不上报
视频详情页image.png视频播放点击开始播放上报cms_video_playreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
视频详情页image.png视频时长按返回键离开播放页面上报cms_video_overreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
点击其他内容离开播放页面上报
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报

沉浸式内流

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期备注
沉浸式视频内流image.png视频播放(从列表页进入内流时的第一个视频)点击开始播放上报cms_video_playreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
沉浸式视频内流image.png视频时长(从列表页进入内流时的第一个视频)按返回键离开播放页面上报cms_video_overreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
上划视频离开当前内容上报
暂停播放不上报
视频播放完一遍分情况如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报。
锁屏或切换后台不上报
沉浸式视频内流image.png视频自动播放
上报自动播放的埋点有2种情况:
1、点击tab进入内流(可以认为是抖音那种样式),这种情况下所有内容都上报video_play_auto(自动播);
2、点击列表页视频进入内流,这种情况下第一个视频上报video_play,向下滑之后的视频(也就是第二个及以后)上报video_play_auto(自动播)
在沉浸式完成上一个视频的播放,自动开始播放新视频上报在列表页点击视频,进入沉浸式,这时播放的视频不上报video_play_auto,而是video_play。cms_video_play_autoreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
root_gid:进入内流场景的第一个视频
滑动屏幕,然后停留在新视频上,开始自动播放上报
全屏之后,点击“下一个”开始播放新视频上报只有部分产品有这个功能
滑动回刚才播放过的视频,重新开始播放上报
暂停后重新播放不上报

沉浸式视频内流
image.png视频自动播放的时长
上报自动播放的埋点有2种情况:
1、点击tab进入内流(可以认为是抖音那种样式),这种情况下所有内容都上报video_over_auto(自动播);
2、点击列表页视频进入内流,这种情况下第一个视频上报video_over,向下滑之后的视频(也就是第二个及以后)上报video_over_auto(自动播)
自动播放的视频退出播放上报开始播放时上报video_play_auto的,结束播放时都上报video_over_auto;进入沉浸式时的第一个视频结束或退出时上报video_over。cms_video_over_autoreq_id:请求id
category_name:场景id
group_id: 内容(文章/视频)id
enter_from:click_category(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
root_gid:进入内流场景的第一个视频
锁屏或切换后台不上报
暂停播放不上报

相关推荐场景(非必须)

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
相关推荐image.png曝光展现第一个像素上报cms_client_showgroup_id: 内容(文章/视频)id
from_gid:相关阅读来源文章id
req_id:请求id
category_name:场景id
root_category_name:入口频道名称
enter_from:click_related(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报
相关推荐image.png视频播放点击开始播放上报cms_video_playgroup_id: 内容(文章/视频)id
from_gid:相关阅读来源文章id
req_id:请求id
category_name:场景id
root_category_name:入口频道名称
enter_from:click_related(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
相关推荐image.png视频时长按返回键离开播放页面上报cms_video_overgroup_id: 内容(文章/视频)id
from_gid:相关阅读来源文章id
req_id:请求id
category_name:场景id
root_category_name:入口频道名称
enter_from:click_related(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
点击其他内容离开播放页面上报
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报
相关推荐image.png点击进入详情页点击进入详情页上报cms_go_detailgroup_id: 内容(文章/视频)id
from_gid:相关阅读来源文章id
req_id:请求id
category_name:场景id
root_category_name:入口频道名称
enter_from:click_related(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
从相关阅读返回详情页不上报
锁屏或切换后台回到详情页不上报
相关推荐image.png退出详情页退出详情页上报cms_stay_pagegroup_id: 内容(文章/视频)id
from_gid:相关阅读来源文章id
req_id:请求id
category_name:场景id
root_category_name:入口频道名称
enter_from:click_related(固定值)
__items:[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special:content_manager_system(固定值)
stay_time:阅读时长,单位ms
点击其他内容离开详情页上报
锁屏或切换后台不上报
上报示例

CASE1:频道列表页 ➡️ 视频详情页 ➡️ 相关推荐

起播方式:全部都是手动点击起播

操作截图上报事件备注(此处表示相关推荐的埋点加粗

一、进入频道列表页,此时有3个视频展现:

  • 内容1:农村90后姑娘XXX

  • 内容2:极星2XXX

  • 内容3:又跌了2万XXX

cms_client_show

上报3条内容的cms_client_show

二、点击内容1,此时

  1. 进入内容1的视频详情页;

  2. 内容1视频开始播放

  3. 展现了3个相关推荐的内容:

  • 相关视频1:安徽人在佛山XXX

  • 相关视频2:为了生个儿子XXX

  • 相关视频3:广西玉林XXX

  • cms_go_detail

  • cms_video_play

  • cms_client_show

  • 进入内容1视频详情页时上报cms_go_detail;

  • 内容1该视频起播方式是手动点击播放,因此上报cms_video_play;

  • 相关推荐上报3条内容的cms_client_show

注:相关推荐需要上报from_gid参数,此处from_gid是「农村90后姑娘XXX」该视频的gid

三、点击相关视频1,此时

  1. 内容1播放结束;

  2. 离开了内容1的详情页;

  3. 同时进入相关视频1的详情页;

  4. 相关视频1开始播放;

  5. 展现了3个相关推荐的内容:

  • 相关视频1-1:女嫁农村XXX

  • 相关视频1-2:广西猪肉XXX

  • 相关视频1-3:广西30岁XXX

  • cms_stay_page

  • cms_video_over

  • cms_go_detail

  • cms_video_play

  • cms_client_show

  • 离开内容1视频详情页时上报

cms_stay_page;

  • 由于内容1起播方式是手动点击播放,因此该视频播放结束上报cms_video_over;

  • 进入相关视频1的视频详情页时上报cms_go_detail;

  • 相关视频1的起播方式是手动点击播放,因此上报cms_video_play;

  • 相关推荐上报3条内容的cms_client_show

注:相关推荐需要上报from_gid参数,此处

  • cms_go_detail和cms_video_play的from_gid是「农村90后姑娘XXX」该视频的gid;

  • cms_client_show的from_gid是「安徽人XXX」该视频的gid

CASE2:频道列表页 ➡️ 沉浸式内流

起播方式:频道列表页手动点击播放,内流自动播放

操作截图上报事件备注(此处表示相关推荐的埋点加粗

一、进入频道列表页,此时有2个视频展现:

  • 内容1:56岁高龄产妇XXX

  • 内容2:第一次同居XXX

cms_client_show

上报2条内容的cms_client_show

二、点击内容1,此时

  1. 进入沉浸式内流;

  2. 内容1视频开始播放

cms_video_play

内容1该视频起播方式是手动点击播放,因此上报cms_video_play;

三、滑动列表,停留后,视频2自动播放,此时

  1. 内容1播放结束;

  2. 视频2开始播放;

  • cms_video_over

  • cms_video_play_auto

  • 由于内容1起播方式是手动点击播放,因此该视频播放结束上报cms_video_over;

  • 视频2的起播方式是自动播放,因此该视频开始播放上报cms_video_play_auto

注:从视频2开始,下滑的视频cms_video_play_auto和cms_video_over_auto都需要上报root_gid参数,此处root_gid是入口视频,即「56岁高龄产妇XXX」该视频的gid

四、视频2播放结束后,视频3自动播放,此时

  1. 视频2播放结束;

  2. 视频3开始播放;

  • cms_video_over_auto

  • cms_video_play_auto

  • 视频2起播方式是自动播放,因此该视频播放结束上报cms_video_over_auto;

  • 视频3的起播方式是自动播放,因此该视频开始播放上报cms_video_play_auto

注:从视频2开始,下滑的视频cms_video_play_auto和cms_video_over_auto都需要上报root_gid参数,此处root_gid是入口视频,即「56岁高龄产妇XXX」该视频的gid

CASE3:频道列表页

起播方式:频道列表页自动播放,无法点击进入内流和详情页

操作截图上报事件备注(此处表示相关推荐的埋点加粗

一、进入频道列表页,此时有2个视频展现,且内容1自动播放:

  • 内容1:枕头芯XXX

  • 内容2:炒瘦肉XXX

  • cms_client_show

  • cms_video_play_auto

  • 上报2条内容的cms_client_show

  • 内容1该视频起播方式是自动播放,因此上报cms_video_play_auto;

二、滑动列表,停留后,此时

  1. 视频1播放结束;

  2. 视频2自动播放;

  • cms_video_over_auto

  • cms_video_play_auto

  • 内容1该视频起播方式是自动播放,因此播放结束时上报cms_video_over_auto;

  • 内容2该视频起播方式是自动播放,因此上报cms_video_play_auto;

CASE4:沉浸式内流

体裁:都是横版短视频
如果是「短视频和小视频混排」,沿用此埋点方案;

操作截图上报事件备注(此处表示相关推荐的埋点加粗

一、进入频道,此时是沉浸式内流样式,自动播放视频1:

  • 视频1:羚羊刚从XXX

cms_video_play_auto

  • 视频1起播方式是自动播放,因此上报cms_video_play_auto;

二、向下滑动,此时

  • 结束播放视频1

  • 自动播放视频2

cms_video_over_auto
cms_video_play_auto

  • 视频1起播方式是自动播放,因此播放结束时上报cms_video_over_auto;

  • 视频2起播方式是自动播放,因此上报cms_video_play_auto;

FAQ

视频有三种样式:

  • 频道点击直接进详情页,此时上报埋点组合为go_detail,stay_page,video_play,video_over,多集中在推荐频道分发视频

  • 列表点击直接播放,不进内流,上报组合为video_play和video_over,进入详情页后再上报go_detail,和stay_page,多集中在视频频道等只分发视频的场景

  • 沉浸式内流,上报组合为video_play和video_over ,video_play_auto和video_over_auto,多集中在频道点击后进入沉浸式场景,沉浸式视频可进行自动播

如何区分是报play_auto还是报play

  • 完全取决于视频如何开始播放,比如用户点击视频,视频开始播放,按照play上报

  • 在沉浸式场景,上一个播完,下一个自动播放或者用户滑动列表,停留以后,当前中央位置的视频自动播放,此时都上报play_auto

  • over是否带auto取决于视频是如何开始播放的,如为自动播,就over_auto,如为手动播,就为over

  • 只有用户从视频内流进入了详情页,播放完成时才按照详情页的规范上报

如何理解一个播放流

  • 播放进程的一次启动和关闭,作为一次播放流

  • 因此暂停是不上报over和play的

  • 换到下一个视频,是要上报over和play的

  • 进入详情页,是不上报over和play的