数据回传必读

本文档用来说明埋点对接流程，请按照流程进行埋点对接。

• SDK

• API

全部的埋点参数详见：数据回传参数说明；

客户可结合自身产品的接入场景、内容体裁、产品形态等，选择合适的埋点方案。
1. 确定产品信息

• 接入场景：信息流
• 内容体裁：图文 or 横版短视频 or 竖版小视频 or 专题
• 产品形态：频道列表页/详情页/沉浸式内流/相关推荐
• 跳转逻辑：例如 频道列表页 ➡️ 详情页； 频道列表页 ➡️ 沉浸式内流
• 起播方式：自动起播 or 手动点击起播

产品形态	图示				备注
	图文	横版短视频 （类似西瓜视频）	竖版小视频 （类似抖音）	专题
频道列表页（又称外流/feed流）					通常是单列/双列feed流
详情页
沉浸式内流					沉浸式内流的视频通常自动播放
相关推荐					相关推荐通常出现在图文详情页/短视频详情页

2. 确定埋点事件
图文：图文埋点说明
横版短视频：短视频埋点说明
竖版小视频：小视频埋点说明
专题：专题埋点说明

请结合上述的埋点方案或者火山引擎侧数据分析师为您设计的埋点方案，按照埋点方案中的事件和参数进行埋点开发。

SDK对接

以Android SDK为例：

• 集成合适的SDK，详见 SDK

• 初始化SDK，可配置打印埋点日志，方便查看埋点相关日志，上线可关闭

  config.setLogEnable(true);
  

• 回传参数，详见数据回传参数说明

  • user_unique_id

  AppLog.setUserUniqueID("{{USER_UNIQUE_ID}}");
  

  • events.event 和 events.params

  // 上报event+params
  JSONObject paramsObj = new JSONObject();
  try {
      paramsObj.put("req_id","xxxxx") // 请求推荐接口返回的RequestId
      paramsObj.put("category_name","1rc490"); //事件属性 场景id
      paramsObj.put("duration",20); //事件属性 播放时长 
      ......
  } catch (JSONException e) { 
      e.printStackTrace();
  }
  AppLog.onEventV3("event_name", paramsObj);
  

API对接

详见 API

埋点开发完成后，进行埋点数据自测。内容管理平台提供埋点自测工具，实时高效进行埋点参数验证。

• 回传自测工具路径：控制台 - 高级管理 - 埋点校验
• 选择对应的应用
• 联系火山人员，开通要验证的应用的权限

• 填写待上传的 user_unique_id，点击连接

• 客户端使用上一步建立连接的user_unique_id， 调用埋点接口或SDK进行数据回传上报
• 上报后，点击查询是否回传成功，如下图：
• 对比数据分析师提供的埋点方案，在下图左侧列表自测：埋点字段是否缺失？埋点字段类型是否正确？埋点字段默认值是否正确？

埋点完成后，联系项目经理，打包，移交数据分析师，进行埋点数据准确性校验。

针对要复用管理平台埋点数据，上报到自有数据分析平台进行分析的场景，建议这部分数据走埋点数据双发的链路，分别上报到管理平台+自有数据分析平台。
具体流程：

• 数据回传链路1：

  • 管理平台标准埋点数据上报到管理平台标准数据上报接口（API或SDK）

• 数据回传链路2：

  • 若计划复用管理平台埋点数据，可在不影响「数据回传链路1」的前提下，将管理平台标准埋点数据双发上报到客户自有数据分析平台；

  • 若计划新增埋点以回收更多维度数据用于支持数据分析，新增数据则直接独立上报到客户自有平台即可。

图文
1、percent这个参数是怎么定义的？
A：按照露出的文章面积算，如果划到文章底部上报100。
横版视频
1、横版短视频从频道列表页点击内容进入到沉浸式内流，第一个视频播放上报cms_video_play还是cms_video_play_auto？
A：上报cms_video_play，因为起播方式是用户主动点击内容。
2、横版短视频从频道列表页点击内容进入到沉浸式内流，下滑的第二个视频播放上报cms_video_play还是cms_video_play_auto？
A：上报cms_video_play_auto，因为起播方式是用户下滑后自动播放。
3、横版短视频cms_video_over和cms_video_over_auto怎么区分？
A：如果视频起播上报cms_video_play，那么退出播放上报cms_video_over；如果视频起播上报cms_video_play_auto，那么退出播放上报cms_video_over_auto。
4、如果是横版短视频和竖版小视频混排的场景，埋点该怎么设计？
A：统一按照横版短视频的逻辑上报埋点。
5、横版短视频进入tab页就是沉浸式内流（像抖音那样），第一个视频播放上报cms_video_play还是cms_video_play_auto？
A：上报cms_video_play_auto，因为起播方式是用户进入tab后自动播放。
竖版小视频
1、竖版小视频从频道列表页点击内容进入到沉浸式内流，第一个视频播放上报cms_video_play还是cms_video_play_draw？
A：上报cms_video_play，因为起播方式是用户主动点击内容。
2、竖版小视频从频道列表页点击内容进入到沉浸式内流，下滑的第二个视频播放上报cms_video_play还是cms_video_play_draw？
A：上报cms_video_play_draw，因为起播方式是用户下滑后自动播放。
3、竖版小视频cms_video_over和cms_video_over_draw怎么区分？
A：如果视频起播上报cms_video_play，那么退出播放上报cms_video_over；如果视频起播上报cms_video_play_draw，那么退出播放上报cms_video_over_draw。
4、竖版小视频进入tab页就是沉浸式内流（像抖音那样），第一个视频播放上报cms_video_play还是cms_video_play_draw？
A：上报cms_video_play_draw，因为起播方式是用户进入tab后自动播放。