Captions: list

Restituisce un elenco di tracce dei sottotitoli associate a un video specificato. Tieni presente che la risposta dell'API non contiene i sottotitoli effettivi e che il metodo captions.download consente di recuperare una traccia dei sottotitoli.

Impatto sulla quota: una chiamata a questo metodo ha un costo della quota di 50 unità.

Casi d'uso comuni

Richiesta

Richiesta HTTP

GET https://www.googleapis.com/youtube/v3/captions

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/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

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 le parti della risorsa caption che verranno incluse nella risposta dell'API.

L'elenco seguente contiene i nomi part che puoi includere nel valore parametro:
  • id
  • snippet
videoId string
Il parametro videoId specifica l'ID video di YouTube del video per il quale l'API deve restituire le tracce dei sottotitoli.
Parametri facoltativi
id string
Il parametro id specifica un elenco di ID separati da virgole che identificano le risorse caption da recuperare. Ogni ID deve identificare una traccia dei sottotitoli associata al video specificato.
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 effettivo con cui l'utente esegue l'autenticazione deve essere collegato al proprietario dei contenuti di YouTube specificato.

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#captionListResponse",
  "etag": etag,
  "items": [
    caption 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#captionListResponse.
etag etag
L'ETag di questa risorsa.
items[] list
Un elenco di sottotitoli 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 dei messaggi di errore.

Tipo di errore Dettagli errore Descrizione
forbidden (403) forbidden Impossibile recuperare una o più tracce dei sottotitoli perché le autorizzazioni associate alla richiesta non sono sufficienti per recuperare le risorse richieste. La richiesta potrebbe non essere autorizzata correttamente.
notFound (404) captionNotFound Impossibile trovare una o più tracce dei sottotitoli specificate. Questo errore si verifica se il videoId parametro identifica un video effettivo, ma il id parametro identifica ID di tracce dei sottotitoli inesistenti o ID di tracce associati ad altri video. Verifica che i valori dei parametri id e videoId della richiesta siano corretti.
notFound (404) videoNotFound Impossibile trovare il video identificato dal parametro videoId.

Prova

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