Captions: insert

Importe une piste de sous-titres.

Cette méthode est compatible avec l'importation de contenus multimédias. Les fichiers importés doivent respecter les contraintes suivantes:

  • Taille maximale des fichiers:100 Mo
  • Types MIME multimédias acceptés:text/xml, application/octet-stream, */*

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

Cas d'utilisation courants

Requête

Requête HTTP

POST https://www.googleapis.com/upload/youtube/v3/captions

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'autorisation OAuth 2.0.

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
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. Définissez la valeur du paramètre sur snippet.

La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre:
  • id
  • snippet
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête autorisée appropriée.

Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube agissant au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenus YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenus 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é.
sync boolean
Ce paramètre est obsolète. Le paramètre sync indique si YouTube doit synchroniser automatiquement le fichier de sous-titres avec la piste audio de la vidéo. Si vous définissez la valeur sur true, YouTube ignorera tous les codes temporels du fichier de sous-titres importé et générera de nouveaux codes temporels pour les sous-titres.

Vous devez définir le paramètre sync sur true si vous importez une transcription, qui ne comporte pas de codes temporels, ou si vous pensez que les codes temporels de votre fichier sont incorrects et que vous souhaitez que YouTube tente de les corriger.

Corps de la requête

Fournissez une ressource caption dans le corps de la requête. Pour cette ressource:

Vous devez spécifier une valeur pour les propriétés suivantes:

  • snippet.videoId
  • snippet.language
  • snippet.name

Vous pouvez définir des valeurs pour les propriétés suivantes:

  • snippet.videoId
  • snippet.language
  • snippet.name
  • snippet.isDraft

Réponse

Si la requête aboutit, cette méthode renvoie une ressource caption dans le corps de la réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez API YouTube Data - Erreurs.

Type d'erreur Détail de l'erreur Description
badRequest (400) contentRequired La requête ne contient pas le contenu de la piste de sous-titres.
conflict (409) captionExists La vidéo spécifiée comporte déjà une piste de sous-titres avec les snippet.language et snippet.name indiqués. Une vidéo peut contenir plusieurs pistes pour la même langue, mais chaque piste doit avoir un nom différent.

Il existe plusieurs façons de résoudre cette erreur. Vous pouvez supprimer le canal existant, puis en insérer un nouveau ou modifier le nom du nouveau canal avant de l'insérer.
forbidden (403) forbidden Les autorisations associées à la requête ne sont pas suffisantes pour importer la piste de sous-titres. La requête n'est peut-être pas correctement autorisée.
invalidValue (400) invalidMetadata La requête contient des valeurs de métadonnées non valides, ce qui empêche la création du titre. Vérifiez que la requête spécifie des valeurs valides pour les propriétés snippet.language, snippet.name et snippet.videoId. La propriété snippet.isDraft peut également être incluse, mais elle n'est pas obligatoire.
notFound (404) videoNotFound Impossible de trouver la vidéo identifiée par le paramètre videoId.
invalidValue (400) nameTooLong L'snippet.name spécifié dans la requête est trop long. La longueur maximale autorisée est de 150 caractères.

Essayer

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