playListService

更新時間：2023-09-22 17:47:34

1、建立播放清單

描述

通过标题创建播放列表
接口地址（仅做说明使用）：https://api.polyv.net/v2/play-list/create

呼叫限制

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

單元測試

    @Test
    public void testCreatePlayList() throws IOException, NoSuchAlgorithmException {
        VodCreatePlayListRequest vodCreatePlayListRequest = new VodCreatePlayListRequest();
        VodCreatePlayListResponse vodCreatePlayListResponse = null;
        try {
            vodCreatePlayListRequest.setTitle("测试播放列表Junit").setDescription("测试描述信息").setTag("测试标签");
            vodCreatePlayListResponse = new VodPlayListServiceImpl().createPlayList(vodCreatePlayListRequest);
            Assert.assertNotNull(vodCreatePlayListResponse);
            if (vodCreatePlayListResponse != null) {
                log.debug("测试创建播放列表成功,{}", JSON.toJSONString(vodCreatePlayListResponse));
            }
        } 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、請求正確，回傳VodCreatePlayListResponse物件，B端依據此物件處理業務邏輯；

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

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

請求入參描述

參數名	必選	類型	說明
title	true	String	標題
description	false	String	描述
tag	false	String	標籤

回傳物件描述

參數名	類型	說明
playListId	String	播放清單ID

2、修改播放清單資訊

描述

通过播放列表id修改播放列表信息
接口地址（仅做说明使用）：https://api.polyv.net/v2/play-list/update

呼叫限制

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

單元測試

    @Test
    public void testUpdatePlayList() throws IOException, NoSuchAlgorithmException {
        VodUpdatePlayListRequest vodUpdatePlayListRequest = new VodUpdatePlayListRequest();
        VodUpdatePlayListResponse vodUpdatePlayListResponse = null;
        try {
            vodUpdatePlayListRequest.setPlayListId("1616396785347").setTitle("测试播放列表(Junit测试_勿删)").setTag("测试标签");
            vodUpdatePlayListResponse = new VodPlayListServiceImpl().updatePlayList(vodUpdatePlayListRequest);
            Assert.assertNotNull(vodUpdatePlayListResponse);
            if (vodUpdatePlayListResponse != null) {
                log.debug("测试修改播放列表信息成功,{}", JSON.toJSONString(vodUpdatePlayListResponse));
            }
        } 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、請求正確，回傳VodUpdatePlayListResponse物件，B端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
playListId	true	String	播放清單ID
title	true	String	標題
description	false	String	描述
tag	false	String	標籤

回傳物件描述

參數名	類型	說明
playListId	String	播放清單ID

3、查詢播放清單資訊

描述

通过播放列表id查询播放列表信息或查询所有播放列表
接口地址（仅做说明使用）：https://api.polyv.net/v2/play-list/list

呼叫限制

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

單元測試

    @Test
    public void testGetPlayListInfo() throws IOException, NoSuchAlgorithmException {
        VodGetPlayListInfoRequest vodGetPlayListInfoRequest = new VodGetPlayListInfoRequest();
        VodGetPlayListInfoResponse vodGetPlayListInfoResponse = null;
        try {
            vodGetPlayListInfoRequest.setPlayListIds("1602299692290,1602299700661");
            vodGetPlayListInfoResponse = new VodPlayListServiceImpl().getPlayListInfo(vodGetPlayListInfoRequest);
            Assert.assertNotNull(vodGetPlayListInfoResponse);
            if (vodGetPlayListInfoResponse != null) {
                log.debug("测试查询播放列表信息成功,{}", JSON.toJSONString(vodGetPlayListInfoResponse));
            }
        } 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、請求正確，回傳VodGetPlayListInfoResponse物件，B端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
playListIds	false	String	播放清單ID，多個以英文逗號分隔，最大1000個，如“1620153765497,1620142496099”
title	false	String	標題，按標題模糊搜尋
currentPage	false	Integer	頁數，預設為1【對應api文件的page欄位】
pageSize	false	Integer	每頁顯示的資料筆數，預設每頁顯示20筆資料

回傳物件描述

參數名	類型	說明
contents	Array	分頁資料【詳見Content參數描述】
pageSize	Integer	每頁顯示的資料筆數，預設每頁顯示20筆資料
currentPage	Integer	目前頁【對應api文件的pageNumber欄位】
totalItems	Integer	記錄總筆數
totalPage	Integer	總頁數【對應api文件的totalPages欄位】

Content參數描述

參數名	類型	說明
id	Long	播放清單ID
description	String	播放清單描述資訊
tag	String	播放清單標籤
title	String	播放清單標題
creationTime	Date	播放清單建立時間，格式為yyyy-MM-dd HH:mm:ss
updateTime	Date	播放清單最近更新時間，格式為yyyy-MM-dd HH:mm:ss
videoCount	Integer	播放清單的影片數量
videoList	Array	播放清單的影片【詳見VideoList參數描述】

VideoList參數描述

參數名	類型	說明
vid	String	影片vid
title	String	影片標題
duration	Float	影片時長，單位：秒
coverURL	String	影片首圖url

4、新增影片至播放清單

描述

通过视频id添加视频至播放列表
接口地址（仅做说明使用）：https://api.polyv.net/v2/play-list/add-video

呼叫限制

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

單元測試

    @Test
    public void testAddVideoToPlayList() throws IOException, NoSuchAlgorithmException {
        VodAddVideoToPlayListRequest vodAddVideoToPlayListRequest = new VodAddVideoToPlayListRequest();
        Boolean vodAddVideoToPlayListResponse = null;
        try {
            vodAddVideoToPlayListRequest.setPlayListId("1616396785347")
                    .setVideoId("1b448be32345b255cabc3fe8d65a4d00_1");
            vodAddVideoToPlayListResponse = new VodPlayListServiceImpl().addVideoToPlayList(
                    vodAddVideoToPlayListRequest);
            Assert.assertTrue(vodAddVideoToPlayListResponse);
            if (vodAddVideoToPlayListResponse) {
                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端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
playListId	true	String	播放清單ID
videoId	true	String	影片ID【對應api文件的vid欄位】

回傳物件描述

null

5、將影片從播放清單移除

描述

通过视频id将视频从播放列表移除
接口地址（仅做说明使用）：https://api.polyv.net/v2/play-list/remove-video

呼叫限制

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

單元測試

    @Test
    public void testRemoveVideoFromPlayList() throws IOException, NoSuchAlgorithmException {
        VodRemoveVideoFromPlayListRequest vodRemoveVideoFromPlayListRequest = new VodRemoveVideoFromPlayListRequest();
        Boolean vodRemoveVideoFromPlayListResponse = null;
        try {
            //准备测试数据
            super.addVideoToPlayListOther();
            vodRemoveVideoFromPlayListRequest.setPlayListId("1616396785347")
                    .setVideoId(super.getTestVideoId());
            vodRemoveVideoFromPlayListResponse = new VodPlayListServiceImpl().removeVideoFromPlayList(
                    vodRemoveVideoFromPlayListRequest);
            Assert.assertTrue(vodRemoveVideoFromPlayListResponse);
            if (vodRemoveVideoFromPlayListResponse) {
                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端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
playListId	true	String	播放清單ID
videoId	true	String	影片ID【對應api文件的vid欄位】

回傳物件描述

null