서문
재생 목록을 사용하면 관련 동영상 세트를 함께 그룹화하여 플레이어에로드하여 그룹으로 볼 수 있습니다. 에는 재생목록을 생성, 업데이트 또는 삭제하는 데 사용할 수 있는 쓰기 메서드 세트가CMS API포함되어 있습니다.
인증
에 대한 요청에는 액세스 토큰이 포함된 인증 헤더가CMS API필요합니다. 클라이언트 자격 증명을 얻고 이를 사용하여 액세스 토큰을 검색하는 방법에 대한 자세한 내용은 Brightcove OAuth 개요를 참조하십시오 .
재생 목록 가져 오기
재생 목록을 만들기 전에 Video Cloud 계정에서 기존 재생 목록에 대한 데이터를 검색하는 방법을 살펴 보겠습니다.
요청
https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists
대응
(이limit요청에서 응답을 작게1유지하도록 설정했습니다.)
[
{
"id": "5282200243001",
"account_id": "1752604059001",
"created_at": "2017-01-15T15:30:09.847Z",
"description": "Do not delete",
"favorite": true,
"name": "Playlist for Alltime Views Sample",
"reference_id": null,
"type": "EXPLICIT",
"updated_at": "2017-01-15T17:49:07.633Z",
"video_ids": [
"4825279519001",
"4845831078001",
"4825296720001",
"4454620115001",
"5141730843001",
"4793962133001",
"4454620113001",
"4511340777001",
"5045678909001"
]
}
]
재생 목록 유형
동영상 ID 배열로 포함할 동영상을 지정하는EXPLICIT (수동) 재생목록 유형이 하나 있습니다. 7가지 스마트 재생목록 유형도 있습니다. 스마트 재생목록 유형은 검색 문자열을 사용하여 동적으로 선택된 동영상 세트를 정렬하는 방식이 다릅니다. 아래 표는 모든 재생 목록 유형을 보여줍니다.
| 유형 | 설명 |
|---|---|
EXPLICIT |
수동 재생 목록. 포함 된 동영상과 표시 순서는 동영상 ID 배열로 정의됩니다. |
ACTIVATED_OLDEST_TO_NEWEST |
선택한 동영상이 활성화 날짜 (오름차순)로 정렬 된 스마트 재생 목록입니다. |
ACTIVATED_NEWEST_TO_OLDEST |
선택한 동영상이 활성화 날짜 (내림차순)로 정렬되는 스마트 재생 목록입니다. |
ALPHABETICAL |
선택한 동영상이 이름의 알파벳 순서로 표시되는 스마트 재생 목록입니다. |
PLAYS_TOTAL |
선택한 동영상이 전체 재생 횟수 (내림차순) 순으로 정렬되는 스마트 재생 목록입니다. |
PLAYS_TRAILING_WEEK |
선택한 동영상이 지난주 재생 횟수 (내림차순) 순으로 정렬 된 스마트 재생 목록입니다. |
START_DATE_OLDEST_TO_NEWEST |
선택한 동영상이 예정된 시작일 (오름차순)에 따라 정렬되는 스마트 재생 목록입니다. |
START_DATE_NEWEST_TO_OLDEST |
선택한 동영상이 예정된 시작일 (내림차순)에 따라 정렬되는 스마트 재생 목록입니다. |
검색 필드
모든 스마트 재생목록 유형의 경우 동영상 컬렉션은 재생목록의search필드 값에 따라 동적으로 조합됩니다. 검색 필드 값은 CMS API에 유효한 검색 문자열 값이어야 합니다. 이 유효성 검사는 재생 목록에 설정된search_syntax값 ( v1 [default] 또는v2 ) 에 따라 달라집니다. v2 재생 목록은검색 v2 구문을허용하는 반면 v1 재생 목록은 태그 검색 문자열만 허용합니다. 다음은 반환 할 동영상에 대한 설명이있는 몇 가지 예입니다.
| 검색 문자열 | 설명 |
|---|---|
+tags:bird |
"bird"태그가있는 동영상을 반환합니다. |
+tags:bird,woodland |
"bird"및 "woodland"태그가 모두있는 동영상을 반환합니다. |
tags:bird,woodland |
다음 동영상을 반환합니다. 어느 하나 "bird" 또는 "woodland" 태그의+검색 문자열에서 로그아웃하면 차이가 있음) |
| 검색 문자열 | 설명 |
|---|---|
+tags:bird |
"bird"태그가있는 동영상을 반환합니다. |
+name:bird |
제목에 "bird"가 있는 비디오를 반환합니다. |
(+custom_fields:bird)%20AND%20(NOT%20tags:woodland) |
일부 사용자 정의 필드에 "bird" 값이 있지만 "woodland" 태그가 없는 비디오를 반환합니다. |
재생목록에 동영상 가져오기
counts엔드포인트를 사용하여 재생목록의 동영상 수 (스마트 또는 수동) 를 확인할 수 있습니다.
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
Get Videos in Playlist 요청을 사용하여 비디오 자체를 검색할 수 있습니다. 한 번의 요청으로 최대 100개의 동영상을 반환할 수 있으므로 100개를 초과하려면limit및offset매개 변수를 사용하여 결과를 페이징해야 합니다. 예를 들어 두 번째 100을 얻으려면 다음을 사용합니다.
https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists/videos?limit=100&offset=100
재생 목록 만들기
새 재생 목록을 만들려면 다음을POST요청해야 합니다.
https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists
요청 본문
요청에 비디오 메타 데이터 필드를 많이 (전부는 아님) 포함 할 수 있습니다. 너 ~ 해야 하다적어도name그리고type플레이리스트용. 다음은 두 가지 예입니다. 하나는 EXPLICIT 재생 목록을 만들고, 다른 하나는 두 개의 태그가있는 동영상을 포함하여 ACTIVATED_NEWEST_TO_OLDEST 유형의 스마트 재생 목록을 만듭니다.
EXPLICIT 재생 목록
{
"type": "EXPLICIT",
"name": "My manual playlist",
"video_ids": [
"5289680419001",
"5289693763001",
"5289680417001",
"5288472314001"
]
}
스마트 v1 재생 목록용
{
"type": "ACTIVATED_NEWEST_TO_OLDEST",
"name": "My smart playlist",
"search": "+tags:bird-tags:sea"
}
스마트 v2 재생 목록용
{
"type": "ACTIVATED_NEWEST_TO_OLDEST",
"name": "My smart playlist",
"search": "+name:bird",
"search_syntax": "v2"
}
참조 API 참조재생 목록을 만드는 데 사용할 수 있는 모든 필드에 대해.
재생 목록 업데이트
재생 목록을 업데이트하는 것은 하나를 만드는 것과 매우 유사합니다. 유일한 차이점은 요청 방법 (POST PATCH대신) 과 URL에 추가된 재생 목록 ID입니다. 요청 본문의 필드는 정확히 동일합니다.
요청 URL
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
재생 목록 삭제
재생목록을 삭제하려면 다음DELETE메서드를 사용하여 다음을 요청하세요.
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
(재생 목록을 업데이트하는 데 사용되는 것과 동일한 URL입니다.)