Captions: list

Affiche une liste des pistes de sous-titres associées à une vidéo spécifié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 sur le quota : un appel à cette méthode coûte 50 unités de quota.

Cas d'utilisation courants

Requête

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

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

Paramètres

Le tableau suivant répertorie les paramètres acceptés par cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part spécifie les parties de la ressource caption que la réponse de l'API inclura.

La liste ci-dessous contient les noms part que vous pouvez inclure dans la valeur du paramètre :
  • id
  • snippet
videoId string
Le paramètre videoId spécifie l'ID de la vidéo YouTube 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 destiné exclusivement 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 de 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é.

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 des sous-titres correspondant aux critères de la requête.

Erreurs

Le tableau suivant 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 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 requête ne soit pas correctement autorisée.
notFound (404) captionNotFound Impossible de trouver une ou plusieurs des pistes de sous-titres spécifiées. Cette erreur se produit si le paramètre videoId identifie une vidéo réelle, mais que le paramètre id identifie des ID de piste de sous-titres qui n'existent pas ou des ID de piste associés à d'autres vidéos. Vérifiez les valeurs des paramètres id et videoId de la requête pour vous assurer qu'elles sont correctes.
notFound (404) videoNotFound Impossible de trouver la vidéo identifiée par le paramètre videoId.

Essayer

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