playlistItem
資源可識別播放清單中的另一項資源,例如影片。此外,playlistItem
資源中包含與資源相關的具體詳細資料,並具體用於該資源在播放清單中的用途。
YouTube 也會使用播放清單來識別頻道的已上傳影片清單,且每個清單的「playlistItem
」均代表一部已上傳的影片。您可以從特定頻道的 channel resource
擷取該播放清單的播放清單 ID。然後,您可以使用 playlistItems.list
方法至清單。
方法
這個 API 支援下列 playlistItems
資源的方法:
資源表示法
以下 JSON 結構顯示了 playlistItems
資源的格式:
{ "kind": "youtube#playlistItem", "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, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源類型。這個值會是 youtube#playlistItem 。 |
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.videoOwnerChannelTitle |
string 這部影片所屬的頻道標題。 |
snippet.videoOwnerChannelId |
string 上傳影片的頻道 ID。 |
snippet.playlistId |
string YouTube 用於識別播放清單項目的播放清單的 ID。 |
snippet.position |
unsigned integer 項目在播放清單中的顯示順序。這個值使用零索引,因此第一個項目的位置為 0 ,第二個項目的位置為 1 ,依此類推。 |
snippet.resourceId |
object id 物件包含的資訊,可用來識別播放清單中的資源,做為播放清單項目。 |
snippet.resourceId.kind |
string 推薦資源的種類或類型。 |
snippet.resourceId.videoId |
string 如果 snippet.resourceId.kind 屬性的值為 youtube#video ,則此屬性會顯示,且其值會包含 YouTube 用來識別播放清單中影片的 ID。 |
contentDetails |
object 如果內含的項目是 YouTube 影片,則該資源會包含 contentDetails 物件。物件含有影片的其他資訊。 |
contentDetails.videoId |
string YouTube 用於識別影片的專屬 ID。如要擷取 video 資源,請在 API 要求中將 id 查詢參數設為這個值。 |
contentDetails.startAt |
string 播放清單擁有者可以指定影片在播放清單中播放時,何時應該開始或停止播放。預設值為 0 。 |
contentDetails.endAt |
string 播放清單擁有者可以指定影片在播放清單中播放時,何時應該開始或停止播放。根據預設,假設 video.endTime 是影片結尾。 |
contentDetails.note |
string 使用者針對這個項目產生的附註。屬性值的長度上限為 280 個字元。 |
contentDetails.videoPublishedAt |
datetime 影片在 YouTube 上發布的日期和時間。這個值會以 ISO 8601 格式指定。 |
status |
object status 物件包含播放清單項目的隱私權狀態資訊。 |
status.privacyStatus |
string 播放清單項目的隱私設定狀態。上傳播放清單項目代表的影片的頻道可使用 videos.insert 或 videos.update 方法設定這個值。 |