# 修改频道播放器片头广告

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v2/channelAdvert/%7BchannelId%7D/updateHead/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

2、请求参数传入enabled设置开关时，仅设置开关状态，其余设置参数无效

### 请求参数描述

| 参数名                | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ------------------ | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId              | true  | String  | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp          | true  | Long    | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign               | true  | String  | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| enabled            | false | String  | <p>设置开关状态<br>Y：开启<br>N：关闭</p>                                                                                                                                                                             |
| headAdvertType     | false | String  | <p>广告类型<br>NONE：无广告<br>IMAGE：图片广告<br>FLV：视频广告</p>                                                                                                                                                         |
| headAdvertMediaUrl | false | String  | 广告地址                                                                                                                                                                                                      |
| headAdvertHref     | false | String  | 广告跳转地址                                                                                                                                                                                                    |
| headAdvertDuration | false | Integer | 广告时长，单位秒                                                                                                                                                                                                  |
| headAdvertWidth    | false | Integer | 广告宽度                                                                                                                                                                                                      |
| headAdvertHeight   | false | Integer | 广告高度                                                                                                                                                                                                      |

### 示例

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

表单参数：

```requestUrl
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为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                         |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                |
| data    | String  | 请求成功时返回true，失败时返回空字符串                                                                                                            |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

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

异常示例

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