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 elle spécifie une valeur pour le paramètre tlang.

Impact sur les quotas:un appel à cette méthode a un coût de quota de 200 unités.

Cas d'utilisation courants

Demande

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

Portée
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
Réglages obligatoires
id string
Le paramètre id identifie la piste de sous-titres en cours de récupération. La valeur est un ID de piste de sous-titres 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 réservé aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire de 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 différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants 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 indique 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, le titre est renvoyé dans son format d'origine.

Les valeurs acceptées sont les suivantes :
  • sbv – Sous-titre du lecteur
  • scc : format Scenarist Closed Caption
  • srt : sous-titre SubRip
  • ttml : légende du langage de balisage de texte avec code temporel
  • vtt : légende des pistes vidéo Web
tlang string
Le paramètre tlang indique 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, telle que Google Traduction.

Corps de la requête

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

Réponse

Lorsque cette méthode fonctionne, elle 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 pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

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 demande ne soit pas autorisée correctement ou que l'ordre des vidéos n'ait pas activé les contributions tierces pour ce sous-titre.
invalidValue (400) couldNotConvert Impossible de convertir les données de la piste de sous-titres dans la langue et/ou le format demandés. Vérifiez 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 que la valeur du paramètre id de la requête est correcte.

Essayer

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