Playlists

playlist 資源代表 YouTube 播放清單。播放清單是一組可以依序觀看的影片,並且可以與其他使用者分享。預設情況下,其他使用者能看到播放清單,但播放清單可以是公開或私人。

YouTube 也會利用播放清單來識別頻道的特殊影片集合,例如:

  • 上傳的影片
  • 評分良好 (喜歡) 的影片
具體而言,這類清單會與頻道建立關聯,也就是一組使用者、團體或公司的影片、播放清單和其他 YouTube 資訊。您可以從特定頻道的 channel resource 擷取這些清單的播放清單 ID。

接著,您可以使用 playlistItems.list 方法擷取任一清單。您也可以呼叫 playlistItems.insertplaylistItems.delete 方法,在這些清單中新增或移除項目。

方法

這個 API 支援下列 playlists 資源方法:

list
傳回一組符合 API 要求參數的播放清單。舉例來說,您可以擷取已驗證使用者擁有的所有播放清單,或是依照專屬 ID 擷取一或多個播放清單。立即試用
插入
建立播放清單。 立即試用
更新
修改播放清單。例如,您可以變更播放清單的標題、說明或隱私設定。立即試用
刪除
刪除播放清單。 立即試用

資源表示法

下列 JSON 結構顯示 playlists 資源的格式:

{
  "kind": "youtube#playlist",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    }
  },
  "status": {
    "privacyStatus": string
  },
  "contentDetails": {
    "itemCount": unsigned integer
  },
  "player": {
    "embedHtml": string
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

屬性

下表定義了這項資源中顯示的屬性:

屬性
kind string
識別 API 資源的類型。值為 youtube#playlist
etag etag
這項資源的 Etag。
id string
YouTube 用來識別播放清單的 ID。
snippet object
snippet 物件包含播放清單的基本詳細資料,例如標題和說明。
snippet.publishedAt datetime
建立播放清單的日期和時間。這個值是以 ISO 8601 格式指定。
snippet.channelId string
YouTube 用來識別發布播放清單頻道的專屬 ID。
snippet.title string
播放清單的��題。
snippet.description string
播放清單的說明。
snippet.thumbnails object
播放清單相關縮圖的地圖。地圖上每個物件的鍵都是縮圖名稱,值則是包含縮圖其他資訊的物件。
snippet.thumbnails.(key) object
有效的鍵/值包括:
  • default:預設的縮圖圖片。影片的預設縮圖或參照影片的資源 (例如播放清單項目或搜尋結果) 的預設縮圖寬度為 120 像素,高度為 90 像素。頻道的預設縮圖寬度為 88 像素、高度 88 像素。
  • medium:縮圖解析度更高的版本。如為影片 (或參照影片的資源),這張圖片的寬度為 320 像素,高度為 180 像素。頻道的圖片寬度為 240 像素,高度為 240 像素。
  • high:縮圖的高解析度版本。如為影片 (或參照影片的資源),這張圖片的寬度為 480 像素,高度為 360 像素。對頻道而言,這張圖片寬度為 800 像素,高度為 800 像素。
  • standard:比 high 解析度圖片更高版本的縮圖圖片。這張圖片適用於某些參照影片的影片和其他資源,例如播放清單項目或搜尋結果。這張圖片寬度為 640 像素,高度為 480 像素。
  • maxres:縮圖解析度最高的版本。這個圖片大小適用於某些參照影片的影片和其他資源,例如播放清單項目或搜尋結果。這張圖片的寬度為 1280 像素,高度為 720 像素。
snippet.thumbnails.(key).url string
圖片的網址。
snippet.thumbnails.(key).width unsigned integer
圖片的寬度。
snippet.thumbnails.(key).height unsigned integer
圖片的高度。
snippet.channelTitle string
影片所屬頻道的頻道標題。
snippet.tags[] list
此屬性已淘汰。

與播放清單相關聯的關鍵字標記。
snippet.defaultLanguage string
playlist 資源 snippet.titlesnippet.description 屬性中的文字語言。
snippet.localized object
snippet.localized 物件包含播放清單的本地化標題和說明,或是播放清單中繼資料的預設語言名稱。
  • 如果 playlists.list 要求使用 hl 參數指定要傳回本地化文字的語言,「並且」提供該語言適用的本地化文字,系統會在資源程式碼片段中傳回本地化文字。
  • 如未指定 hl 參數值,或是已指定值,但不支援指定語言的中繼資料,則系統會傳回預設語言的中繼資料。
屬性包含唯讀值。請使用 localizations 物件新增、更新或刪除本地化標題。
snippet.localized.title string
本地化播放清單標題。
snippet.localized.description string
本地化播放清單說明。
status object
status 物件包含播放清單的狀態資訊。
status.privacyStatus string
播放清單的隱私權狀態。

這項資源的有效值如下:
  • private
  • public
  • unlisted
contentDetails object
contentDetails 物件包含播放清單內容的相關資訊,包括播放清單中的影片數量。
contentDetails.itemCount unsigned integer
播放清單中的影片數量。
player object
player 物件包含可在嵌入式播放器中播放播放清單的資訊。
player.embedHtml string
<iframe> 標記,用於嵌入將播放播放清單的播放器。
localizations object
localizations 物件會封裝播放清單中繼資料的翻譯。
localizations.(key) object
與鍵/值相關聯的本地化文字語言。這個值是包含 BCP-47 語言代碼的字串。
localizations.(key).title string
本地化播放清單標題。
localizations.(key).description string
本地化播放清單說明。