Renvoie la liste des pistes de sous-titres associées à une vidéo donnée. Notez que la réponse de l'API ne contient pas les sous-titres réels et que la méthode captions.download
permet de récupérer une piste de sous-titres.
Impact du quota : un appel à cette méthode a un coût de quota de 50 unités.
Cas d'utilisation courants
Demande
Requête HTTP :
GET https://www.googleapis.com/youtube/v3/captions
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 suivant répertorie 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 | ||
part |
string Le paramètre part spécifie les parties de la ressource caption qui seront incluses dans la réponse de l'API.La liste ci-dessous contient les noms des part que vous pouvez inclure dans la valeur du paramètre:
|
|
videoId |
string Le paramètre videoId spécifie l'ID vidéo YouTube de la vidéo pour laquelle l'API doit renvoyer des pistes de sous-titres. |
|
Paramètres facultatifs | ||
id |
string Le paramètre id spécifie une liste d'ID séparés par une virgule qui identifient les ressources caption à récupérer. Chaque ID doit identifier une piste de sous-titres associée à la vidéo spécifiée. |
|
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é. |
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 corps de réponse présentant la structure suivante :
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés | |
---|---|
kind |
string Identifie le type de ressource de l'API. La valeur sera youtube#captionListResponse . |
etag |
etag ETag de cette ressource. |
items[] |
list Liste de sous-titres correspondant aux critères de requête. |
Erreurs
Le tableau suivant 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 |
Impossible de récupérer une ou plusieurs pistes de sous-titres, car les autorisations associées à la requête ne sont pas suffisantes pour récupérer les ressources demandées. Il est possible que la demande ne soit pas autorisée correctement. |
notFound (404) |
captionNotFound |
Une ou plusieurs pistes de sous-titres spécifiées sont introuvables. Cette erreur se produit si le paramètre videoId identifie une vidéo réelle, mais que le paramètre id identifie les ID de piste de sous-titres qui n'existent pas ou les ID de suivi associés à d'autres vidéos. Vérifiez que les valeurs des paramètres id et videoId de la requête sont correctes. |
notFound (404) |
videoNotFound |
La vidéo identifiée par le paramètre videoId est introuvable. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.