Query Channel Ad List

Updated: 2022-09-02 18:08:07

API Description

1、查询频道广告列表信息，如频道广告设置了应用通用设置，则获取全局广告
2、管理系统广告列表设置入口：云直播-我的直播-频道设置-观看页管理-营销-广告
3、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/advert/list

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/advert/list?appId=frlr1zazn3&sign=141110D7429DAF4EA91A29CE82C4928A&channelId=1958888&timestamp=1621844213743

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Array	Empty on failure, contains channel ad information on success See data field description

Data Field Description

Parameter	Type	Description
text	String	Text ad content
img	String	Image ad URL
href	String	Ad redirect link

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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
        
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "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"
        }
    ]
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}