傳回一組符合 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 CMS 使用者,這些使用者是代表參數值中指定的內容擁有者。這個參數適用於擁有並管理許多不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要進行驗證一次,就能存取所有的影片和頻道資料,不必分別提供各個頻道的驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
|
onBehalfOfContentOwnerChannel |
string 這個參數只能用於正確的授權請求。注意:這個參數僅適用於 YouTube 內容合作夥伴。 onBehalfOfContentOwnerChannel 參數
指明影片所屬頻道的 YouTube 頻道 ID
已新增。要求指定
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 符合要求標準的播放清單圖片清單。 |