You need to enable JavaScript to run this app.
导航
内容定制
  • 文档首页
    • /
  • 内容定制

视频播放结束事件上报

最近更新时间：2023.03.30 13:08:04

首次发布时间：2021.10.18 11:12:18

我的收藏

该接口用于视频播放结束事件上报。

请求方式

请求方法

GET/POST(Content-Type: application/x-www-form-urlencoded)

请求url

手动/点击播放时长：
https://mercury.volcengineapi.com/?Action=VideoOverLog&Version=2021-01-01
自动播放时长：
https://mercury.volcengineapi.com/?Action=VideoOverAutoLog&Version=2021-01-01
滑动播放时长：
https://mercury.volcengineapi.com/?Action=VideoOverDrawLog&Version=2021-01-01

请求header

ServiceName:content

请求参数

参数描述类型是否必填说明
Partner渠道号String是
AccessToken用户唯一标识String是
GroupId内容idString是对应“获取个性化内容”接口返回的GroupId
Category频道IDString是对应“获取个性化内容”接口传入的Category值，在相关推荐场景Category固定传related
EventTime事件发生时间String是十位时间戳，单位：秒；表示视频结束播放的时间
Percent最大播放进度String是视频最大的播放进度，拖动进度条也算。取值范围1～100。计算方法：取进度条时长 / 视频总时长*100，多次播放，取 Max(percent)举例1: 如果用户已经看完100%，但又继续让视频重复播放，即便第二遍没播放完成，percent仍报100；举例2: 点击视频A播放（视频总时长60s），现拖动进度条到视频的45s处然后再拖回视频的15s处，percent是45/60*100=75
Duration播放时长String是单位：毫秒，表示本次播放的时长，注意不要累加上次播放的时长。这里指实际播放的物理时长。计算方法：结束时间戳 - 开始时间戳 - 暂停时长注意：拖动进度条不算时长，暂停不算时长
Dt设备型号String否如iphone5s、Galaxy。主要用于推荐分析，提升推荐效果
DeviceBrand设备厂商String否如Apple、Samsung。主要用于推荐分析，提升推荐效果
Os操作系统String否如 Android、IOS。主要用于推荐分析，提升推荐效果。
OsVersion操作系统版本String否如4.0.4。主要用于推荐分析，提升推荐效果。
ClientVersion应用的版本号String否比如1.0.1。主要用于数据排查，提升业务指标
RootGid进入视频内流场景的首个视频idString否在内流的自动播放（VideoPlayAutoLogDemo）和滑动播放（VideoPlayDrawLogDemo）场景需要上报
FromGid相关推荐来源内容idString否相关推荐场景特有，表示从哪条内容点进来的；如在内容A的详情页-->相关推荐曝光的内容有B，C，D，这个时候B，C，D的FromGid均为A
ReqId请求唯一标识String是表示该内容具体是从哪一次请求返回的，便于数据分析。
该值对应公共响应参数中的RequestId

响应参数

参数描述类型说明
Result上报结果Stringsuccess：成功

请求示例

  • 手动/点击播放时长：VideoOverLogDemo
  • 自动播放时长：VideoOverAutoLogDemo
  • 滑动播放时长：VideoOverDrawLogDemo
public static void main(String[] args) {
    //初始化一个service
    LogService logService = LogServiceImpl.getInstance();

    //设置ak，sk 此为请求的凭证
    logService.setAccessKey("xxx");
    logService.setSecretKey("xxx");

    //初始化一个request
    VideoOverLogRequest req = new VideoOverLogRequest();
    req.setPartner("xxx");
    req.setAccessToken("xxx");
    req.setGroupId("6938426748178530823");
    req.setPercent("98");
    req.setDuration("5000");
    req.setCategory("xxx");
    req.setEventTime("1626861782");
    req.setDt("iphone6s");
    req.setOs("iOS");
    req.setOsVersion("12");
    req.setClientVersion("7.3.25");
    req.setDeviceBrand("Apple");
    try {
        LogResponse response = logService.videoOverLog(req);
        System.out.println(JSON.toJSONString(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

响应示例

{
  "ResponseMetadata": {
    "Action": "VideoOverLog",
    "Region": "cn-north-1",
    "RequestId": "202207211149340102020920501E3D5771",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": "success"
}