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 de médias acceptés:text/xml, application/octet-stream, */*

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

Cas d'utilisation courants

Requête

Requête HTTP

POST https://www.googleapis.com/upload/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

Définition du 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 compatibles avec cette requête. Tous les paramètres répertorié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 qui seront incluses dans la réponse de l'API. 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 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é.
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 les codes temporels du fichier de sous-titres mis en ligne 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 sans code temporel, 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

Indiquez une ressource de légende dans le corps de la requête. Pour cette ressource:

  • Vous devez spécifier une valeur pour ces propriétés:

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

  • Vous pouvez définir des valeurs pour ces propriétés:

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

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource de légende 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 la documentation sur les messages d'erreur.

Type d'erreur Détails 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 possède déjà une piste de sous-titres avec les valeurs snippet.language et snippet.name données. Une vidéo peut avoir 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 la piste existante, puis en insérer une nouvelle ou modifier son nom avant de l'insérer.
forbidden (403) forbidden Les autorisations associées à la demande ne sont pas suffisantes pour importer la piste de sous-titres. La requête n'a peut-être pas été autorisée correctement.
invalidValue (400) invalidMetadata La requête contient des valeurs de métadonnées non valides, ce qui empêche la création du titre. Confirmez 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 ce n'est pas obligatoire.
notFound (404) videoNotFound Impossible de trouver la vidéo identifiée par le paramètre videoId.
invalidValue (400) nameTooLong Le 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.