Playlists: list

傳回符合 API 要求參數的播放清單集合。舉例來說，您可以擷取已驗證使用者擁有的所有播放清單，也可以依專屬 ID 擷取一或多個播放清單。

配額影響：呼叫這個方法會產生 1 個單位的配額費用。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/playlists

參數

下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。

參數
必要參數
part string
part 參數會指定一或多個 playlist 資源屬性，並以逗號分隔的清單呈現，這些屬性會包含在 API 回應中。

如果參數識別的屬性包含子屬性，則子屬性會包含在回應中。舉例來說，在 playlist 資源中，snippet 屬性包含 author、title、description 和 timeCreated 等屬性。因此，如果您設定 part=snippet，API 回應就會包含所有這些屬性。

下列清單包含可納入參數值的 part 名稱：
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
篩選器 (請指定下列其中一個參數)
channelId string
這個值表示 API 應只傳回指定頻道的播放清單。
id string
id 參數會指定要擷取的資源 YouTube 播放清單 ID 清單，並以半形逗號分隔。在 playlist 資源中，id 屬性會指定播放清單的 YouTube 播放清單 ID。
mine boolean
這項參數只能用於已獲得授權的要求。將這個參數的值設為 true，指示 API 只傳回已驗證使用者擁有的播放清單。
選用參數
hl string
hl 參數會指示 API 擷取 YouTube 網站支援的特定應用程式語言本地化資源中繼資料。參數值必須是 i18nLanguages.list 方法傳回清單中的語言代碼。

如果該語言有本地化資源詳細資料，資源的 snippet.localized 物件就會包含本地化值。不過，如果沒有本地化詳細資料，snippet.localized 物件會包含資源預設語言的資源詳細資料。
maxResults unsigned integer
maxResults 參數指定結果集中應傳回的項目數量上限。可接受的值為 0 至 50 (含)。預設值為 5。
onBehalfOfContentOwner string
這項參數只能用於已獲得授權的要求。注意：這個參數僅供 YouTube 內容合作夥伴使用。

onBehalfOfContentOwner 參數表示要求授權憑證識別的 YouTube CMS 使用者，是代表參數值中指定的內容擁有者行事。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只需驗證一次，即可存取所有影片和頻道資料，不必為每個頻道提供驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。
onBehalfOfContentOwnerChannel string
這項參數只能用於已獲得授權的要求。注意：這個參數僅供 YouTube 內容合作夥伴使用。

onBehalfOfContentOwnerChannel 參數會指定要新增影片的 YouTube 頻道 ID。如果要求指定 onBehalfOfContentOwner 參數的值，就必須提供這項參數，且只能與該參數搭配使用。此外，要求必須使用連結至 onBehalfOfContentOwner 參數指定內容擁有者的 CMS 帳戶授權。最後，onBehalfOfContentOwnerChannel 參數值指定的頻道必須連結至 onBehalfOfContentOwner 參數指定的內容擁有者。

這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次，即可代表參數值中指定的頻道執行動作，不必為每個個別頻道提供驗證憑證。
pageToken string
pageToken 參數會識別結果集中應傳回的特定頁面。在 API 回應中，nextPageToken 和 prevPageToken 屬性會識別可擷取的其他頁面。

要求主體

呼叫這個方法時，請勿提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

屬性

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

屬性
kind string
識別 API 資源的類型。值為 youtube#playlistListResponse。
etag etag
這項資源的 Etag。
nextPageToken string
這個權杖可做為 pageToken 參數的值，用於擷取結果集中的下一頁。
prevPageToken string
這個權杖可做為 pageToken 參數的值，用來擷取結果集中的上一頁。
pageInfo object
pageInfo 物件會封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集中的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
符合要求條件的播放清單。

錯誤

下表列出 API 在呼叫這個方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳細資料 說明
forbidden (403) channelClosed channelId 參數中指定的管道已關閉。
forbidden (403) channelSuspended channelId 參數中指定的頻道已遭停權。
forbidden (403) playlistForbidden 要求 id 參數指定的播放清單不支援該要求，或要求未經適當授權。
notFound (404) channelNotFound 找不到 channelId 參數中指定的管道。
notFound (404) playlistNotFound 找不到以要求 id 參數識別的播放清單。
invalidValue (400) playlistOperationUnsupported API 不支援列出指定播放清單的功能。舉例來說，你無法列出「稍後觀看」播放清單。

試試看！

使用 APIs Explorer 呼叫這個 API，並查看 API 要求和回應。