playlistItem
資源會識別播放清單中包含的其他資源,例如影片。此外,playlistItem
資源還包含所附資源的詳細資料,這些資料與該資源在該播放清單中的使用方式有關。
YouTube 也會使用播放清單來識別頻道上傳影片的清單,清單中的每個 playlistItem
代表一個上傳的影片。您可以從特定管道的 channel
資源中,擷取該清單的播放清單 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 方法設定這個值。 |