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 entraîne un coût du quota de 200 unités.
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 répertoriés sont des paramètres de requête.
| Paramètres | ||
|---|---|---|
| Paramètres obligatoires | ||
id |
stringLe 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, tel qu'il est identifié par la propriété id dans une ressource caption. |
|
| Paramètres facultatifs | ||
onBehalfOfContentOwner |
stringCe paramètre ne peut être utilisé que dans une demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement 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 un grand nombre de chaînes YouTube. Il 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 d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié. |
|
tfmt |
stringLe 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, la piste est renvoyée dans son format d'origine.Les valeurs acceptées sont les suivantes :
|
|
tlang |
stringLe 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 de ce paramètre est un code de langue ISO 639-1 à deux lettres qui identifie la langue des sous-titres. La traduction est générée à l'aide d'une 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 répertorie 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 demande ne sont pas suffisantes pour télécharger la piste de sous-titres. Il est possible que la demande n'ait pas été autorisée correctement ou que l'ordre de la vidéo 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. 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 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 et la réponse de l'API.