获取视频广告列表

接口URL

https://api.polyv.net/v2/advertising/{userId}/list

接口说明

获取广告列表信息。

支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
page false string 第几页,默认第一页
pageSize false string 每页显示几条,默认10条

返回结果

{
code: 200,
status: "success",
message: "",
data: {
    "pageNumber":1,
    "totalItems":1,
    "contents":[
        {
        "adid":"b5c5cff59d994d1fa96a",
        "title":"12",
        "note":"",
        "userid":"e8888b74d1",
        "location":"1",
        "matterurl":"/html/adv/video/e/e8888b74d1/thumb/0ffa61de8aa44bf99c447ff4416c4527.mp4",
        "size":5,
        "addrurl":"http://live.polyv.net",
        "isstatis":2,
        "playnum":0,
        "uptime":-25725000,
        "offtime":57078000,
        "startdate":1508256000000,
        "enddate":1508256000000,
        "ptime":1460443912134,
        "status":10,
        "popuptime":null,
        "poplocation":null,
        "cataids":"1",
        "cataname":"视频分类"
        }
    ],
    "totalPages":1,
    "startRow":1,
    "endRow":1,
    "nextPageNumber":1,
    "prePageNumber":1,
    }
}

失败返回json(不带jsonp)

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

字段描述

字段 说明
adid 广告ID
title 广告标题
note 广告描述
userid 用户ID
location 广告类型(片头1, 暂停2,片尾3,弹窗4)
matterurl 广告素材地址
size 广告时长(s)
playnum 播放次数
addrurl 链接地址
isstatis 广告是否悬浮(是为1,不是为2)
uptime 投放开始时间
offtime 投放结束时间
startdate 投放开始日期
enddate 投放结束日期
ptime 修改时间
status 投放状态(已上线10,待下线1,已下线0)
popuptime 弹窗出现时间
cataids 内容分类
poplocation 弹窗位置(右下角1,右上角2,左下角3,左上角4)

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
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 page is illegal page值非法
400 pageSize is illegal pageSize值非法

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$ptime=time()*1000;//13位
$secretkey="填写secretkey";
$str="ptime=".$ptime.$secretkey;

$hash=strtoupper(sha1($str));
$url="https://api.polyv.net/v2/advertising/$userid/list?ptime=$ptime&sign=$hash";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$output = curl_exec($ch);
curl_close($ch);
//打印获得的数据
print_r($output);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

ptime = "1492591990000"

2、将请求参数按照参数名字典顺序排列

ptime = "1492591990000"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

ptime=1492591990000tIQp4ATe9Z

4、生成签名sign

C2F695EC11A40C5504A883CEB692CA16F80FC2C1
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...