I seguenti esempi mostrano come utilizzare la YouTube Data API (v3) per eseguire funzioni relative ai sottotitoli.
Recuperare un elenco di tracce di sottotitoli codificati per un video
Per recuperare un elenco di tracce di sottotitoli disponibili per un video specifico, chiama il metodo captions.list
. Imposta il valore del parametro videoId
sull'ID video di YouTube che identifica in modo univoco il video per il quale stai recuperando i sottotitoli. La tua richiesta deve essere autorizzata utilizzando OAuth 2.0.
La richiesta riportata di seguito recupera un elenco di sottotitoli per un video sul canale YouTube di Storie di Google:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list? part=snippet &videoId=PRU2ShMzQRg
Per un esempio dei codici, consulta la documentazione del metodo captions.list
.
Crea una traccia di sottotitoli
Questa query non può essere testata tramite Explorer API perché Explorer API non supporta il caricamento di file, che è un requisito per questo metodo.
Puoi utilizzare il metodo dell'API captions.insert
per caricare una nuova traccia di sottotitoli per un video. Quando carichi una traccia, devi specificare un valore per le seguenti proprietà delle risorse caption
:
snippet.videoId
: identifica il video a cui viene aggiunta la traccia di sottotitoli.snippet.language
: la lingua della traccia dei sottotitoli.snippet.name
: il nome della traccia dei sottotitoli.
Durante il caricamento di una traccia dei sottotitoli sono disponibili le seguenti opzioni aggiuntive:
-
Se imposti il parametro
sync
sutrue
, YouTube ignorerà tutti i codici temporali presenti nel file dei sottotitoli caricati e genererà nuovi codici temporali per i sottotitoli.Imposta il parametro
sync
sutrue
se stai caricando una trascrizione, che non ha codici temporali o se sospetti che i codici temporali presenti nel tuo file non siano corretti e vuoi che YouTube provi a correggerli. -
Se imposti la proprietà
snippet.isDraft
della risorsacaption
sutrue
, la traccia non sarà visibile pubblicamente.
Per un esempio dei codici, consulta la documentazione del metodo captions.insert
.
Scarica una traccia di sottotitoli
Impossibile testare questa query utilizzando Explorer API perché Explorer API non supporta la possibilità di scaricare file.
Per scaricare una traccia di sottotitoli specifica, chiama il metodo captions.download
. Imposta il valore del parametro id
sull'ID della traccia dei sottotitoli di YouTube che identifica in modo univoco la traccia dei sottotitoli che vuoi scaricare. La tua richiesta deve essere autorizzata utilizzando OAuth 2.0.
L'API v3 supporta le seguenti opzioni:
-
Per specificare che una traccia di sottotitoli deve essere restituita in un formato specifico, imposta il valore del parametro
tfmt
per identificare il formato desiderato. Nella definizione del parametro sono elencati i valori supportati. -
Per recuperare la traduzione di una traccia di sottotitoli, imposta il valore del parametro
tlang
su un codice lingua ISO 639-1 di due lettere che identifica la lingua dei sottotitoli desiderata. La traduzione viene generata utilizzando la traduzione automatica, ad esempio Google Traduttore.
Per un esempio dei codici, consulta la documentazione del metodo captions.download
.
Aggiornare una traccia di sottotitoli
L'API supporta la possibilità di modificare lo stato della bozza di una traccia di sottotitoli, caricare una nuova traccia di sottotitoli per un file o entrambe le cose.
Puoi utilizzare Explorer API per verificare la possibilità di modificare lo stato di bozza di una traccia. Tuttavia, non puoi utilizzare Explorer API per aggiornare la traccia dei sottotitoli effettivi, perché lo strumento non supporta la possibilità di caricare file.
La richiesta riportata di seguito recupera un elenco di sottotitoli per un video sul canale YouTube di Storie di Google:
La richiesta aggiorna lo stato di bozza di una traccia di sottotitoli in true
, il che significa che la traccia non sarà visibile pubblicamente. Per completare la richiesta in Explorer API, devi impostare il valore della proprietà id
per identificare una traccia di sottotitoli.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update? part=snippet
Per un esempio dei codici, consulta la documentazione del metodo captions.update
.
Elimina una traccia di sottotitoli
Questo esempio mostra come eliminare una traccia di sottotitoli. L'esempio include i seguenti passaggi:
-
Passaggio 1: recupera l'ID della traccia dei sottotitoli
Segui la procedura descritta sopra per recuperare un elenco di tracce di sottotitoli per un video. L'elenco potrebbe essere utilizzato per visualizzare un elenco delle tracce di sottotitoli codificati, utilizzando l'ID di ogni traccia come chiave.
-
Passaggio 2: elimina il canale
Chiama il metodo
captions.delete
per eliminare un video specifico. Nella richiesta, il parametroid
specifica l'ID traccia della traccia che stai eliminando. La richiesta deve essere autorizzata utilizzando OAuth 2.0. Se stai testando questa query in Explorer API, dovrai sostituire un ID traccia sottotitoli valido per il valore parametroid
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete? id=CAPTION_TRACK_ID