使用資料夾

在本主題中，您將學習如何將資料夾新增至視訊雲端媒體庫，以及如何使用 CMS API 將視訊新增至資料夾。

簡介

可以創建文件夾來組織視頻庫中的視頻。您可以選擇依主題、作者、產品、地區等來整理影片。將影片放在資料夾中，可讓您在擁有數百或數千部影片的帳戶中輕鬆管理影片。

取得 CMS API 的認證

要使用CMS API您將需要適當的憑據。

在大多數情況下獲取憑據的最簡單方法是通過 Studio Admin API 身份驗證部分（需要您的帳戶的管理員權限）。如需詳細資訊，請參閱管理 API 驗證憑證。在這種情況下，您需要的權限是影片 -您同時需要讀寫權限：

共用關係權限
共用關係權限

如果您需要的權限在 Studio 中不可用，或者您希望直接從 OAuth API 獲取它們，請使用您選擇下面列出的獲取客戶端憑證文檔。無論您選擇哪一個選項，都需要要求正確的操作權限。以下內容可以與 cURL 或郵遞員一起使用以獲得適當的權限：

           "operations": [
           "video-cloud/videos/read",
           "video-cloud/videos/create",
           "video-cloud/videos/update"]

建立資料夾

這是創建新文件夾所需的信息。

請求網址

做一個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

請求參數

limit和offset

默認情況下，此請求將返回最近添加到該文件夾的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

sort

您還可以使用sort參數，將其設置為等於以下任何字段：

  • 名稱
  • 參照 _ 識別碼
  • 更新 (_S)
  • 建立
  • 發佈時
  • schedule_starts_at
  • schedule_ends_at
  • 狀態
  • 總播放次數
  • plays_trailing_week

要按降序排序，請在字段值前加上減號 ( -created_at ).

默認值為sort是-updated_at .