Create Advertisement

API Description

1、通过分类id为分类下的所有视频创建广告
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

API URL

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

Request Method

POST

API Constraints

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

Request Parameters

Example

http://api.polyv.net/v2/advertising/1b448be323/create

Form parameters:

note=测试广告的描述内容&endDate=2021-4-8&popLocation=1&sign=AD41245052F42EF9D1FE41FA413948AFB60EAFCF&title=接口测试接口广告&skipAd=Y&upTime=09:45:00&cataids=1615286323771&popUpTime=2&skipButtonLabel=跳过&size=4&location=1&offTime=09:50:00&skipOffset=3&ptime=1617759804786&startDate=2021-4-7&status=10

Response Parameters

Error Code List

Java Request Example

For quick integration, please download the related dependency source code. Click here to download source code. After downloading, add it to your own source project. The test case files HttpUtil.java and VodSignUtil.java are included in the download package.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK unifies and optimizes API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(VodVideoAdvertising.class);
/**
 *  创建广告
 */
@Test
public void testAddAdvertising() 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/create", userid);
    String startDate = "2021-4-7";
    String endDate = "2021-4-8";
    String title = "接口测试接口广告";
    String advertisingPath =  getClass().getResource("/file/").getPath() + "advertisement.jpeg";
    File file = new File(advertisingPath);
    String size = "4";
    String cataids = "1615286323771";
    String location = "1";
    String popLocation = "1";
    String popUpTime = "2";
    String status = "10";
    String upTime = "09:45:00";
    String offTime = "09:50:00";
    String note = "测试广告的描述内容";
    String skipAd = "Y";
    String skipOffset = "3";
    String skipButtonLabel = "跳过";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("startDate", startDate);
    requestMap.put("endDate", endDate);
    requestMap.put("title", title);
    Map<String,File> fileMap = new HashMap<>();
    fileMap.put("file",file);
    requestMap.put("size", size);
    requestMap.put("cataids", cataids);
    requestMap.put("location", location);
    requestMap.put("popLocation", popLocation);
    requestMap.put("popUpTime", popUpTime);
    requestMap.put("status", status);
    requestMap.put("upTime", upTime);
    requestMap.put("offTime", offTime);
    requestMap.put("note", note);
    requestMap.put("skipAd", skipAd);
    requestMap.put("skipOffset", skipOffset);
    requestMap.put("skipButtonLabel", skipButtonLabel);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

    String response = HttpUtil.postFile(url, requestMap,fileMap,Constant.UTF8);
    log.debug("测试创建广告,{}", response);
    //do somethings

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}