傳回符合 API 要求參數的播放清單集合。舉例來說,您可以擷取已驗證使用者擁有的所有播放清單,也可以依照專屬 ID 擷取一或多個播放清單。
配額影響:呼叫此方法的配額費用為 1 單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/playlists
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string part 參數會指定以逗號分隔的清單,其中包含 API 回應所包含的一或多個 playlist 資源屬性。如果參數指定的屬性包含子項資源,則子屬性將納入回應中。舉例來說,在 playlist 資源中,snippet 屬性包含 author 、title 、description 和 timeCreated 等屬性。因此,如果您設定 part=snippet ,API 回應就會包含以上所有屬性。以下清單包含可在參數值中加入的 part 名稱:
|
|
篩選器 (請僅指定下列其中一個參數) | ||
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 要求和回應。