Captions: update

Met à jour une piste de sous-titres. Lorsque vous mettez à jour une piste de sous-titres, vous pouvez modifier son état de brouillon, importer un nouveau fichier de sous-titres pour la piste, ou les deux.

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

Impact sur le quota : un appel à cette méthode coûte 450 unités de quota.

Cas d'utilisation courants

Requête

Requête HTTP

PUT 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

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 listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part a deux objectifs dans cette opération. Il identifie les propriétés que l'opération d'écriture définira, ainsi que celles que la réponse de l'API inclura. Définissez la valeur de la propriété sur snippet si vous mettez à jour l'état de brouillon de la piste. Sinon, définissez la valeur de la propriété sur id.

La liste suivante contient les part noms 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 correctement autorisée. Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le onBehalfOfContentOwner paramètre indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube 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éos et de chaînes, 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. Remarque : Le serveur d'API ne traite la valeur de paramètre que si la requête contient un fichier de sous-titres mis à jour.

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 synchronisera automatiquement la piste de sous-titres avec la piste audio.

Corps de la requête

Fournissez une ressource de sous-titres dans le corps de la requête. Pour cette ressource :

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

    • id

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

    • snippet.isDraft

    Si vous envoyez une requête de mise à jour et que celle-ci ne spécifie pas de valeur pour une propriété qui en possède déjà une, la valeur existante de la propriété sera supprimée.

Réponse

Si la requête aboutit, cette méthode renvoie une ressource de sous-titres 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 à 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 n'a pas importé de fichier de sous-titres mis à jour. Le contenu réel de la piste est requis si le paramètre sync est défini sur true.
forbidden (403) forbidden Les autorisations associées à la requête ne sont pas suffisantes pour mettre à jour la piste de sous-titres. Il est possible que la requête ne soit pas correctement autorisée.
notFound (404) captionNotFound La piste de sous-titres spécifiée est introuvable. Vérifiez la valeur de la propriété id de la requête pour vous assurer qu'elle est correcte.

Essayer

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