playlist
資源代表 YouTube 播放清單。播放清單是可以依序播放的影片,而且可以與其他使用者分享。根據預設,其他使用者可以看見播放清單,但播放清單可以設為公開或私人。
YouTube 還會使用播放清單辨識頻道的特殊影片集合,例如:
- 已上傳的影片
- 給予好評 (喜歡) 的影片
channel resource
中擷取這些清單的播放清單 ID。接著,您可以使用
playlistItems.list
方法擷取任何清單中的清單。此外,您也可以呼叫 playlistItems.insert
和 playlistItems.delete
方法,新增或移除這些清單中的項目。
方法
這個 API 支援下列 playlists
資源的方法:
資源表示法
以下 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 有效的鍵值如下:
|
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.title 和 snippet.description 屬性中的文字語言。 |
snippet.localized |
object snippet.localized 物件包含播放清單的本地化標題和說明,或是播放清單中繼資料的預設語言標題。
localizations 物件新增、更新或刪除本地化標題。 |
snippet.localized.title |
string 本地化的播放清單標題。 |
snippet.localized.description |
string 本地化播放清單說明。 |
status |
object status 物件包含播放清單的狀態資訊。 |
status.privacyStatus |
string 播放清單的隱私設定狀態。 這項屬性的有效值如下:
|
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 本地化播放清單說明。 |