サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    CMS API を使用したプレイリストの管理

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

    はじめに

    サンプルプレイリスト

    再生リストを使用すると、関連する一連の動画をグループ化して、プレーヤーに読み込んでグループとして視聴することができます。ザ・CMS APIプレイリストの作成、更新、または削除に使用できる一連の書き込みメソッドが含まれています。

    認証

    への要求には、CMS APIアクセストークンを含む認証ヘッダーが必要です。クライアントクレデンシャルを取得してアクセストークンを取得する方法の詳細については、「 Brightcove OAuth の概要」を参照してください。

    プレイリストを取得

    再生リストの作成に取り掛かる前に、VideoCloudアカウントの既存の再生リストのデータを取得する方法を見てみましょう。

    要求

        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プレイリストのフィールド値。検索フィールドの値は、タグの有効な検索文字列である必要があります検索文字列 CMSAPIの場合。以下は、返されるビデオの説明を含むいくつかの例です。

    サンプル検索文字列
    検索文字列 説明
    +tags:bird 「鳥」というタグが付いた動画を返します
    +tags:bird,woodland 「bird」と「woodland」の両方のタグが付いた動画を返します
    tags: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

    リクエスト本文

    リクエストには、ビデオメタデータフィールドの多く(すべてではありません!)を含めることができます。君はしなければならない少なくともnameそしてtypeプレイリスト用。以下は2つの例です。1つはEXPLICITプレイリストを作成し、もう1つはタイプ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の代わりに)そしてプレイリストIDがURLに追加されます。リクエスト本文のフィールドはまったく同じです。

    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リファレンス