CMS API 播放清單欄位參考

這是 CMS API 傳回的播放清單欄位的參考資料。

主要欄位

表 1：主要欄位
欄位 類型 唯讀 預設 描述
id 串 是 無 播放清單代碼
account_id 串 是 無 帳戶的 ID
created_at 日期時間字符串 是 無 日期時間播放清單新增至帳戶；範例：「二零零四年十二月十一日」
description 串 否 空 播放列表的簡短描述-248 單字節字符最大
favorite 布林 否 假的 播放清單是否包含在我的最愛
limit 數 否 +1000 播放列表可以容納的視頻數量（整數，1 - 1000） 僅返回智能播放列表
name 串 否 無 播放清單標題-必填欄位 (最大長度：248 個單位元組字元)
reference_id 串 否 空 帳戶中唯一的任何值
search 串 否 空 用來定義智慧型播放清單影片的搜尋字串 (例如：「+ 標籤：" 鳥 "、" 鳥 ")
search_syntax 串 否 v1 搜索語法 ( v1 ) 用於智能播放列表搜索字符串 - 請參閱管理播放列表
state 串 是 一個狀態EXPLICIT（手動）播放列表 UPDATING表示該列表正在更新其視頻成員，並且READY表示已添加所有視頻
type 串 是 播放清單類型 見說明[1]下面
updated_at 日期時間字符串 是 無 日期時間播放列表的最新修改； [1-2]例：「第二十一屆」
video_ids 陣列 否 播放清單中影片的 ID 陣列 僅傳回手動播放清單

注意事項

  • [1]

    該type值只能是下列其中之一：明確ACTIVATED_OLDEST_TO_NEWEST、、ACTIVATED_NEWEST_TO_OLDEST、ALPHABETICAL、PLAYS_TOTAL、PLAYS_TRAILING_WEEK、START_DATE_OLDEST_TO_NEWEST，START_DATE_NEWEST_TO_OLDEST

    EXPLICIT意味著它是一個手動播放列表; 所有其他類型都是智能播放列表，名稱對應於他們的排序方案。