You need to enable JavaScript to run this app.
导航
内容管理平台
  • 文档首页
    • /
  • 内容管理平台

小视频埋点说明

最近更新时间：2023.01.12 11:52:13

首次发布时间：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
root_gidlong进入内流场景的第一个视频GroupId
事件说明

频道列表页

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

频道列表页

曝光

展现第一个像素

上报

cms_client_show

req_id：请求id
category_name：场景id
group_id: 内容（文章/视频）id
enter_from：click_category（固定值）
__items：[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special：content_manager_system（固定值）

下拉刷新展现新内容上报
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报

沉浸式内流

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

沉浸式视频内流

视频播放（从列表页进入内流时的第一个视频）

点击开始播放

上报

cms_video_play

req_id：请求id
category_name：场景id
group_id: 内容（文章/视频）id
enter_from：click_category（固定值）
__items：[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special：content_manager_system（固定值）

暂停后重新播放不上报
播放完一遍自动重播不上报
锁屏或切换后台回到播放页面不上报

沉浸式视频内流

视频时长（从列表页进入内流时的第一个视频）

按返回键离开播放页面

上报

cms_video_over

req_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

下滑离开当前内容上报
暂停播放不上报
视频播放完一遍分情况如果结束播放（播放下一个视频或播放广告），就上报；如果是自动重播（像抖音那样），就不上报，直到退出才上报。
锁屏或切换后台不上报

沉浸式视频内流

视频自动播放
上报自动播放的埋点有2种情况：
1、点击tab进入内流（可以认为是抖音那种样式），这种情况下所有内容都上报video_play_draw（自动播）；
2、点击列表页视频进入内流，这种情况下第一个视频上报video_play，向下滑之后的视频（也就是第二个及以后）上报video_play_draw（自动播）

在内流滑动进入新视频

上报

从列表页点击进入内流，点击的这个视频上报video_play，而不是video_play_draw

cms_video_play_draw

root_gid：进入内流场景的第一个视频
req_id：请求id
category_name：场景id
group_id: 内容（文章/视频）id
enter_from：click_category（固定值）
__items：[{\"group_item\":[{\"id\":\"xx\"}]}]
params_for_special：content_manager_system（固定值）

播放完一遍自动重播不上报
滑动回到刚才看过的视频上报
暂停后重新播放不上报

沉浸式视频内流

视频自动播放的时长
上报自动播放的埋点有2种情况：
1、点击tab进入内流（可以认为是抖音那种样式），这种情况下所有内容都上报video_over_draw（自动播）；
2、点击列表页视频进入内流，这种情况下第一个视频上报video_over，向下滑之后的视频（也就是第二个及以后）上报video_over_draw（自动播）

退出播放

上报

cms_video_over_draw

req_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：进入内流场景的第一个视频

滑动进入下一个视频上报
视频播放完一遍分情况如果结束播放（播放下一个视频或播放广告），就上报；如果是自动重播（像抖音那样），就不上报，直到退出才上报。
锁屏或切换后台不上报
暂停播放不上报
上报示例

CASE1：频道列表页 ➡️ 沉浸式内流

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

一、进入频道，此时是在频道列表页，有6个视频展现：

  • 视频1:萌娃XXX

  • 视频2:空间站XXX

  • 视频3:小学生XXX

  • 视频4:吓坏资深教练XXX

  • 视频5:76岁村民XXX

  • 视频6:小奶狗XXX

cms_client_show

  • 上报6条内容的cms_client_show
二、点击视频1，此时进入沉浸式内流，视频1开始播放cms_video_play- 视频1起播方式是在外流手动点击播放，因此上报cms_video_play

二、向下滑动，此时

  • 结束播放视频1

  • 自动播放视频2

  • cms_video_over

  • cms_video_play_draw

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

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

注：从视频2开始，下滑的视频cms_video_play_draw和cms_video_over_draw都需要上报root_gid参数，此处root_gid是入口视频，即「萌娃XXX」该视频的gid

三、向下滑动，此时

  • 结束播放视频2

  • 自动播放视频3

  • cms_video_over_draw

  • cms_video_play_draw

  • 由于视频2起播方式是自动播放，因此该视频播放结束上报cms_video_over_draw；

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

注：从视频2开始，下滑的视频cms_video_play_draw和cms_video_over_draw都需要上报root_gid参数，此处root_gid是入口视频，即「萌娃XXX」该视频的gid

CASE2： 沉浸式内流

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

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

  • 视频1:小橙子XXX

cms_video_play_draw

  • 视频1起播方式是自动播放，因此上报cms_video_play_draw；

二、向下滑动，此时

  • 结束播放视频1

  • 自动播放视频2

cms_video_over_draw
cms_video_play_draw

  • 视频1起播方式是自动播放，因此播放结束时上报cms_video_over_draw；

  • 视频2起播方式是自动播放，因此上报cms_video_play_draw；