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

图文埋点通用说明

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

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

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

注意

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

事件说明

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

事件event接口
曝光client_show客户端展现上报
点击进入详情页go_detail点击上报
退出详情页stay_page详情页停留时长上报

参数说明

参数定义说明
group_id文章id
stay_time停留时长,ms只应该统计当前页面停留时长,如退出再返回需重新计时
percent图文阅读进度0-100可以根据当前已阅读的高度/文章的总高度计算。
req_id请求唯一标识唯一标识该内容源于哪次请求

场景说明

1)核心场景

a)频道列表页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
频道列表页image.png曝光展现第一个像素上报client_show
group_id: 内容(文章/视频)id
req_id:请求唯一标识
下拉刷新展现新内容上报
上下来回滑动重复展现不上报
锁屏或切换后台回来不上报

b)图文详情页

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
频道列表页image.png点击进入详情页点击进入详情页上报go_detail
group_id: 内容(文章/视频)id
req_id:请求唯一标识
从相关阅读返回详情页不上报
锁屏或切换后台回到详情页不上报
频道列表页image.png退出详情页点击左上角返回键或左划屏幕退出详情页上报stay_page
group_id: 内容(文章/视频)id
stay_time:阅读时长,单位ms
percent:最大阅读进度,范围0-100
req_id:请求唯一标识
点击其他内容离开详情页上报
锁屏或切换后台不上报

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

产品形态相关截图事件上报时机应上报event应上报params
触发方式预期
相关推荐image.png曝光展现第一个像素上报client_show
group_id: 内容(文章/视频)id
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:不穿宇航服XXX
内容2:翻开父母XXX
内容3:鲁迅孙子XXX

image.png

client_show

上报3条内容的client_show

二、点击内容2,此时进入内容2的图文详情页;

image.png

go_detail

进入内容2图文详情页时上报go_detail;

三、不断向下滑动阅读内容,此时文章底部露出相关推荐内容:
相关推荐1:凶险!XXX
相关推荐2:看完震撼XXX
相关推荐3:调查|XXX

image.png

client_show

相关推荐上报3条内容的client_show

四、点击相关推荐1,此时
1.离开内容2的图文详情页。
2.进入相关推荐1的图文详情页;

image.png

stay_page
go_detail

离开内容2的图文详情页时上报
stay_page;
进入相关推荐1的图文详情页时上报go_detail;

五、点击返回按钮,此时退出相关推荐1的图文详情页

image.png

stay_page

离开相关推荐1的图文详情页时上报stay_page;