傳回符合 API 要求參數的播放清單圖片集合。您可以擷取指定播放清單的圖片,或透過一或多個播放清單的專屬 ID 擷取圖片。
配額影響:呼叫此方法會產生 1 個單位的配額費用。
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/playlistImages
授權
這項要求需要授權,且至少須具備下列其中一個範圍 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string
|
|
篩選器 (請指定下列其中一個參數) | ||
id |
string id 參數會指定以半形逗號分隔的清單,其中包含一或多個不重複的播放清單圖片 ID。 |
|
playlistId |
string playlistId 參數會指定要擷取播放清單圖片的播放清單專屬 ID。請注意,即使這是選用參數,每次要求擷取播放清單圖片時,都必須為 id 參數或 playlistId 參數指定值。 |
|
選用參數 | ||
maxResults |
unsigned integer maxResults 參數會指定結果集中應傳回的圖片數量上限。可接受介於 0 到 50 (包含這兩者) 之間的值。預設值為 5 。 |
|
onBehalfOfContentOwner |
string 這個參數只能用於已獲得授權的要求。注意:這個參數僅供 YouTube 內容合作夥伴使用。 onBehalfOfContentOwner 參數表示要求授權憑證會識別 YouTube 內容管理系統使用者,該使用者會代表參數值中指定的內容擁有者採取行動。這項參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次,就能存取所有影片和頻道資料,不必為每個頻道提供驗證憑證。使用者用來驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
|
onBehalfOfContentOwnerChannel |
string 這個參數只能用於已獲得授權的要求。注意:這個參數僅供 YouTube 內容合作夥伴使用。 The onBehalfOfContentOwnerChannel parameter
specifies the YouTube channel ID of the channel to which a video is being
added. 如果要求為 onBehalfOfContentOwner 參數指定值,就必須提供這個參數,且只能與該參數搭配使用。此外,要求必須使用連結至內容擁有者的 CMS 帳戶授權,而該內容擁有者是由 onBehalfOfContentOwner 參數指定。最後,onBehalfOfContentOwnerChannel 參數值指定的頻道必須連結至 onBehalfOfContentOwner 參數指定的內容擁有者。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次,即可代表參數值中指定的頻道執行動作,不必為每個頻道提供驗證憑證。 |
|
pageToken |
string pageToken 參數會識別結果集中應傳回的特定頁面。在 API 回應中,nextPageToken 和 prevPageToken 屬性會識別可擷取的其他網頁。 |
要求主體
呼叫這個方法時,請勿提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
屬性
下表定義這個資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源的類型。值為 youtube#playlistImageListResponse 。 |
nextPageToken |
string 這個權杖可用做 pageToken 參數的值,擷取結果集中的下一頁。 |
prevPageToken |
string 這個權杖可做為 pageToken 參數的值,用於擷取結果集中的上一頁。 |
pageInfo |
object pageInfo 物件會封裝結果集的換頁資訊。 |
pageInfo.totalResults |
integer 結果集中的結果總數。 |
pageInfo.resultsPerPage |
integer API 回應中包含的結果數量。 |
items[] |
list 符合要求條件的播放清單圖片清單。 |