查询单个视频的观看完成度

接口描述

1、查询观众累计观看单个视频的完成度情况
2、数据的查询需要间隔一天,该接口需联系客服开通后才能使用
3、观看完成度=用户观看有效时长/视频时长，例如：视频A时长为50分钟，用户使用PC H5观看了第0~20分钟，又使用APP观看了第10~30分钟，此时用户有效观看时长为30分钟，则完成度为 30/50=60%
4、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
5、接口支持https协议

接口URL

http://api.polyv.net/v2/video/engagement/{userid}/get

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
userid	true	String	保利威点播账户id，可以参考【获取密钥】获取，获取路径：官网->登录->点播（API接口）
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
vid	true	String	视频id
viewerId	true	String	自定义观众id

示例

http://api.polyv.net/v2/video/engagement/1b448be323/get?vid=1b448be3230a0194d959426ae005645f_1%27&viewerId=1555313336634&sign=193CA2727C33AA5B439F2FD55C23C0BBC2DAAB4C&userId=1b448be323&ptime=1617931245211

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	响应成功时返回视频已完成进度比例，响应失败时返回空

返回错误代码列表

错误代码	message	说明
400	sign can not be empty.	加密串为空
400	vid invalid.	视频vid错误
400	ptime is too old.	时间戳过期
400	ptime is illegal.	时间戳参数格式不对或者超过当前时间3分钟
400	Could not find user by userid.	userid不存在
400	the sign is not right.	加密串不正确
400	video not found	视频不存在
400	permission limit	没有权限访问api

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询单个视频的观看完成度
 */
@Test
public void testGetEngageStat() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/engagement/%s/get", userId);
    String vid = "1b448be3230a0194d959426ae005645f_1'";
    String viewerId = "1555313336634";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userId", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vid",vid);
    requestMap.put("viewerId", viewerId);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询单个视频的观看完成度,{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"message": "success",
	"data": 0.33
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}