保利威文档中心

幫助中心

查詢某一天的影片觀看日誌

更新時間:2025-01-14 16:21:13

介面說明

1、通过具体时间查询观看日志
2、从播放行为产生到数据可查询的间隔时间为1~2小时
3、响应参数消耗流量(flowSize字段)的计算依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成
4、接口URL中的{userid}为点播账号userid,具体参考【获取密钥】
5、接口支持https协议

介面URL

http://api.polyv.net/v2/data/{userid}/viewlog

線上API呼叫

請求方式

POST

介面限制

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

2、sign(簽名)的拼接規則是:userid=參數&ptime=參數&day=參數secretkey,並和sign一起透過url傳遞

請求參數說明

參數名 必填 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在客戶端直接使用,所有API都必須透過客戶自己伺服器轉發呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
day true String 需查詢日誌資訊的具體時間,格式:yyyyMMdd,例如:20210407
timeStart false String 範圍查詢,需查詢日誌資訊的具體時分秒,格式:HHmmss,例如:000000,timeStart和timeEnd需搭配使用
timeEnd false String 範圍查詢,需查詢日誌資訊的具體時分秒,格式:HHmmss,例如:235959,timeStart和timeEnd需搭配使用
type false String 回傳的資料格式,預設回傳json格式
xml:回傳xml格式
json:回傳json格式
vid false String 影片id
cataid false String 分類id,注意影片id和分類id為空時,取得帳號當天所有影片日誌;當影片id為空、分類id不為空時,查詢對應分類下的日誌;當影片id不為空時查詢對應影片的日誌
sessionId false String 使用者自訂id
viewerId false String 使用者自訂id,當和sessionId同時傳遞時,會以viewerId為準

範例

http://api.polyv.net/v2/data/1b448be323/viewlog

表單參數:

vid=1b448be323615635294a548b3c8a9953_1&sign=AD77F4AFEFA3D3DE07BDD31503A363A21D1A4536&cataid=1602671097888&type=json&ptime=1617847185866&day=20210407

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Array 回應成功時回傳日誌詳細資訊【詳見data欄位說明

data欄位說明

參數名 類型 說明
playId String 表示此次播放動作的id
userId String POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->點播(API介面)
videoId String 影片id
playDuration Integer 播放時長,單位為秒(使用者觀看的總時間,例如:18:00開始看一個影片,看到了18:30,這30分鐘就是播放時長)
stayDuration Integer 緩衝時長,單位為秒
currentTimes Integer 播放時間,單位為秒(使用者觀看的最後時間,例如:停止觀看影片的時候,進度條最後的分鐘數為35分鐘,播放時間就是35分鐘)
duration Integer 影片總時長,單位為秒
flowSize Long 流量大小,單位為位元組
sessionId String 使用者自訂參數,如學員id等
param1/2/3/4/5 String POLYV系統參數
ipAddress String ip位址
country String 國家
province String 省份
city String 城市
isp String ISP電信商
referer String 播放影片頁面網址
userAgent String 使用者裝置
operatingSystem String 作業系統
browser String 瀏覽器
isMobile String 是否為行動端
Y:是
N:否
currentDay String 日誌查詢日期,格式:yyyy-MM-dd
currentHour Integer 日誌建立時間(24小時制小時數),例如:18,表示下午六點建立
viewSource String 使用者觀看管道
vod_ios_sdk:ios端
vod_android_sdk:安卓端
vod_flash:flash
vod_wechat_mini_program:微信小程式
vod_pc_html5:pc端web
vod_mobile_html5:行動端web
vod_mobile_html5_v2:行動端web v2
polyv-android-sdk: 安卓端投屏
polyv-ios-vod-sdk: ios端投屏
vod_wechat_plugin: 小程式插件
createdTime Long 日誌建立時間,13位毫秒級的時間戳
lastModified Long 日誌更新日期,13位毫秒級的時間戳
viewerId String 觀看者id
viewerName String 觀看者名稱

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 testGetDailyViewlog() 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/data/%s/viewlog", userId);
    String day = "20210407";
    String type = "json";
    String vid = "1b448be323615635294a548b3c8a9953_1";
    String cataid = "1602671097888";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("day", day);
    requestMap.put("type", type);
    requestMap.put("vid", vid);
    requestMap.put("cataid", cataid);

    //系统只对部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("userid", userId);
    signMap.put("ptime", ptime);
    signMap.put("day", day);
    requestMap.put("sign", VodSignUtil.getSign(signMap, secretKey));

    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试查询某一天的视频观看日志,{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [{
        "playId": "1617789715498X1074620",
        "userId": "1b448be323",
        "videoId": "1b448be323615635294a548b3c8a9953_1",
        "playDuration": 6,
        "stayDuration": 10,
        "currentTimes": 2,
        "duration": 11,
        "flowSize": 0,
        "sessionId": "",
        "param1": "",
        "param2": "",
        "param3": "",
        "param4": "",
        "param5": "",
        "ipAddress": "xxxxxxx",
        "country": "中国",
        "province": "湖南",
        "city": "长沙",
        "isp": "湖南电信",
        "referer": "https://share.plvideo.cn/front/video/preview?vid=1b448be323615635294a548b3c8a9953_1",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
        "operatingSystem": "Windows",
        "browser": "Chrome",
        "isMobile": "N",
        "currentDay": "2021-04-07",
        "currentHour": 18,
        "createdTime": 1617790069000,
        "lastModified": 1617800772000,
        "viewerId": "",
        "viewerName": "",
        "viewSource": "vod_pc_html5"
    }, {
        "playId": "1617766244609X1752092",
        "userId": "1b448be323",
        "videoId": "1b448be323615635294a548b3c8a9953_1",
        "playDuration": 7,
        "stayDuration": 10,
        "currentTimes": 10,
        "duration": 11,
        "flowSize": 0,
        "sessionId": "",
        "param1": "",
        "param2": "",
        "param3": "",
        "param4": "",
        "param5": "",
        "ipAddress": "xxxxxxx",
        "country": "中国",
        "province": "湖南",
        "city": "长沙",
        "isp": "湖南电信",
        "referer": "https://my.polyv.net/secure/video/",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36 Edg/89.0.774.68",
        "operatingSystem": "Windows",
        "browser": "Chrome",
        "isMobile": "N",
        "currentDay": "2021-04-07",
        "currentHour": 11,
        "createdTime": 1617766571000,
        "lastModified": 1617777096000,
        "viewerId": "",
        "viewerName": "",
        "viewSource": "vod_pc_html5"
    }]
}

異常範例

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