Restituisce una raccolta di immagini di playlist che corrispondono ai parametri della richiesta API. Puoi recuperare l'immagine di una playlist specifica o una o più immagini di playlist in base ai loro ID univoci.
Impatto sulla quota:una chiamata a questo metodo ha un costo della quota di 1 unità.
Richiesta
Richiesta HTTP
GET https://www.googleapis.com/youtube/v3/playlistImages
Autorizzazione
Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti (scopri di più su autenticazione e autorizzazione).
Ambito |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.
Parametri | ||
---|---|---|
Parametri obbligatori | ||
part |
string Il parametro |
|
Filtri (specifica esattamente uno dei seguenti parametri) | ||
id |
string Il parametro id specifica un elenco separato da virgole di uno o più ID immagine playlist univoci. |
|
playlistId |
string Il parametro playlistId specifica l'ID univoco della playlist per cui vuoi recuperare le immagini. Tieni presente che, anche se si tratta di un parametro facoltativo, ogni richiesta di recupero delle immagini delle playlist deve specificare un valore per il parametro id o per il parametro playlistId . |
|
Parametri facoltativi | ||
maxResults |
unsigned integer Il parametro maxResults specifica il numero massimo di immagini che devono essere restituite nel set di risultati. I valori accettabili sono compresi tra 0 e 50 inclusi. Il valore predefinito è 5 . |
|
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata. Nota:questo parametro è destinato esclusivamente ai partner di contenuti di YouTube. Il parametro onBehalfOfContentOwner indica che le credenziali di autorizzazione della richiesta identificano un utente di YouTube CMS che agisce per conto del proprietario dei contenuti specificato nel valore del parametro. Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di autenticarsi una sola volta e accedere a tutti i dati dei video e dei canali, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'account CMS con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti YouTube specificato. |
|
onBehalfOfContentOwnerChannel |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata. Nota:questo parametro è destinato esclusivamente ai partner di contenuti di YouTube. Il parametro onBehalfOfContentOwnerChannel
specifica l'ID canale YouTube del canale a cui viene aggiunto un video. Questo parametro è obbligatorio quando una richiesta specifica un valore per il
parametro onBehalfOfContentOwner e può essere utilizzato solo in
combinazione con questo parametro. Inoltre, la richiesta deve essere
autorizzata utilizzando un account CMS collegato al proprietario dei contenuti specificato dal
parametro onBehalfOfContentOwner . Infine, il
canale specificato dal valore del parametro onBehalfOfContentOwnerChannel
deve essere collegato al proprietario dei contenuti specificato dal
parametro onBehalfOfContentOwner .Questo parametro è destinato ai partner di contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di autenticarsi una sola volta ed eseguire azioni per conto del canale specificato nel valore del parametro, senza dover fornire le credenziali di autenticazione per ogni canale separato. |
|
pageToken |
string Il parametro pageToken identifica una pagina specifica nel set di risultati che deve essere restituita. In una risposta API, le proprietà nextPageToken e prevPageToken identificano altre pagine che potrebbero essere recuperate. |
Corpo della richiesta
Non fornire un corpo della richiesta quando chiami questo metodo.
Risposta
In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
Proprietà | |
---|---|
kind |
string Identifica il tipo di risorsa API. Il valore sarà youtube#playlistImageListResponse . |
nextPageToken |
string Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati. |
prevPageToken |
string Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina precedente nel set di risultati. |
pageInfo |
object L'oggetto pageInfo contiene le informazioni di paginazione per il set di risultati. |
pageInfo.totalResults |
integer Il numero totale di risultati nel set di risultati. |
pageInfo.resultsPerPage |
integer Il numero di risultati inclusi nella risposta dell'API. |
items[] |
list Un elenco di immagini delle playlist che corrispondono ai criteri della richiesta. |