PlaylistItems

playlistItem 資源可識別播放清單中包含的其他資源,例如影片。此外,playlistItem 資源包含資源的詳細資料,明確指出該資源在播放清單中的使用方式。

YouTube 也會使用播放清單來識別頻道的上傳影片清單,清單中的每個 playlistItem 都代表一部上傳的影片。您可以從指定頻道的 channel resource 擷取該清單的播放清單 ID。接著,您可以使用 playlistItems.list 方法加入清單。

方法

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

list
傳回符合 API 要求參數的播放清單項目集合。您可以擷取指定播放清單中的所有播放清單項目,或是依專屬 ID 擷取一或多個播放清單項目。立即試用
插入
將資源新增至播放清單。立即試用
更新
修改播放清單項目。舉例來說,您可以更新項目在播放清單中的位置。立即試用
刪除
刪除播放清單項目。立即試用

資源表示法

下列 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 用來識別將商品加入播放清單的使用者。
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.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.insertvideos.update 方法設定這個值。