查询广告列表

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
userid	true	String	保利威点播账户id，可以参考【获取密钥】获取，获取路径：官网->登录->点播（API接口）
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
page	false	String	第几页，默认第一页
pageSize	false	String	每页显示几条，默认10条

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	响应成功时返回广告信息【详见Data字段说明】，响应失败时返回空

Data参数描述

字段	类型	说明
pageNumber	Integer	当前的页数
totalItems	Integer	总的条数
contents	Array	查询的结果列表【详见Contents字段说明】
firstPage	Boolean	是否为第一页，值为：true/false
lastPage	Boolean	是否为最后一页，值为：true/false
nextPageNumber	Integer	下一页编号
prePageNumber	Integer	上一页编号
totalPages	Integer	总页数
startRow	Integer	当前页第一条记录在总记录中的位置
endRow	Integer	当前页最后一条记录在总记录中的位置
limit	Integer	当前页记录个数
activePageNum	Integer	实际页码
offset	Integer	分页起始记录

Contents参数描述

字段	类型	说明
adid	String	广告id
title	String	广告标题
note	String	广告描述
userid	String	用户ID
location	String	广告类型 1：片头 2：暂停 3：片尾 4：弹窗
matterurl	String	广告素材地址
size	Integer	广告时长，单位秒
playnum	Integer	广告播放次数
addrurl	String	广告点击链接
isstatis	Integer	广告是否悬浮 1：是 2：不是
uptime	Long	广告开始时间，8位毫秒级时间戳
offtime	Long	广告结束时间，8位毫秒级时间戳
startdate	Long	广告投放开始日期，13位毫秒级时间戳
enddate	Long	广告投放结束日期，13位毫秒级时间戳
ptime	Long	修改时间，13位毫秒级时间戳
status	Integer	广告状态 10：已上线 1：待上线 0：已下线
popuptime	Long	广告弹窗出现时间
cataids	Long	分类id，多个分类id，以英文逗号分隔，默认值为1，1是默认分类
poplocation	Integer	广告弹窗位置，当请求参数location为弹窗时必填 1：右下角 2：右上角 3：左下角 4：左上角
skiptime	String	多少秒后允许跳过，仅片头广告有效
skipbutton	String	跳过按钮标签名称，默认为跳过，仅片头广告有效
skipenabled	String	跳过按钮状态，仅片头广告有效 Y：开启跳过广告 N：关闭跳过广告
cataname	String	分类名称，多个以英文逗号分隔，默认值为1，1是默认分类

返回错误代码列表

错误代码	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值非法

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": ""
}