查询频道广告列表
接口描述
1、查询频道广告列表信息,如频道广告设置了应用通用设置,则获取全局广告
2、管理系统广告列表设置入口:云直播-我的直播-频道设置-观看页管理-营销-广告
3、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/advert/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
示例
http://api.polyv.net/live/v3/channel/advert/list?appId=frlr1zazn3&sign=141110D7429DAF4EA91A29CE82C4928A&channelId=1958888×tamp=1621844213743
响应参数描述
data字段描述
参数名
类型
说明
text
String
文字广告内容
img
String
图片广告图片地址
href
String
广告跳转链接
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 查询频道广告列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetAdvertList() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/advert/list";
String channelId = "2139283";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道广告列表,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"text": "这是文字广告",
"img": "",
"href": "http://baidu.com"
},
{
"text": "",
"img": "//liveimages.videocc.net/uploaded/images/2021/03/fx0o6uv3wm.jpg",
"href": "http://baidu.com123"
}
]
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Last updated
Was this helpful?