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

详情页停留时长上报

最近更新时间：2023.02.28 17:57:49

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

我的收藏

该接口用于退出图文、短视频详情页的事件上报。

请求方式

请求方法

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

请求url

https://mercury.volcengineapi.com/?Action=StayLog&Version=2021-01-01

请求header

ServiceName:content

请求参数

参数描述类型是否必填说明
Partner渠道号String是
AccessToken用户唯一标识String是
GroupId内容idString是对应“获取个性化内容”接口返回的GroupId
StayTime停留时长String是表示在详情页停留的时长，单位：毫秒;只应该统计当前页面停留时长，如退出再返回需重新计时
Category频道IDString是对应“获取个性化内容”接口传入的Category值，在相关推荐场景Category固定传related
EventTime事件发生时间String是十位时间戳，单位：秒；表示点击退出详情页事件发生时的时间
Percent最大阅读进度String是表示图文内容的最大阅读进度，取值范围1～100。根据当前已阅读的高度/内容的总高度计算。
Dt设备型号String否如iphone5s、Galaxy。主要用于推荐分析，提升推荐效果
DeviceBrand设备厂商String否如Apple、Samsung。主要用于推荐分析，提升推荐效果
Os操作系统String否如 Android、IOS。主要用于推荐分析，提升推荐效果。
OsVersion操作系统版本String否如4.0.4。主要用于推荐分析，提升推荐效果。
ClientVersion应用的版本号String否比如1.0.1。主要用于数据排查，提升业务指标
FromGid相关推荐来源内容idString否相关推荐场景特有，表示从哪条内容点进来的；如在内容A的详情页-->相关推荐曝光的内容有B，C，D，这个时候B，C，D的FromGid均为A
ReqId请求唯一标识String是表示该内容具体是从哪一次请求返回的，便于数据分析。
该值对应公共响应参数中的RequestId

响应参数

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

请求示例

public static void main(String[] args) {
    //初始化一个service
    LogService logService = LogServiceImpl.getInstance();

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

    //初始化一个request
    StayLogRequest req = new StayLogRequest(); 
    req.setPartner("xxx");
    req.setAccessToken("xxx");
    req.setGroupId("6938426748178530823");
    req.setStayTime("5000");
    req.setPercent("98");
    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.stayLog(req);
        System.out.println(JSON.toJSONString(response));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

响应示例

{
  "ResponseMetadata": {
    "Action": "StayLog",
    "Region": "cn-north-1",
    "RequestId": "202207211112080102121992122247B050",
    "Service": "content",
    "Version": "2021-01-01"
  },
  "Result": "success"
}

常见问题

说明

Q：详情页默认是折叠的，需要点击“展开全文”才能查看内容，如何计算Percent？
A：火山引擎H5详情页会在iframe onload的时机下，向客户H5壳子以postMessage的方式同步内容总高度（分母），客户侧需自主计算已阅读的内容高度（分子），Percent=已阅读高度/内容总高度。