查詢單一影片的觀看完成度

更新時間：2025-07-03 19:19:56

介面說明

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確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必填	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值,`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
vid	true	String	影片id
viewerId	true	String	自訂觀眾id
queryBySpeed	false	String	是否查詢倍速下的觀看完成度，Y/N，預設為N

範例

http://api.polyv.net/v2/video/engagement/1b448be323/get?vid=1b448be3230a0194d959426ae005645f_1%27&viewerId=1555313336634&sign=193CA2727C33AA5B439F2FD55C23C0BBC2DAAB4C&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("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": ""
}