You need to enable JavaScript to run this app.
导航

横版短视频埋点通用说明

最近更新时间2023.08.29 14:49:40

首次发布时间2021.04.09 18:31:35

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

注意

埋点上报用于统计用户的实时行为,进而作用于模型训练,进行个性化推荐,建议尽量不要做延迟上报,避免影响推荐效果。

事件说明

说明event和接口的一一对应关系

事件event接口
曝光client_show客户端展现上报
视频播放video_play视频播放开始上报
视频自动播放video_play_auto视频播放开始上报
视频时长video_over视频播放结束上报
视频自动播放的时长video_over_auto视频播放结束上报
点击进入详情页go_detail点击上报
退出详情页stay_page详情页停留时长上报

参数说明

参数定义说明
group_id视频id个性化内容接口返回的group_id字段
duration实际播放时长,单位:ms这里指实际播放的物理时长,播放超过1遍,累加每次播放时长;
计算方法:结束时间戳 - 开始时间戳 - 暂停时长
注意:拖动进度条不算时长,暂停不算时长,
stay_time停留时长,ms只应该统计当前页面停留时长,如退出再返回需重新计时
percent视频播放进度拖动进度条也算,范围(0,100],
计算方法:取进度条时长 / 视频总时长*100,多次播放,取 Max(percent)
举例1: 如果用户已经看完100%,但又继续让视频重复播放,即便第二遍没播放完成,percent仍报100;
举例2: 点击视频A播放(视频总时长60s),现拖动进度条到视频的45s处然后再拖回视频的15s处,percent是45/60*100=75
root_gid进入内流场景的第一个视频
在内流场景“视频自动播放和自动播放的时长“上报会用到此字段
req_id请求唯一标识唯一标识该内容源于哪次请求

场景说明

1)核心场景

a)频道列表页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
频道列表页image.png曝光展现第一个像素上报client_show
group_id: 视频id
req_id:请求唯一标识
下拉刷新展现新内容上报
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报
频道列表页image.png视频播放(手动点击起播)点击开始播放上报video_play
group_id: 视频id
req_id:请求唯一标识
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
频道列表页image.png视频时长(手动点击起播)点击其他内容离开播放页面上报video_over
group_id: 视频id
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
req_id:请求唯一标识
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报
频道列表页image.png视频播放(自动起播)进入频道列表页视频自动播发上报video_play_auto
group_id: 视频id
duration:阅读时长,单位ms
percent:最大阅读进度,拖动进度条也算,多次拖动取最大值,上限100。
req_id:请求唯一标识
滑动屏幕,然后停留在新视频上,开始自动播放上报
滑动回刚才播放过的视频,重新开始播放上报
暂停后重新播放不上报
频道列表页image.png视频时长(自动起播)自动播放的视频退出播放上报video_over_auto
group_id: 视频id
duration:阅读时长,单位ms
percent:最大阅读进度,拖动进度条也算,多次拖动取最大值,上限100。
req_id:请求唯一标识
锁屏或切换后台不上报
暂停播放不上报

b)视频详情页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
视频详情页image.png点击进入详情页点击进入详情页上报go_detail
group_id: 视频id
req_id:请求唯一标识
从相关阅读返回详情页不上报
锁屏或切换后台回到详情页不上报
视频详情页image.png退出详情页退出详情页上报stay_page
group_id: 视频id
stay_time:阅读时长,单位ms
req_id:请求唯一标识
点击其他内容离开详情页上报
锁屏或切换后台不上报
视频详情页image.png视频播放点击开始播放上报video_play
group_id: 视频id
req_id:请求唯一标识
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
视频详情页image.png视频时长按返回键离开播放页面上报video_over
group_id: 视频id
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
req_id:请求唯一标识
点击其他内容离开播放页面上报
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报

c)沉浸式内流

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期备注

沉浸式视频内流
image.png视频播放(从列表页进入内流时的第一个视频)点击开始播放上报video_play
group_id: 视频id
req_id:请求唯一标识
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报

沉浸式视频内流
image.png视频时长(从列表页进入内流时的第一个视频)按返回键离开播放页面上报video_over
group_id: 视频id
duration:阅读时长,单位ms
percent:最大阅读进度,拖动进度条也算,多次拖动取最大值,上限100。
req_id:请求唯一标识
上划视频离开当前内容上报
暂停播放不上报
视频播放完一遍分情况如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报。
锁屏或切换后台不上报

沉浸式视频内流
image.png视频自动播放(1、从列表页进去的那个视频不算,滑动到第二个视频以后才算;
2、点击tab直接进入到内流,不是从列表页点击进入内流)



在沉浸式完成上一个视频的播放,自动开始播放新视频上报在列表页点击视频,进入沉浸式,这时播放的视频不上报video_play_auto,而是video_play。video_play_auto
group_id: 视频id
root_gid:进入内流场景的第一个视频
duration:阅读时长,单位ms
percent:最大阅读进度,拖动进度条也算,多次拖动取最大值,上限100。
req_id:请求唯一标识
滑动屏幕,然后停留在新视频上,开始自动播放上报
全屏之后,点击“下一个”开始播放新视频上报只有部分产品有这个功能
滑动回刚才播放过的视频,重新开始播放上报
暂停后重新播放不上报

沉浸式视频内流
image.png视频自动播放的时长(1、从列表页进去的那个视频不算,滑动到第二个视频以后才算;
2、点击tab直接进入到内流,不是从列表页点击进入内流)
自动播放的视频退出播放上报开始播放时上报video_play_auto的,结束播放时都上报video_over_auto;进入沉浸式时的第一个视频结束或退出时上报video_over。video_over_auto
group_id: 视频id
root_gid:进入内流场景的第一个视频
duration:阅读时长,单位ms
percent:最大阅读进度,拖动进度条也算,多次拖动取最大值,上限100。
req_id:请求唯一标识
锁屏或切换后台不上报
暂停播放不上报

2)相关推荐场景(非必须)

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
相关推荐image.png曝光展现第一个像素上报client_show
group_id: 内容(文章/视频)id
req_id:请求唯一标识
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报
相关推荐image.png视频播放点击开始播放上报video_play
group_id: 视频id
req_id:请求唯一标识
暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报
相关推荐image.png视频时长按返回键离开播放页面上报video_over
group_id: 视频id
duration:播放时长,单位ms
percent:最大播放进度,拖动进度条也算,上限100
req_id:请求唯一标识
点击其他内容离开播放页面上报
暂停播放不上报
视频播放完一遍分情况,如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报
锁屏或切换后台不上报
相关推荐image.png点击进入详情页点击进入详情页上报go_detail
group_id: 内容(文章/视频)id
req_id:请求唯一标识
从相关阅读返回详情页不上报
锁屏或切换后台回到详情页不上报
相关推荐image.png退出详情页退出详情页上报stay_page
group_id: 内容(文章/视频)id
stay_time:阅读时长,单位ms
percent:最大阅读进度,范围0-100
req_id:请求唯一标识
点击其他内容离开详情页上报
锁屏或切换后台不上报

示例说明

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

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


操作

截图

上报事件

备注

一、进入频道列表页,此时有3个视频展现:
内容1:农村90后姑娘XXX
内容2:极星2XXX
内容3:又跌了2万XXX

image.png

client_show

上报3条内容的client_show

二、点击内容1,此时
1.进入内容1的视频详情页;
2.内容1视频开始播放
3.展现了3个相关推荐的内容:
相关视频1:安徽人在佛山XXX
相关视频2:为了生个儿子XXX
相关视频3:广西玉林XXX

image.png

go_detail
video_play
client_show

进入内容1视频详情页时上报go_detail;
内容1该视频起播方式是手动点击播放,因此上报video_play;
相关推荐上报3条内容的client_show

三、点击相关视频1,此时
1.内容1播放结束;
2.离开了内容1的详情页;
3.同时进入相关视频1的详情页;
4.相关视频1开始播放;
5.展现了3个相关推荐的内容:
相关视频1-1:女嫁农村XXX
相关视频1-2:广西猪肉XXX
相关视频1-3:广西30岁XXX

image.png

stay_page
video_over
go_detail
video_play
client_show

离开内容1视频详情页时上报
stay_page;
由于内容1起播方式是手动点击播放,因此该视频播放结束上报video_over;
进入相关视频1的视频详情页时上报go_detail;
相关视频1的起播方式是手动点击播放,因此上报video_play;
相关推荐上报3条内容的client_show

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

起播方式:外流手动点击播放,内流自动播放


操作

截图

上报事件

备注

一、进入频道列表页,此时有2个视频展现:
内容1:56岁高龄产妇XXX
内容2:第一次同居XXX

image.png

client_show

上报2条内容的client_show

二、点击内容1,此时
1.进入沉浸式内流;
2.内容1视频开始播放

image.png

video_play

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

三、滑动列表,停留后,视频2自动播放,此时
1.内容1播放结束;
2.视频2开始播放;

image.png

video_over
video_play_auto

由于内容1起播方式是手动点击播放,因此该视频播放结束上报video_over;
视频2的起播方式是自动播放,因此该视频开始播放上报video_play_auto
注:从视频2开始,下滑的视频video_play_auto和video_over_auto都需要上报root_gid参数,此处root_gid是入口视频,即「56岁高龄产妇XXX」该视频的gid

四、视频2播放结束后,视频3自动播放,此时
1.视频2播放结束;
2.视频3开始播放;

image.png

video_over_auto
video_play_auto

视频2起播方式是自动播放,因此该视频播放结束上报video_over_auto;
视频3的起播方式是自动播放,因此该视频开始播放上报video_play_auto
注:从视频2开始,下滑的视频video_play_auto和video_over_auto都需要上报root_gid参数,此处root_gid是入口视频,即「56岁高龄产妇XXX」该视频的gid

CASE3:频道列表页

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


操作

截图

上报事件

备注

一、进入频道列表页,此时有2个视频展现,且内容1自动播放:
内容1:枕头芯XXX
内容2:炒瘦肉XXX

image.png

client_show
video_play_auto

上报2条内容的client_show
内容1该视频起播方式是自动播放,因此上报video_play_auto;

二、滑动列表,停留后,此时
1.视频1播放结束;
2.视频2自动播放;

image.png

video_over_auto
video_play_auto

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

CASE4:沉浸式内流


操作

截图

上报事件

备注

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

image.png

video_play_auto

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

二、向下滑动,此时
结束播放视频1
自动播放视频2

image.png

video_over_auto
video_play_auto

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