使用 CMS API 管理播放清單

本主題說明如何使用 CMS API 建立、更新或刪除播放清單。

簡介

播放清單範例

播放列表允許您將一組相關的視頻分組在一起，以便可以將它們加載到播放器中並作為一組觀看。的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 播放列表將允許搜索 v2 語法 , 而 v1 播放列表將只接受標籤搜索字符串。以下是一些示例，說明了它們將返回的視頻。

示例搜索字符串 - v1 播放列表
搜尋字串 描述
+tags:bird 返回標籤為“ bird”的視頻
+tags:bird,woodland 返回同時具有“ bird”和“ woodland”標籤的視頻
tags:bird,woodland 返回具有以下內容的視頻要么標籤“鳥”或“林地”（注意：+退出搜索字符串會有所不同）
示例搜索字符串 - v2 播放列表
搜尋字串 描述
+tags:bird 返回標籤為“ bird”的視頻
+name:bird 返回標題中包含“bird”的視頻
(+custom_fields:bird)%20AND%20(NOT%20tags:woodland) 返回某些自定義字段的值為“bird”但沒有標籤“woodland”的視頻

獲取播放列表中的視頻

您可以使用以下方法在播放列表（智能或手動）中獲得視頻數量counts端點：

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos

您可以使用 “在播放列表中獲取視頻” 請求檢索視頻本身。請注意，一次請求最多可返回 100 個視頻，因此要獲得超過 100 個，您需要使用limit和offset參數。例如，要獲得第二個 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播放列表。以下是兩個示例，一個示例創建一個EXPLICIT播放列表，第二個示例創建一個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參考適用於可用於創建播放列表的所有字段。

更新播放列表

更新播放列表與創建播放列表非常相似。唯一的區別是請求方法（PATCH而不是POST），並且播放列表ID會附加到網址中。請求正文的字段完全相同。

請求網址

    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參考。