フォルダーの操作

入門

ビデオライブラリ内のビデオを整理するために使用するフォルダを作成できます。件名、著者、製品、地域など別に動画を整理することができます。フォルダーに動画があると、数百または数千の動画があるアカウントで管理しやすくなります。

フォルダーを作成する

新しいフォルダを作成するために必要な情報は次のとおりです。

URL をリクエスト

作るPOSTリクエスト先：

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

リクエスト本文

      {
        "name": folder_name
      }

応答

レスポンスは次のようになります。

      {
        "id": "5a183efb10ab344b53775441",
        "account_id": "57838016001",
        "created_at": "2017-11-24T15:47:07.867Z",
        "name": "places",
        "updated_at": "2017-11-24T15:47:07.867Z",
        "video_count": 0
      }

フォルダidそしてname（リクエスト本文に設定した名前）は重要です。両方が必要になるためです。フォルダにビデオを追加します。忘れても心配しないでくださいidただし、次の方法でいつでもこの情報を再度取得できるためです。フォルダを取得するアカウント用。

フォルダを取得する

アカウントのフォルダの配列を取得するには、GETリクエスト先：

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

レスポンスは次のようになります。

      [
        {
          "id": "5a17275782aca45b631295f9",
          "account_id": "57838016001",
          "created_at": "2017-11-23T19:53:59.687Z",
          "name": "birds",
          "updated_at": "2017-11-23T20:06:24.537Z",
          "video_count": 1
        },
        {
          "id": "560039e5e4b0e69e4b01cacd",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:09:57.260Z",
          "name": "fish",
          "updated_at": "2017-11-02T19:03:40.751Z",
          "video_count": 4
        },
        {
          "id": "5a183efb10ab344b53775441",
          "account_id": "57838016001",
          "created_at": "2017-11-24T15:47:07.867Z",
          "name": "places",
          "updated_at": "2017-11-24T15:47:07.867Z",
          "video_count": 0
        },
        {
          "id": "560039f1e4b0e69e4b01cad3",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:10:09.422Z",
          "name": "water",
          "updated_at": "2015-09-21T17:22:52.935Z",
          "video_count": 7
        }
      ]

フォルダにビデオを追加する

ビデオをフォルダに追加するには、PUTリクエスト先：

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

リクエスト本文

この操作のリクエストボディはありません。

応答

このリクエストへの応答は204 NO CONTENT。

フォルダからビデオを削除します

フォルダから動画を削除するには、DELETE動画の追加に使用するのと同じURLにリクエストします。

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

リクエスト本文

このリクエストでは、リクエストの本文にフォルダ名も含める必要があります。

      {
        "name": folder_name
      }

フォルダ内のビデオを取得する

フォルダ内のビデオを取得するには、GETリクエスト先：

      https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos

リクエストパラメータ

制限とオフセット

デフォルトでは、このリクエストは、フォルダに最後に追加された20本の動画を返します。これらのパラメーターの一方または両方をリクエストに追加することで、これを変更し、多くのビデオを含むフォルダーの結果をページングできます。

• limit：返される動画の数（デフォルト：20、最大：100）
• offset：スキップするビデオの数（デフォルト：0）

たとえば、このリクエストは、考えられる結果の動画21〜30を返します（フォルダにその数の動画が含まれていると仮定します）。

https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos?limit=10&offset=20

選別

を使用して返されたビデオを並べ替えることもできます選別パラメータ、これらのフィールドのいずれかに等しく設定します。

• name
• reference_id
• updated_at
• created_at
• published_at
• schedule_starts_at
• schedule_ends_at
• state
• Plays_total
• Plays_trailing_week

降順で並べ替えるには、フィールド値の前にマイナスのサイズ（ -created_at）。

のデフォルト値選別は-updated_at。