Restituisce un elenco di tracce di sottotitoli associate a un video specificato. Tieni presente che la risposta dell'API non contiene i sottotitoli effettivi e che il metodo captions.download
offre la possibilità di recuperare una traccia di sottotitoli.
Impatto della quota: una chiamata a questo metodo ha un costo della quota di 50 unità.
Casi d'uso comuni
Risorse richieste:
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
Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.
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 del parametro:
|
|
videoId |
string Il parametro videoId specifica l'ID del video di YouTube per il quale l'API deve restituire le tracce di sottotitoli codificati. |
|
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 di sottotitoli associata al video specificato. |
|
onBehalfOfContentOwner |
string Questo parametro può essere utilizzato solo in una richiesta autorizzata appropriata. 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 del sistema di gestione dei contenuti di YouTube 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. Permette ai proprietari dei contenuti di autenticarsi una volta sola e di accedere a tutti i dati video e del canale, senza dover fornire le credenziali di autenticazione per ogni singolo canale. L'effettivo account CMS con cui l'utente si autentica 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 di risposta con la seguente struttura:
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
Proprietà
La tabella seguente definisce le proprietà che vengono visualizzate 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 soddisfano i 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 |
---|---|---|
forbidden (403) |
forbidden |
Impossibile recuperare una o più tracce di 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 di sottotitoli specificate. Questo errore si verifica se il parametro videoId identifica un video reale, ma il parametro id identifica gli ID tracce dei sottotitoli che non esistono o gli ID delle tracce associati ad altri video. Controlla i valori dei parametri id e videoId della richiesta per assicurarti che siano corretti. |
notFound (404) |
videoNotFound |
Impossibile trovare il video identificato dal parametro videoId . |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.