支持 聯繫支持 | 系統狀況 系統狀態

使用來管理播放列表 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數組包含的視頻。 智能播放列表類型也有七種-智能播放列表類型的區別在於,它們如何排序使用搜索字符串動態選擇的一組視頻。 下表顯示了所有播放列表類型。

播放清單類型
類型 產品描述
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 返回具有以下內容的視頻 標籤“鳥”或“林地”(注意: + 退出搜索字符串會有所不同)

獲取視頻數量

您可以使用以下方法在播放列表(智能或手動)中獲得視頻數量 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 播放列表。 以下是兩個示例,一個示例創建一個EXPLICIT播放列表,第二個示例創建一個ACTIVATED_NEWEST_TO_OLDEST類型的智能播放列表,其中包括帶有兩個標籤的視頻:

對於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會附加到網址中。 請求正文的字段完全相同。

要求網址

    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日