advertisingService

1. Create Video Advertisement

Description

通过上传广告文件及时间范围等参数创建视频广告
接口地址（仅做说明使用）：https://api.polyv.net/v2/advertising/%s/create

Call Constraints

1. API calls are rate-limited. Click for details. For common call exceptions, click here.

Unit Test

    @Test
    public void testCreateAdvertising() throws IOException, NoSuchAlgorithmException {
        VodCreateAdvertisingRequest vodCreateAdvertisingRequest = new VodCreateAdvertisingRequest();
        String vodCreateAdvertisingResponse = null;
        try {
            String filePath = getClass().getResource("/img/cover.jpg").getPath();
            vodCreateAdvertisingRequest.setStartDate(super.getDate(2021, 2, 22))
                    .setEndDate(super.getDate(2021, 3, 22))
                    .setTitle("测试广告")
                    .setFile(new File(filePath))
                    .setSize(2)
                    .setCategoryIds("1")
                    .setLocation(1)
                    .setStatus(10)
                    .setUpTime("00:00:00")
                    .setOffTime("23:59:59")
                    .setNote("测试广告描述")
                    .setSkipAd("Y")
                    .setSkipOffset(1)
                    .setSkipButtonLabel("跳过广告");
            vodCreateAdvertisingResponse = new VodAdvertisingServiceImpl().createAdvertising(
                    vodCreateAdvertisingRequest);
            Assert.assertNotNull(vodCreateAdvertisingResponse);
            if (vodCreateAdvertisingResponse != null) {
                log.debug("测试创建视频广告成功,{}", vodCreateAdvertisingResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Test Description

1. On a correct request, a String object is returned. The B-end processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Input parameter [xxx.chat.VodxxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. If the server encounters an exception, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Error returned from Polyv request, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Returns the video advertisement ID upon successful creation.

2. Query Video Advertisement List

Description

分页查询视频广告列表
接口地址（仅做说明使用）：https://api.polyv.net/v2/advertising/%s/list

Call Constraints

1. API calls are rate-limited. Click for details. For common call exceptions, click here.

Unit Test

    @Test
    public void testGetAdvertisingList() throws IOException, NoSuchAlgorithmException {
        VodGetAdvertisingListRequest vodGetAdvertisingListRequest = new VodGetAdvertisingListRequest();
        VodGetAdvertisingListResponse vodGetAdvertisingListResponse = null;
        try {
            vodGetAdvertisingListRequest.setCurrentPage(1).setPageSize(10);
            vodGetAdvertisingListResponse = new VodAdvertisingServiceImpl().getAdvertisingList(
                    vodGetAdvertisingListRequest);
            Assert.assertNotNull(vodGetAdvertisingListResponse);
            if (vodGetAdvertisingListResponse != null) {
                log.debug("测试查询视频广告列表成功,{}", JSON.toJSONString(vodGetAdvertisingListResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Test Description

1. On a correct request, a VodGetAdvertisingListResponse object is returned. The B-end processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Input parameter [xxx.chat.VodxxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. If the server encounters an exception, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Error returned from Polyv request, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

AdvertisingInfo Parameter Description

3. Update Video Advertisement

Description

通过广告id修改视频广告信息
接口地址（仅做说明使用）：https://api.polyv.net/v2/advertising/%s/edit

Call Constraints

1. API calls are rate-limited. Click for details. For common call exceptions, click here.

Unit Test

    @Test
    public void testUpdateAdvertising() throws IOException, NoSuchAlgorithmException {
        VodUpdateAdvertisingRequest vodUpdateAdvertisingRequest = new VodUpdateAdvertisingRequest();
        Boolean vodUpdateAdvertisingResponse = null;
        try {
            String filePath = getClass().getResource("/img/cover.jpg").getPath();
            vodUpdateAdvertisingRequest.setAdvertisingId("ea7a04430dd04d01853d")
                    .setCategoryIds("1")
                    .setStartDate(super.getDate(2021, 2, 22))
                    .setEndDate(super.getDate(2021, 3, 22))
                    .setTitle("测试广告(Junit测试,勿删)")
                    .setFile(new File(filePath))
                    .setSize(2)
                    .setCategoryIds("1")
                    .setLocation(1)
                    .setStatus(0)
                    .setUpTime("00:00:00")
                    .setOffTime("23:59:59")
                    .setNote("测试广告描述")
                    .setSkipAd("Y")
                    .setSkipOffset(1)
                    .setSkipButtonLabel("跳过广告");
            vodUpdateAdvertisingResponse = new VodAdvertisingServiceImpl().updateAdvertising(
                    vodUpdateAdvertisingRequest);
            Assert.assertTrue(vodUpdateAdvertisingResponse);
            if (vodUpdateAdvertisingResponse) {
                log.debug("测试修改视频广告成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Test Description

1. On a correct request, a Boolean object is returned. The B-end processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Input parameter [xxx.chat.VodxxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. If the server encounters an exception, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Error returned from Polyv request, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

true indicates successful update, false indicates failure.

4. Delete Video Advertisement

Description

通过广告id删除视频广告
接口地址（仅做说明使用）：https://api.polyv.net/v2/advertising/%s/delete

Call Constraints

1. API calls are rate-limited. Click for details. For common call exceptions, click here.

Unit Test

    @Test
    public void testDeleteAdvertising() throws IOException, NoSuchAlgorithmException {
        VodDeleteAdvertisingRequest vodDeleteAdvertisingRequest = new VodDeleteAdvertisingRequest();
        Boolean vodDeleteAdvertisingResponse = null;
        try {
            //准备测试数据
            String advertisingId = super.createAdvertisingOther();
            vodDeleteAdvertisingRequest.setAdvertisingId(advertisingId);
            vodDeleteAdvertisingResponse = new VodAdvertisingServiceImpl().deleteAdvertising(
                    vodDeleteAdvertisingRequest);
            Assert.assertTrue(vodDeleteAdvertisingResponse);
            if (vodDeleteAdvertisingResponse) {
                log.debug("测试删除视频广告成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Test Description

1. On a correct request, a Boolean object is returned. The B-end processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Input parameter [xxx.chat.VodxxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. If the server encounters an exception, a PloyvSdkException is thrown. The error message is available via PloyvSdkException.getMessage(), e.g., [ Error returned from Polyv request, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

true indicates successful deletion, false indicates failure.