修改頻道播放器片頭廣告

更新時間：2022-09-02 18:08:07

介面描述

1、管理系统设置频道播放器的片头广告：频道管理-观看页设置-营销-广告
2、接口URL中的{channelId}为频道号
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateHead

線上API呼叫

請求方式

POST

介面限制

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

2、請求參數傳入enabled設定開關時，僅設定開關狀態，其餘設定參數無效

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
enabled	false	String	設定開關狀態 Y：開啟 N：關閉
headAdvertType	false	String	廣告類型 NONE：無廣告 IMAGE：圖片廣告 FLV：影片廣告
headAdvertMediaUrl	false	String	廣告位址
headAdvertHref	false	String	廣告跳轉位址
headAdvertDuration	false	Integer	廣告時長，單位秒
headAdvertWidth	false	Integer	廣告寬度
headAdvertHeight	false	Integer	廣告高度

範例

http://api.polyv.net/live/v2/channelAdvert/2191532/updateHead

表單參數：

headAdvertHref=https%3A%2F%2Fbaidu123.com&headAdvertMediaUrl=http%3A%2F%2Fliveimages.videocc.net%2Fuploadimage%2F20210318%2Fchat_img_1b448be323_16160330722736.jpeg&appId=frlr1zazn3&headAdvertWidth=200&headAdvertHeight=200&sign=8AEE1A3F6027F43F36F4205CACA2ECF2&headAdvertType=IMAGE&headAdvertDuration=5&enabled=Y&timestamp=1621844243585

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	請求成功時返回true，失敗時返回空字串

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(PlayerTest.class);
/**
 * 修改频道播放器片头广告
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateHead() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channelAdvert/%s/updateHead";
    String channelId = "2191532";
    String enabled = "Y";
    String headAdvertType = "IMAGE";
    String headAdvertMediaUrl = "http://liveimages.videocc.net/uploadimage/20210318/chat_img_1b448be323_16160330722736.jpeg";
    String headAdvertHref = "https://baidu123.com";
    String headAdvertDuration = "5";
    String headAdvertWidth = "200";
    String headAdvertHeight = "200";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("enabled", enabled);
    requestMap.put("headAdvertType", headAdvertType);
    requestMap.put("headAdvertMediaUrl", headAdvertMediaUrl);
    requestMap.put("headAdvertHref", headAdvertHref);
    requestMap.put("headAdvertDuration", headAdvertDuration);
    requestMap.put("headAdvertWidth", headAdvertWidth);
    requestMap.put("headAdvertHeight", headAdvertHeight);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道播放器片头广告，返回值：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

異常範例

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