Restituisce un elenco di video che corrispondono ai parametri della richiesta API.
Impatto della quota: una chiamata a questo metodo ha un costo della quota di 1 unità.
Casi d'uso comuni
Richiesta
Richiesta HTTP
GET https://www.googleapis.com/youtube/v3/videos
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 part specifica un elenco separato da virgole di una o più proprietà delle risorse video che verranno incluse nella risposta dell'API.Se il parametro identifica una proprietà contenente proprietà figlio, queste ultime verranno incluse nella risposta. Ad esempio, in una risorsa video , la proprietà snippet contiene le proprietà channelId , title , description , tags e categoryId . Di conseguenza, se imposti part=snippet , la risposta dell'API conterrà tutte queste proprietà.Il seguente elenco contiene i nomi part che puoi includere nel valore parametro:
|
|
Filtri (specificare esattamente uno dei seguenti parametri) | ||
chart |
string Il parametro chart identifica il grafico da recuperare.I valori accettati sono:
|
|
id |
string Il parametro id specifica un elenco separato da virgole degli ID video di YouTube per le risorse recuperate. In una risorsa video , la proprietà id specifica l'ID del video. |
|
myRating |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Imposta il valore di questo parametro su like o dislike per indicare all'API di restituire solo i video piaciuti o non mi piace dall'utente autenticato.I valori accettati sono:
|
|
Parametri facoltativi | ||
hl |
string Il parametro hl indica all'API di recuperare i metadati delle risorse localizzati per uno specifico linguaggio dell'applicazione supportato dal sito web di YouTube. Il valore del parametro deve essere un codice lingua incluso nell'elenco restituito dal metodo i18nLanguages.list .Se i dettagli localizzati della risorsa sono disponibili in quella lingua, l'oggetto snippet.localized della risorsa conterrà i valori localizzati. Tuttavia, se i dettagli localizzati non sono disponibili, l'oggetto snippet.localized conterrà i dettagli della risorsa nella lingua predefinita della risorsa. |
|
maxHeight |
unsigned integer Il parametro maxHeight specifica l'altezza massima del player incorporato restituito nella proprietà player.embedHtml . Puoi utilizzare questo parametro per specificare l'altezza adatta al layout della tua applicazione, anziché le dimensioni predefinite. Se viene fornito anche il parametro maxWidth , il player potrebbe avere una lunghezza inferiore a quello di maxHeight per non violare la larghezza massima. I valori accettati sono compresi tra 72 e 8192 . |
|
maxResults |
unsigned integer Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati.Nota: l'uso di questo parametro è supportato in combinazione con il parametro myRating , ma non ne supporta l'utilizzo insieme al parametro id . I valori accettati sono compresi tra 1 e 50 . Il valore predefinito è 5 . |
|
maxWidth |
unsigned integer Il parametro maxWidth specifica la larghezza massima del player incorporato restituito nella proprietà player.embedHtml . Puoi usare questo parametro per specificare che, al posto delle dimensioni predefinite, il codice per l'incorporamento deve utilizzare una larghezza appropriata per il layout della tua applicazione.Se viene fornito anche il parametro maxHeight , il player potrebbe avere dimensioni maggiori di maxWidth per non violare l'altezza massima. I valori accettati sono compresi tra 72 e 8192 . |
|
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. Nota:questo parametro è destinato esclusivamente ai partner dei 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 per i contenuti di YouTube che possiedono e gestiscono molti canali YouTube diversi. Consente ai proprietari dei contenuti di effettuare l'autenticazione una volta sola e ottenere l'accesso a tutti i dati relativi a video e canali, senza dover fornire credenziali di autenticazione per ogni singolo canale. L'account CMS con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato. |
|
pageToken |
string Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che è possibile recuperare.Nota: l'uso di questo parametro è supportato in combinazione con il parametro myRating , ma non ne supporta l'utilizzo in combinazione con il parametro id . |
|
regionCode |
string Il parametro regionCode indica all'API di selezionare un grafico video disponibile nella regione specificata. Questo parametro può essere utilizzato solo in combinazione con il parametro chart . Il valore del parametro è un codice paese ISO 3166-1 alpha-2. |
|
videoCategoryId |
string Il parametro videoCategoryId identifica la categoria di video per la quale deve essere recuperato il grafico. Questo parametro può essere utilizzato solo in combinazione con il parametro chart . Per impostazione predefinita, i grafici non sono limitati a una determinata categoria. Il valore predefinito è 0 . |
Corpo della richiesta
Non fornire il corpo della richiesta quando chiami questo metodo.
Risposta
Se l'esito è positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video 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#videoListResponse . |
etag |
etag L'Etag di questa risorsa. |
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 incapsula le informazioni sul paging 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 video che corrispondono ai criteri della richiesta. |
Errori
La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.
Tipo di errore | Dettagli errore | Descrizione |
---|---|---|
badRequest (400) |
videoChartNotFound |
Il grafico video richiesto non è supportato o non è disponibile. |
forbidden (403) |
forbidden |
La richiesta non dispone dell'autorizzazione necessaria per accedere al file video o alle informazioni relative all'elaborazione. Tieni presente che le parti fileDetails , processingDetails e suggestions sono disponibili solo per il proprietario di quel video. |
forbidden (403) |
forbidden |
La richiesta non può accedere alle informazioni sulla valutazione degli utenti. Questo errore può verificarsi perché la richiesta non è autorizzata a utilizzare il parametro myRating . |
notFound (404) |
videoNotFound |
Impossibile trovare il video che stai tentando di recuperare. Verifica che il valore del parametro id della richiesta sia corretto. |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.