Captions: download

Télécharge une piste de sous-titres. La piste de sous-titres est renvoyée dans son format d'origine, sauf si la requête spécifie une valeur pour le paramètre tfmt, et dans sa langue d'origine, sauf si la requête spécifie une valeur pour le paramètre tlang.

Impact sur le quota : un appel à cette méthode coûte 200 unités de quota.

Cette méthode nécessite que l'utilisateur soit autorisé à modifier la vidéo.

Cas d'utilisation courants

Requête

Requête HTTP

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Champ d'application
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Paramètres

Le tableau ci-dessous liste les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
id string
Le paramètre id identifie la piste de sous-titres à récupérer. La valeur est un ID de piste de sous-titres, tel qu'identifié par la propriété id dans une ressource caption.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque : Ce paramètre est exclusivement destiné aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube CMS qui agit au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données vidéo et de chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS réel avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
tfmt string
Le paramètre tfmt spécifie que la piste de sous-titres doit être renvoyée dans un format spécifique. Si le paramètre n'est pas inclus dans la requête, la piste est renvoyée dans son format d'origine.

Les valeurs acceptées sont les suivantes :
  • sbv : sous-titres SubViewer
  • scc : format Scenarist Closed Caption
  • srt : sous-titres SubRip
  • ttml : sous-titres Timed Text Markup Language
  • vtt : sous-titres Web Video Text Tracks
tlang string
Le paramètre tlang spécifie que la réponse de l'API doit renvoyer une traduction de la piste de sous-titres spécifiée. La valeur du paramètre est un code de langue ISO 639-1 à deux lettres qui identifie la langue de sous-titres souhaitée. La traduction est générée à l'aide de la traduction automatique, comme Google Traduction.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un fichier binaire. L'en-tête Content-Type de la réponse est application/octet-stream.

Erreurs

Le tableau ci-dessous identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel à cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
forbidden (403) forbidden Les autorisations associées à la requête ne sont pas suffisantes pour télécharger la piste de sous-titres. Il est possible que la requête ne soit pas correctement autorisée.
invalidValue (400) couldNotConvert Les données de la piste de sous-titres n'ont pas pu être converties dans la langue et/ou le format demandés. Assurez-vous que les valeurs tfmt et tlang demandées sont valides et que le snippet.status de la piste de sous-titres demandée n'est pas failed.
notFound (404) captionNotFound La piste de sous-titres est introuvable. Vérifiez la valeur du paramètre id de la requête pour vous assurer qu'elle est correcte.

Essayer

Utilisez le APIs Explorer pour appeler cette API et afficher la requête et la réponse.