文档中心

短剧埋点通用说明

最近更新时间：2024.02.02 14:17:34

首次发布时间：2024.02.02 14:17:34

该文档针对短剧合作场景，主要介绍了埋点的通用事件，同时用于开发者自测数据回传是否正确，若自测无误，请务必提供测试包给火山引擎进行埋点验收，避免影响推荐或计费。

事件说明

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

event	事件接口
client_show	曝光
video_play	短剧播放
video_over	短剧时长
video_play_draw	短剧滑动播放
video_over_draw	短剧滑动播放结束

场景说明

1）频道列表页

产品形态	相关截图	事件	上报时机		应上报event	应上报params
产品形态	相关截图	事件	触发方式	预期	应上报event	应上报params
频道列表页		曝光	展现第一个像素	上报	client_show	category：频道名称，即在哪个页面曝光的，列表页：list_category；沉浸式：inner_category。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。
			下拉刷新展现新内容	上报
			上下来回滑动重复展现	不上报
			锁屏或切换后台回来	不上报
频道列表页		短剧播放	点击开始播放	上报	video_play	category：频道名称，即从哪个页面进入短剧详情页的。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。
			暂停后重新播放	不上报
			播放完一遍自动重播	不上报
			锁屏或切换后台回到播放页面	不上报
频道列表页		短剧时长	点击其他内容离开播放页面	上报	video_over	category：频道名称，即从哪个页面进入短剧详情页的。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。 duration：int，实际播放时长，单位ms。 start_progress_duration：int，起始剧情时长，主要是针对退出重新进入，从中途续播的场景，单位ms。 start_percent：int，起始阅读进度，主要是针对退出重新进入，从中途续播的场景。 progress_duration：int，剧情时长，无论倍速播放还是拖动进度条，只取最大进度条的时长，单位ms。 percent：int，最大阅读进度，拖动进度条也算，即progress_duration与视频本身时长的比值*100，上限100。
			暂停播放	不上报
			视频播放完一遍	分情况，如果结束播放（播放下一集或播放广告），就上报；如果是自动重播（像抖音那样），就不上报，直到退出才上报
			锁屏或切换后台	不上报

2）沉浸式内流

产品形态	相关截图	事件	上报时机			应上报event	应上报params
产品形态	相关截图	事件	触发方式	预期	备注	应上报event	应上报params
沉浸式视频内流		曝光	滑动后展现第一个像素	上报		client_show	category：频道名称，即在哪个页面曝光的，列表页：list_category；沉浸式：inner_category。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。
			上下来回滑动重复展现	不上报
			锁屏或切换后台回来	不上报
沉浸式视频内流		短剧滑动播放	在内流滑动进入新的剧集	上报	从列表页点击进入内流，点击的这个剧集上报video_play，而不是video_play_draw	video_play_draw	category：频道名称，即从哪个页面进入短剧详情页的。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。
			播放完一遍自动重播	不上报
			滑动回到刚才看过的剧集	上报
			在剧集列表页面点击其他集的视频	上报
			暂停后重新播放	不上报
沉浸式视频内流		短剧滑动播放	退出播放	上报		video_over_draw	category：频道名称，即从哪个页面进入短剧详情页的。 group_id: bigint，内容id，即一个短剧视频的id。 req_id：string，请求id。 chapter_id： bigint，短剧id，即短剧集合的id，不同集数共同的id。 order：int，短剧集数（第一集就是1）。 is_paid：int，是否解锁（看广告或者支付钻石），1表示解锁，0表示否。 duration：int，实际播放时长，单位ms。 start_progress_duration：int，起始剧情时长，主要是针对退出重新进入，从中途续播的场景，单位ms。 start_percent：int，起始阅读进度，主要是针对退出重新进入，从中途续播的场景。 progress_duration：int，剧情时长，无论倍速播放还是拖动进度条，只取最大进度条的时长，单位ms。 percent：int，最大阅读进度，拖动进度条也算，即progress_duration与视频本身时长的比值*100，上限100。
			滑动进入下一个剧集	上报
			在剧集列表页面点击其他集的视频	上报
			剧集播放完一遍	分情况	如果结束播放（播放下一个剧集或播放广告），就上报；如果是自动重播（像抖音那样），就不上报，直到退出才上报。
			锁屏或切换后台	不上报
			暂停播放	不上报

示例说明

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

操作	截图	上报事件	备注（此处表示相关推荐的埋点加粗）
一、进入频道，此时是在频道列表页，有6个视频展现：短剧1:女总裁XXX 短剧2:别拍XXX …… 短剧7:绝世XXX …… 短剧10：思迁		client_show	上报10条内容的client_show
二、点击短剧6，此时进入沉浸式内流，短剧6第一集开始播放		video_play	短剧6的起播方式是在外流手动点击播放，因此上报video_play
二、向下滑动，此时结束播放第一集自动播放第二集		video_over video_play_draw	由于第一集起播方式是手动点击播放，因此该视频播放结束上报video_over；第二集的起播方式是滑动播放，因此该视频开始播放上报video_play_draw
三、a）向下滑动，此时结束播放第二集自动播放第三集		video_over_draw video_play_draw	由于第二集起播方式是滑动播放，因此该视频播放结束上报video_over_draw；第三集的起播方式是滑动播放，因此该视频开始播放上报video_play_draw
三、b）打开剧集页面，选择第三集（上接步骤二，与“三、a）”是不同的操作方式），此时结束播放第二集自动播放第三集		video_over_draw video_play_draw	由于第二集起播方式是滑动播放，因此该视频播放结束上报video_over_draw；第三集的起播方式是滑动播放（内流统一按照滑动处理），因此该视频开始播放上报video_play_draw

事件说明

场景说明

1）频道列表页

2）沉浸式内流

示例说明

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