保利威文档中心

幫助中心

查詢影片播放量排行

更新時間:2025-01-14 16:15:01

介面說明

1、查询视频在不同终端的播放量排行,从播放行为产生到数据可查询的间隔时间为1~2小时
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/videoview/{userid}/ranklist

線上API呼叫

請求方式

GET

介面限制

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

2、當start和end都不為空時,dr失效;當start和end其中一個為空,查詢最近7天資料;當start和end都為空,以dr為準

請求參數說明

參數名 必選 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
start false String 開始日期,格式為yyyy-MM-dd,例如:2019-11-11
end false String 結束日期,格式為yyyy-MM-dd,例如:2019-11-11
dr false String 時間段,預設值為7days
today:今天
yesterday:昨天
7days:最近7天
30days:最近30天

範例

http://api.polyv.net/v2/videoview/1b448be323/ranklist?start=2021-03-01&sign=F378D4041015727EA34C3CC58F9DC83334FA7266&end=2021-04-08&ptime=1617875095741

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回影片播放量排行資訊【詳見data欄位說明
data參數說明
參數名 類型 說明
totalMoVideoView Integer 行動端總播放量
pcVideoDailys Array pc端播放量排行列表陣列【詳見pcVideoDailys欄位說明
moVideoDailys Array 行動端播放量排行列表陣列【詳見moVideoDailys欄位說明
totalPcVideoView Integer pc端總播放量
pcVideoDailys參數說明
參數名 類型 說明
videoId String 影片id
title String 影片標題
duration String 播放時長,格式為:時:分:秒
pcVideoView Integer pc端播放量
mobileVideoView Integer 行動端播放量
moVideoDailys參數說明
參數名 類型 說明
videoId String 影片id
title String 影片標題
duration String 播放時長,格式為:時:分:秒
pcVideoView Integer pc端播放量
mobileVideoView Integer 行動端播放量

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 testGetPlaytimesRank() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/videoview/"+userId+"/ranklist";
    String start = "2021-03-01";
    String end = "2021-04-08";

    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":{
        "totalMoVideoView":0,
        "pcVideoDailys":[
            {
                "videoId":"1b448be32370f4822ac40fd926112a66_1",
                "title":"视频标题",
                "duration":"00:00:45",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be3233659acf35d430ba9210bd4_1",
                "title":"junit-远程批量上传视频",
                "duration":"00:01:25",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323d66f3dae8db5af9f1fdce6_1",
                "title":"a",
                "duration":"00:00:44",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323b452641878b54f21241188_1",
                "title":"合并美食视频",
                "duration":"00:01:06",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a8649edcfea26c0f870def_1",
                "title":"pro_compress-w431sfrmnq.mp4",
                "duration":"00:01:37",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a6a1a6c0c237856f555e88_1",
                "title":"hello,word",
                "duration":"00:00:24",
                "pcVideoView":1,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a146649ad0cc89d0faed9c_1",
                "title":"junit合并并修改_1",
                "duration":"00:03:11",
                "pcVideoView":1,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be3239482977934f099f2ceaa0a_1",
                "title":"测试异步上传视频1",
                "duration":"00:00:17",
                "pcVideoView":1,
                "mobileVideoView":0
            }
        ],
        "moVideoDailys":[
            {
                "videoId":"1b448be32370f4822ac40fd926112a66_1",
                "title":"视频标题",
                "duration":"00:00:45",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be3233659acf35d430ba9210bd4_1",
                "title":"junit-远程批量上传视频",
                "duration":"00:01:25",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323d66f3dae8db5af9f1fdce6_1",
                "title":"a",
                "duration":"00:00:44",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323b452641878b54f21241188_1",
                "title":"合并美食视频",
                "duration":"00:01:06",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a8649edcfea26c0f870def_1",
                "title":"pro_compress-w431sfrmnq.mp4",
                "duration":"00:01:37",
                "pcVideoView":2,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a6a1a6c0c237856f555e88_1",
                "title":"hello,word",
                "duration":"00:00:24",
                "pcVideoView":1,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be323a146649ad0cc89d0faed9c_1",
                "title":"junit合并并修改_1",
                "duration":"00:03:11",
                "pcVideoView":1,
                "mobileVideoView":0
            },
            {
                "videoId":"1b448be3239482977934f099f2ceaa0a_1",
                "title":"测试异步上传视频1",
                "duration":"00:00:17",
                "pcVideoView":1,
                "mobileVideoView":0
            }
        ],
        "totalPcVideoView":13
    }
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}
联系客服,在线咨询