channelProduct

1、新增頻道商品

描述

添加频道商品库商品
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/add

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

2、當商品類型為普通商品時，商品名稱、商品封面連結、商品實際價格、商品上下架狀態、商品連結類型為必填，並根據商品連結類型傳入對應連結。

3、當商品類型為金融商品時，商品名稱、商品上下架狀態、商品連結類型為必填，並根據商品連結類型傳入對應連結

單元測試

    @Test
    public void testAddChannelProduct() throws IOException, NoSuchAlgorithmException {
        LiveAddProductRequest liveAddProductRequest = new LiveAddProductRequest();
        LiveAddProductResponse liveAddProductResponse;
        try {
            LiveAddProductRequest.ExtObject ext = new LiveAddProductRequest.ExtObject();
            ext.setCoverList(Arrays.asList("https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                    "https://s1.videocc.net/live-admin-v3/assets/img/5c5f0d2242a07f21.svg"));
            LiveAddProductRequest.Video video = new LiveAddProductRequest.Video();
            video.setVideoId("b820ac35dc3bb6be0dcb0841fcb379db");
            video.setVideoSource("MATERIAL_LIBRARY");
            ext.setVideoList(Collections.singletonList(video));
            ext.setJumpWay("POP_UP");
            liveAddProductRequest.setChannelId(super.createChannel())
                    .setName("测试添加普通产品1")
                    .setProductType("normal")
                    .setStatus(1)
                    .setLinkType(11)
                    .setPcLink("http://polyv.net")
                    .setMobileLink("http://polyv.net")
                    .setMobileAppLink("http://polyv.net")
                    .setWxMiniProgramLink("pages/home/index.html")
                    .setCover("https://liveimages.videocc.net/assets/wimages/pc_images/logo.png")
                    .setWxMiniProgramOriginalId("xxxxxxx")
                    .setYield("88")
                    .setFeatures("[\"tab1\", \"tab2\", \"tab3\", \"tab4\"]")
                    .setBtnShow("立即了解")
                    .setProductDesc("测试描述")
                    .setRealPrice(100F)
                    .setParams("{\"code\":123,\"color\":\"red\"}")
                    .setProductDetail("你能够点击购买<br/>为我们购买助力<a href='https://polyv.com'></a>")
                    .setExtObject(ext)
                    .setTagIds("[100,102,103]")
                    .setOriginalPriceType("CUSTOM")
                    .setCustomOriginalPrice("199.00")
                    .setAppId(super.getLiveAppInfo().getAppId())
                    .setAppSecret(super.getLiveAppInfo().getAppSecret());
            liveAddProductResponse = new LiveChannelProductServiceImpl().addChannelProduct(liveAddProductRequest);
            Assert.assertNotNull(liveAddProductResponse);
            if (liveAddProductResponse != null) {
                log.debug("测试添加频道商品成功 {}", JSON.toJSONString(liveAddProductResponse));
            }
        } 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;
        }
    }

單元測試說明

1、請求正確，回傳 LiveAddProductResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

ExtObject參數描述

Video參數描述

回傳物件描述

ExtObject參數描述

Video參數描述

2、修改頻道商品資訊

描述

修改频道商品库商品信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/update

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

2、當商品類型為普通商品時，商品名稱、商品封面連結、商品實際價格、商品上下架狀態、商品連結類型為必填項目，並根據商品連結類型傳入對應的連結。

3、當商品類型為金融商品時，商品名稱、商品上下架狀態、商品連結類型為必填，並根據商品連結類型傳入對應連結

單元測試

    @Test
    public void testUpdateChannelProduct() throws IOException, NoSuchAlgorithmException {
        LiveUpdateProductRequest liveUpdateProductRequest = new LiveUpdateProductRequest();
        Boolean liveUpdateProductResponse;
        try {
            LiveUpdateProductRequest.ExtObject extObject = new LiveUpdateProductRequest.ExtObject()
                    .setCoverList(Arrays.asList("https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                            "https://s1.videocc.net/live-admin-v3/assets/img/5c5f0d2242a07f21.svg"))
                    .setVideoList(Collections.singletonList(new LiveUpdateProductRequest.Video()
                            .setVideoId("b820ac35dc3bb6be0dcb0841fcb379db")
                            .setVideoSource("MATERIAL_LIBRARY")))
                    .setJumpWay("POP_UP");
            String ext = JSON.toJSONString(extObject);
            liveUpdateProductRequest.setChannelId(createChannel())
                    .setProductId(getChannelProductId(createChannel()))
                    .setCover("https://liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg")
                    .setRealPrice(Float.MIN_VALUE)
                    .setName("测试修改普通产品")
                    .setStatus(1)
                    .setProductType("normal")
                    .setLinkType(11)
                    .setPcLink("http://polyv.net")
                    .setMobileLink("http://polyv.net")
                    .setMobileAppLink("http://polyv.net")
                    .setWxMiniProgramLink("pages/home/index.html")
                    .setWxMiniProgramOriginalId("xxxxxxx")
                    .setYield("88.88")
                    .setFeatures("[\"tab1\", \"tab2\", \"tab3\", \"tab4\"]")
                    .setBtnShow("立即了解")
                    .setProductDesc("测试描述")
                    .setParams("{\"code\":123,\"color\":\"red\"}")
                    .setProductDetail("你能够点击购买<br/>为我们购买助力<a href='https://polyv.com'></a>")
                    .setTagIds("[100,102,103]")
                    .setPriceType("CUSTOM")
                    .setCustomPrice("99.00")
                    .setOriginalPriceType("CUSTOM")
                    .setCustomOriginalPrice("199.00")
                    .setExtObject(extObject)
                    .setExt(ext)
                    .setExtObject(null)
                    .setAppId(super.getLiveAppInfo().getAppId())
                    .setAppSecret(super.getLiveAppInfo().getAppSecret());
            liveUpdateProductResponse = new LiveChannelProductServiceImpl().updateChannelProduct(
                    liveUpdateProductRequest);
            Assert.assertTrue(liveUpdateProductResponse);
            if (liveUpdateProductResponse != null) {
                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;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

ExtObject參數描述

Video參數描述

回傳物件描述

null

3、查詢頻道商品庫開關狀態

描述

查询频道商品库开关状态
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/get-enabled

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelProductEnabled() throws IOException, NoSuchAlgorithmException {
        LiveGetProductEnabledRequest liveGetProductEnabledRequest = new LiveGetProductEnabledRequest();
        LiveGetProductEnabledResponse liveGetProductEnabledResponse;
        try {
            liveGetProductEnabledRequest.setChannelId(createChannel());
            liveGetProductEnabledResponse = new LiveChannelProductServiceImpl().getChannelProductEnabled(
                    liveGetProductEnabledRequest);
            Assert.assertNotNull(liveGetProductEnabledResponse);
            if (liveGetProductEnabledResponse != null) {
                //to do something ......
                log.debug("测试查询频道商品库开关状态成功{}", JSON.toJSONString(liveGetProductEnabledResponse));
            }
        } 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;
        }
    }

單元測試說明

1、請求正確，回傳 LiveGetProductEnabledResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求參數說明

回傳物件描述

4、查詢頻道商品列表

描述

获取频道商品库商品列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/list

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelProductList() throws IOException, NoSuchAlgorithmException {
        LiveGetProductListRequest liveGetProductListRequest = new LiveGetProductListRequest();
        LiveGetProductListResponse liveGetProductListResponse;
        try {
            liveGetProductListRequest.setChannelId(createChannel()).setCurrentPage(1).setPageSize(2);
            liveGetProductListResponse = new LiveChannelProductServiceImpl().getChannelProductList(
                    liveGetProductListRequest);
            Assert.assertNotNull(liveGetProductListResponse);
            if (liveGetProductListResponse != null) {
                //to do something ......
                log.debug("测试查询频道商品列表成功{}", JSON.toJSONString(liveGetProductListResponse));
            }
        } 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;
        }
    }

單元測試說明

1、請求正確，回傳 LiveGetProductListResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因：invalid signature. ]

請求參數說明

回傳物件描述

channelProductList參數描述

5、修改頻道商品庫開關狀態

描述

修改频道商品库商品列表开关状态，开启后，观看页将展示商品列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/update-enabled

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelProductEnabled() throws IOException, NoSuchAlgorithmException {
        LiveUpdateProductEnabledRequest liveUpdateProductEnabledRequest = new LiveUpdateProductEnabledRequest();
        Boolean liveUpdateProductEnabledResponse;
        try {
            liveUpdateProductEnabledRequest.setChannelId(createChannel()).setEnabled("Y");
            liveUpdateProductEnabledResponse = new LiveChannelProductServiceImpl().updateChannelProductEnabled(
                    liveUpdateProductEnabledRequest);
            Assert.assertTrue(liveUpdateProductEnabledResponse);
            if (liveUpdateProductEnabledResponse) {
                //to do something ......
                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;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因：invalid signature. ]

請求入參說明

回傳物件描述

true 表示修改成功，false 表示修改失敗

6、修改頻道商品庫上下架狀態

描述

修改频道商品库商品上下架状态
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/shelf

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testShelfChannelProduct() throws IOException, NoSuchAlgorithmException {
        LiveShelfChannelProductRequest liveShelfChannelProductRequest = new LiveShelfChannelProductRequest();
        Boolean liveShelfChannelProductResponse;
        try {
            liveShelfChannelProductRequest.setChannelId(createChannel())
                    .setProductId(super.getChannelProductId(createChannel()))
                    .setShelf(1);
            liveShelfChannelProductResponse = new LiveChannelProductServiceImpl().shelfChannelProduct(
                    liveShelfChannelProductRequest);
            Assert.assertTrue(liveShelfChannelProductResponse);
            if (liveShelfChannelProductResponse) {
                //to do something ......
                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;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic不能為空 / msg不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

回傳物件描述

true 表示修改成功，false 表示修改失敗

7、推送頻道商品庫商品

描述

推送频道商品库商品
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/push-product

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

2、僅商品為上架狀態才可進行推送

單元測試

    @Test
    public void testPushChannelProduct() throws IOException, NoSuchAlgorithmException {
        LivePushProductRequest livePushProductRequest = new LivePushProductRequest();
        Boolean livePushProductResponse;
        try {
            livePushProductRequest.setChannelId(createChannel())
                    .setProductId(super.getChannelProductId(createChannel()));
            livePushProductResponse = new LiveChannelProductServiceImpl().pushChannelProduct(livePushProductRequest);
            Assert.assertTrue(livePushProductResponse);
            if (livePushProductResponse) {
                //to do something ......
                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;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

回傳物件描述

true 表示推送成功，false 表示推送失敗

8、修改頻道商品庫列表順序

描述

修改商品库商品列表顺序
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/sort

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

2、排序在第一位的項目無法執行上移操作，最後一位無法執行下移操作

單元測試

    @Test
    public void testSortChannelProduct() throws IOException, NoSuchAlgorithmException {
        LiveSortChannelProductRequest liveSortChannelProductRequest = new LiveSortChannelProductRequest();
        Boolean liveSortChannelProductResponse;
        try {
            liveSortChannelProductRequest.setChannelId(createChannel())
                    .setProductId(super.getChannelProductId(createChannel()))
                    .setType(20);
            liveSortChannelProductResponse = new LiveChannelProductServiceImpl().sortChannelProduct(
                    liveSortChannelProductRequest);
            Assert.assertTrue(liveSortChannelProductResponse);
            if (liveSortChannelProductResponse) {
                //to do something ......
                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;
        }
    }

單元測試說明

1、請求正確時，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數校驗不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件校驗失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

回傳物件描述

true 表示修改成功，false 表示修改失敗

9、刪除頻道商品

描述

删除频道商品库商品
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/product/delete

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testDeleteChannelProduct() throws IOException, NoSuchAlgorithmException {
        LiveDeleteChannelProductRequest liveDeleteChannelProductRequest = new LiveDeleteChannelProductRequest();
        Boolean liveDeleteChannelProductResponse;
        try {
            //准备测试数据
            Integer productId = super.getChannelProductId(createChannel());
            liveDeleteChannelProductRequest.setChannelId(createChannel()).setProductId(productId);
            liveDeleteChannelProductResponse = new LiveChannelProductServiceImpl().deleteChannelProduct(
                    liveDeleteChannelProductRequest);
            Assert.assertTrue(liveDeleteChannelProductResponse);
            if (liveDeleteChannelProductResponse) {
                //to do something ......
                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;
        }
    }
}

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求參數說明

回傳物件描述

true 表示刪除成功，false 表示刪除失敗