该文档针对竖版小视频场景,主要介绍了数据回传的通用事件,参数,上报示例等,同时用于开发者自测数据回传是否正确,自测方式参见验证数据回传,若自测无误,请务必提供APP给火山引擎进行埋点验收,否则影响推荐效果!
注意
埋点上报用于统计用户的实时行为,进而作用于模型训练,进行个性化推荐,建议尽量不要做延迟上报,避免影响推荐效果。
事件 | event | 接口 |
---|---|---|
曝光 | client_show | SingleShowLog - 单条内容曝光上报 MultiShowLog- 多条内容曝光上报 |
视频播放 | video_play | VideoPlayLog - 视频手动点击播放上报 |
视频播放(下滑自动起播) | video_play_draw | VideoPlayDrawLog - 视频滑动播放上报 |
视频时长 | video_over | VideoOverLog - 手动点击播放时长上报 |
视频时长(下滑自动起播) | video_over_draw | VideoOverDrawLog - 滑动播放时长上报 |
参数 | 定义 | 说明 |
---|---|---|
GroupId | 视频id | 个性化内容接口返回的GroupId字段 |
Duration | 实际播放时长 | 这里指实际播放的物理时长,播放超过1遍,累加每次播放时长; 计算方法:结束时间戳 - 开始时间戳 - 暂停时长 注意:拖动进度条不算时长,暂停不算时长,单位:ms |
Percent | 视频播放进度 | 拖动进度条也算,范围(0,100], 计算方法:取进度条时长 / 视频总时长*100,多次播放,取 Max(Percent) 举例1: 如果用户已经看完100%,但又继续让视频重复播放,即便第二遍没播放完成,Percent仍报100; 举例2: 点击视频A播放(视频总时长60s),现拖动进度条到视频的45s处然后再拖回视频的15s处,Percent是45/60*100=75 |
RootGid | 进入内流场景的第一个视频 | 在内流场景“视频自动播放和自动播放的时长“上报会用到此字段 |
ReqId | 请求唯一标识 | 唯一标识该内容源于哪次请求 |
产品形态 | 相关截图 | 事件 | 上报时机 | 应上报event | 应上报params | |
触发方式 | 预期 | |||||
频道列表页 | 曝光 | 展现第一个像素 | 上报 | client_show | GroupId: 视频id ReqId:请求唯一标识 | |
下拉刷新展现新内容 | 上报 | |||||
上下来回滑动重复展现 | 不上报 | |||||
锁屏或切换后台回来 | 不上报 |
产品形态 | 相关截图 | 事件 | 上报时机 | 应上报event | 应上报params | ||
---|---|---|---|---|---|---|---|
触发方式 | 预期 | 备注 | |||||
沉浸式视频内流 | 视频播放(从列表页进入内流时的第一个视频) | 点击开始播放 | 上报 | video_play | GroupId: 视频id | ||
暂停后重新播放 | 不上报 | ||||||
播放完一遍自动重播 | 不上报 | ||||||
锁屏或切换后台回到播放页面 | 不上报 | ||||||
沉浸式视频内流 | 视频时长(从列表页进入内流时的第一个视频) | 按返回键离开播放页面 | 上报 | video_over | GroupId: 视频id | ||
下滑离开当前内容 | 上报 | ||||||
暂停播放 | 不上报 | ||||||
视频播放完一遍 | 分情况 | 如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报。 | |||||
锁屏或切换后台 | 不上报 | ||||||
沉浸式视频内流 | 曝光 | 展现第一个像素 | 上报 | client_show | GroupId: 视频id | ||
上下来回滑动重复展现 | 不上报 | ||||||
锁屏或切换后台回来 | 不上报 | ||||||
沉浸式视频内流 | 视频自动播放 | 在内流滑动进入新视频 | 上报 | 从列表页点击进入内流,点击的这个视频上报video_play,而不是video_play_draw | video_play_draw | GroupId: 视频id | |
播放完一遍自动重播 | 不上报 | ||||||
滑动回到刚才看过的视频 | 上报 | ||||||
暂停后重新播放 | 不上报 | ||||||
沉浸式视频内流 | 视频自动播放的时长 | 退出播放 | 上报 | video_over_draw | GroupId: 视频id | ||
滑动进入下一个视频 | 上报 | ||||||
视频播放完一遍 | 分情况 | 如果结束播放(播放下一个视频或播放广告),就上报;如果是自动重播(像抖音那样),就不上报,直到退出才上报。 | |||||
锁屏或切换后台 | 不上报 | ||||||
暂停播放 | 不上报 |
操作 | 截图 | 上报事件 | 备注 |
---|---|---|---|
一、进入频道,此时是在频道列表页,有6个视频展现: 视频1:萌娃XXX 视频2:空间站XXX 视频3:小学生XXX 视频4:吓坏资深教练XXX 视频5:76岁村民XXX 视频6:小奶狗XXX | client_show | 上报6条内容的client_show | |
二、点击视频1,此时进入沉浸式内流,视频1开始播放 | video_play | 视频1起播方式是在外流手动点击播放,因此上报video_play | |
二、向下滑动,此时 结束播放视频1 自动播放视频2 | video_over video_play_draw | 由于视频1起播方式是手动点击播放,因此该视频播放结束上报video_over; 视频2的起播方式是自动播放,因此该视频开始播放上报video_play_draw 注:从视频2开始,下滑的视频video_play_draw和video_over_draw都需要上报RootGid参数,此处RootGid是入口视频,即「萌娃XXX」该视频的gid | |
三、向下滑动,此时 结束播放视频2 自动播放视频3 | video_over_draw video_play_draw | 由于视频2起播方式是自动播放,因此该视频播放结束上报video_over_draw; 视频3的起播方式是自动播放,因此该视频开始播放上报video_play_draw 注:从视频2开始,下滑的视频video_play_draw和video_over_draw都需要上报RootGid参数,此处RootGid是入口视频,即「萌娃XXX」该视频的gid |
操作 | 截图 | 上报事件 | 备注 |
---|---|---|---|
一、进入频道,此时是沉浸式内流样式,自动播放视频1: 视频1:小橙子XXX | video_play_draw | 视频1起播方式是自动播放,因此上报video_play_draw; | |
二、向下滑动,此时 结束播放视频1 自动播放视频2 | video_over_draw video_play_draw | 视频1起播方式是自动播放,因此播放结束时上报video_over_draw; 视频2起播方式是自动播放,因此上报video_play_draw; |