查詢影片播放的觀看比例分佈

更新時間：2025-01-14 16:18:25

介面描述

1、通过视频id和时间范围查询单个视频或全部视频的观看比例统计数据，播放后生成数据需间隔一到两小时
2、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/play-ratio/{userid}

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

2、請求參數中start（開始日期）與end（結束日期）需要同時傳入，僅傳一個參數不生效

3、同時傳入dr（時間段）與start、end的情況下，僅start、end有效；都不傳則dr為預設值7days

請求參數描述

參數名	必選	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值,`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器獲取回應資料`【詳見簽名產生規則】
vid	false	String	影片id，不傳則查詢使用者所有影片的觀看比例統計資料
dr	false	String	時間段，預設值為7days，最近7天 today：今天 yesterday：昨天 this_week：本週 last_week：上週 7days：最近7天 this_month：本月 last_month：上個月 this_year：今年 last_year：去年
start	false	String	開始日期，格式為yyyy-MM-dd，例如：2021-03-01
end	false	String	結束日期，格式為yyyy-MM-dd，例如：2021-04-02

範例

http://api.polyv.net/v2/play-ratio/1b448be323?start=2021-03-01&sign=F287BF9EB23F645CE478A891792AAA00F66F82E0&end=2021-04-02&ptime=1617845079462

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或者500的時候，輔助描述錯誤原因
data	Array	回應成功返回影片觀看比例資料，回應失敗返回空【詳見data欄位說明】

data參數描述

欄位	類型	說明
percentage	String	播放比例範圍，單位百分比
playCount	Integer	播放量

返回錯誤代碼列表

錯誤代碼	message	說明
400	sign can not be empty.	加密串為空
400	vid invalid.	影片id錯誤
400	ptime is too old.	時間戳過期
400	ptime is illegal.	時間戳參數格式不對或者超過當前時間3分鐘
400	Could not find user by userid.	userid不存在
400	the sign is not right.	加密串不正確
401	start and end illegal.	start日期大於end日期

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

強烈建議您使用點播Java SDK完成API的功能對接，點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询视频播放的观看比例分布
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlayTimesByRatio() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("https://api.polyv.net/v2/play-ratio/%s", userId);
    String vid = "1b448be323b8d9b9489dcd7e8e09f087_1";
    String dr = "last_month";
    String start = "2021-03-01";
    String end = "2021-04-02";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("start", start);
    requestMap.put("end", end);
    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": [
    {
      "percentage": "0-10",
      "playCount": 57
    },
    {
      "percentage": "10-20",
      "playCount": 25
    },
    {
      "percentage": "20-30",
      "playCount": 28
    },
    {
      "percentage": "30-40",
      "playCount": 26
    },
    {
      "percentage": "40-50",
      "playCount": 12
    },
    {
      "percentage": "50-60",
      "playCount": 12
    },
    {
      "percentage": "60-70",
      "playCount": 19
    },
    {
      "percentage": "70-80",
      "playCount": 11
    },
    {
      "percentage": "80-90",
      "playCount": 4
    },
    {
      "percentage": "90-100",
      "playCount": 28
    }
  ]
}

異常範例

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