查詢廣告列表

介面描述

1、分页获取广告列表详情
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/advertising/{userid}/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

範例

http://api.polyv.net/v2/advertising/1b448be323/list?sign=06423AE4F3EE1959F29E5723A43F731897B0B6F8&pageSize=1&page=1&ptime=1617777684134

回應參數描述

Data參數描述

Contents參數描述

返回錯誤代碼列表

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoAdvertising.class);
/**
 *  查询广告列表
 */
@Test
public void testGetAdvertising() 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/advertising/%s/list", userid);
    String page = "1";
    String pageSize = "2";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    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": {
        "pageNumber": 1,
        "totalItems": 18,
        "contents": [{
            "adid": "ea7a04430dd04d01853d",
            "title": "测试广告(Junit测试,勿删)",
            "note": "测试广告描述",
            "userid": "1b448be323",
            "location": "1",
            "matterurl": "/1b448be323/html/adv/image/1/1b448be323/thumb/5439a04e5f6c40a290822eb4b2d3086c.jpg",
            "size": 2,
            "addrurl": "https://baidu.com",
            "isstatis": 2,
            "cpmplay": 0,
            "desccpmplay": 1200,
            "playnum": 0,
            "uptime": -28800000,
            "offtime": 57599000,
            "startdate": 1616342400000,
            "enddate": 1619020800000,
            "province": "all",
            "country": "",
            "ptime": 1619740895366,
            "status": 0,
            "width": 0,
            "height": 0,
            "doublenum": 0,
            "errornum": 0,
            "popuptime": null,
            "poplocation": -1,
            "cataids": "1",
            "skiptime": 1,
            "skipbutton": "跳过广告",
            "skipenabled": "Y",
            "cataname": "视频",
            "advurl": "http://img.videocc.net/1b448be323/html/adv/image/1/1b448be323/thumb/5439a04e5f6c40a290822eb4b2d3086c.jpg"
        }, {
            "adid": "db56c968c10e4c76a758",
            "title": "测试广告-弹窗",
            "note": "测试广告描述",
            "userid": "1b448be323",
            "location": "4",
            "matterurl": "/1b448be323/html/adv/image/1/1b448be323/thumb/2373551d8e4841be88a4860d8b52ea3d.jpg",
            "size": 2,
            "addrurl": null,
            "isstatis": 2,
            "cpmplay": -1,
            "desccpmplay": 0,
            "playnum": 0,
            "uptime": -28800000,
            "offtime": 57599000,
            "startdate": 1616342400000,
            "enddate": 1619020800000,
            "province": null,
            "country": null,
            "ptime": 1619418030516,
            "status": 10,
            "width": 0,
            "height": 0,
            "doublenum": 0,
            "errornum": 0,
            "popuptime": "2",
            "poplocation": 4,
            "cataids": "1",
            "skiptime": 1,
            "skipbutton": "跳过广告",
            "skipenabled": "N",
            "cataname": "视频",
            "advurl": "http://img.videocc.net/1b448be323/html/adv/image/1/1b448be323/thumb/2373551d8e4841be88a4860d8b52ea3d.jpg"
        }],
        "nextPageNumber": 2,
        "prePageNumber": 1,
        "startRow": 1,
        "activePageNum": 1,
        "firstPage": true,
        "lastPage": false,
        "totalPages": 9,
        "endRow": 2,
        "limit": 2,
        "offset": 0
    }
}

異常範例

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