Videos: list

Restituisce un elenco di video che corrispondono ai parametri della richiesta API.

Impatto sulla 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à della risorsa video che la risposta dell'API includerà.

Se il parametro identifica una proprietà che contiene proprietà figlio, queste 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 delle part che puoi includere nel valore del parametro:
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filtri (specifica esattamente uno dei seguenti parametri)
chart string
Il parametro chart identifica il grafico che vuoi recuperare.

I valori accettabili sono:
id string
Il parametro id specifica un elenco separato da virgole degli ID video di YouTube per le risorse che vengono 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 a cui l'utente autenticato ha messo Mi piace o Non mi piace.



L'API limita il set di risultati restituito a un massimo di 1000 video. Anche se la proprietà pageInfo.totalResults della risposta indica un totale più elevato, la paginazione tramite il parametro pageToken consente di recuperare solo i 1000 elementi più recenti.



Il parametro accetta i seguenti valori:

  • dislike : restituisce solo i video a cui l'utente autenticato ha messo Non mi piace.
  • like : restituisce solo i video a cui l'utente autenticato ha messo Mi piace.
Parametri facoltativi
hl string
Il parametro hl indica all'API di recuperare i metadati delle risorse localizzate per una lingua dell'applicazione specifica supportata 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 delle risorse localizzate 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 delle risorse 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 che, anziché le dimensioni predefinite, il codice di incorporamento deve utilizzare un'altezza appropriata per il layout dell'applicazione. Se viene fornito anche il parametro maxWidth, il player potrebbe essere più corto di maxHeight per non violare la larghezza massima. I valori accettabili sono compresi tra 72 e 8192, inclusi.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati.

Nota: Questo parametro è supportato per l'utilizzo in combinazione con il parametro myRating, ma non è supportato per l'utilizzo in combinazione con il parametro id. I valori accettabili sono compresi tra 1 e 50, inclusi. Il valore predefinito è 5.
maxWidth unsigned integer
Il parametro maxWidth specifica la larghezza massima del player incorporato restituito nella proprietà player.embedHtml. Puoi utilizzare questo parametro per specificare che, anziché le dimensioni predefinite, il codice di incorporamento deve utilizzare una larghezza appropriata per il layout dell'applicazione.

Se viene fornito anche il parametro maxHeight, il player potrebbe essere più stretto di maxWidth per non violare l'altezza massima. I valori accettabili sono compresi tra 72 e 8192, inclusi.
onBehalfOfContentOwner string
Questo parametro può essere utilizzato solo in una richiesta autorizzata correttamente. 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 di 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 di YouTube specificato.
pageToken string
Il parametro pageToken identifica una pagina specifica nel set di risultati da restituire. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che potrebbero essere recuperate.

Nota: questo parametro è supportato per l'utilizzo in combinazione con il parametro myRating, ma non è supportato per l'utilizzo in combinazione con il parametro id.
regionCode string
Il parametro regionCode indica all'API di selezionare un grafico dei video disponibile nella regione specificata. Questo parametro può essere utilizzato solo in combinazione con il parametro chart. Il valore parametro è un codice paese ISO 3166-1 alpha-2.
videoCategoryId string
Il parametro videoCategoryId identifica la categoria di video per cui 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 categoria specifica. Il valore predefinito è 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video Resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà che appaiono 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 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 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 maggiori dettagli, consulta la documentazione sui messaggi di errore.

Tipo di errore Dettagli errore Descrizione
badRequest (400) videoChartNotFound Il grafico dei video richiesto non è supportato o non è disponibile.
forbidden (403) forbidden La richiesta non è autorizzata correttamente ad accedere alle informazioni sul file video o sull'elaborazione. Tieni presente che le parti fileDetails, processingDetails e suggestions sono disponibili solo per il proprietario del video.
forbidden (403) forbidden La richiesta non può accedere alle informazioni sulla valutazione dell'utente. Questo errore può verificarsi perché la richiesta non è autorizzata correttamente 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

Utilizza APIs Explorer per chiamare questa API e visualizzare la richiesta API e la risposta.