はじめに
プレイリストを使用すると、関連する一連の動画をグループ化して、プレーヤーに読み込んでグループとして視聴することができます。 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"
]
}
]
プレイリストの種類
ここに一つの EXPLICIT（手動）プレイリストタイプがあります。ビデオIDの配列として含めるビデオを指定します。スマート プレイリスト タイプは、検索文字列を使用して動的に選択される一連のビデオの順序が異なります。次の表に、すべてのプレイリストタイプを示します。
| タイプ | 説明 |
|---|---|
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 [デフォルト] または v2)に依存します。v2 プレイリストは、search v2 syntax を許可し、v1 プレイリストはタグ検索文字列のみを受け入れます。以下に、いくつかの例と、それらが返す動画の説明を示します。
| 検索文字列 | 説明 |
|---|---|
+tags:bird |
「bird」というタグが付いた動画を返します |
+tags:bird,woodland |
「bird」と「woodland」の両方のタグが付いた動画を返します |
tags:bird,woodland |
「bird」または「woodland」のどちらかを含むビデオを返します。（注：検索文字列から + 記号を省略すると違いが生じます。） |
ビデオの数を取得する
counts エンドポイントを使用して、プレイリスト内の動画のカウントを取得できます（スマートまたは手動のいずれか）：
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
プレイリスト内のビデオの取得 リクエストを使用して、ビデオ自体を取得できます。1 回のリクエストで最大 100 個のビデオが返されるため、100 個を超えるビデオを取得するには、 limit パラメーターと offset パラメーターを使用して結果をページ分割する必要があることに注意して下さい。たとえば、2 番目の 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 を含める必要があります。1つは EXPLICIT プレイリストを作成し、もう1つは 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
詳細はAPIリファレンスをご覧下さい。
プレイリストの削除
プレイリストを削除するには、DELETEメソッドを使って次のようにリクエストする：
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
（これは、プレイリストの更新に使用されるのと同じURLです。）
詳細は、APIリファレンスを参照して下さい。