サポート サポート問い合わせ先 | システムステータス システムステータス

再生リストを管理する CMS API

このトピックでは、プレイリストを作成、更新、または削除する方法について説明します。 CMS API.

概要

サンプルプレイリスト

再生リストを使用すると、関連する動画のセットをグループ化して、 player グループで見ました。 の 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の配列として含めるビデオを指定する(手動)プレイリストタイプです。 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。 以下は、返される動画の説明の例です。

サンプル検索文字列
検索文字列 説明
+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

プレイリストを作成する

新しいプレイリストを作成するには、 POST リクエストを実行してあなたのアカウント内のプレイリストの数を取得することもできます:

    https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists

ボディをリクエストする

あなたの要求には、ビデオメタデータフィールドの多くを含めることができます(ただしすべてではありません)。 君は しなければなりません 少なくとも nametype プレイリスト用。 以下に2つの例を示します。1つはEXPLICITプレイリストを作成し、2つ目はタイプACTIVATED_NEWEST_TO_OLDESTのスマートプレイリストを作成します。2つのタグを持つビデオが含まれます。

EXPLICITプレイリスト

    {
      "type": "EXPLICIT",
      "name": "My manual playlist",
      "video_ids": [
        "5289680419001",
        "5289693763001",
        "5289680417001",
        "5288472314001"
      ]
    }

スマートプレイリスト用

    {
      "type": "ACTIVATED_NEWEST_TO_OLDEST",
      "name": "My smart playlist",
      "search": "+tags:bird-tags:sea"
    }

見ます APIリファレンス プレイリストを作成する際に使用できるすべてのフィールドに適用されます。

プレイリストを更新する

プレイリストを更新することは、プレイリストを作成することと非常によく似ています。 唯一の違いはリクエストメソッドです( PATCH POSTの代わりに)、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リファレンス.


ページの最終更新日:27年2020月XNUMX日