Intégration: sous-titres

Les exemples suivants montrent comment utiliser l'API YouTube Data (v3) pour exécuter des fonctions liées aux sous-titres.

Récupérer une liste de pistes de sous-titres pour une vidéo

Pour récupérer la liste des pistes de sous-titres disponibles pour une vidéo spécifique, appelez la méthode captions.list. Définissez la valeur du paramètre videoId sur l'ID vidéo YouTube qui identifie la vidéo pour laquelle vous souhaitez récupérer des sous-titres. Votre requête doit être autorisée à l'aide du protocole OAuth 2.0.

La requête ci-dessous permet de récupérer la liste des sous-titres d'une vidéo de la chaîne YouTube Google Stories:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

Consultez la documentation de la méthode captions.list pour obtenir des exemples de code.

Créer une piste de sous-titres

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car ce dernier ne permet pas d'importer des fichiers, ce qui est obligatoire pour cette méthode.

Vous pouvez utiliser la méthode captions.insert de l'API pour ajouter une nouvelle piste de sous-titres à une vidéo. Lorsque vous importez un titre, vous devez spécifier une valeur pour les propriétés de ressources caption suivantes:

• snippet.videoId : identifie la vidéo à laquelle est ajoutée la piste de sous-titres.
• snippet.language : langue de la piste de sous-titres.
• snippet.name : nom de la piste de sous-titres.

Lorsque vous importez une piste de sous-titres, vous disposez des options supplémentaires suivantes:

• Si vous définissez le paramètre sync sur true, YouTube ignore les codes temporels du fichier de sous-titres importé et génère de nouveaux codes temporels pour ces sous-titres.

  Définissez 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 souhaitez que YouTube tente de les résoudre.

• Si vous définissez la propriété snippet.isDraft de la ressource caption sur true, le titre ne sera pas visible publiquement.

Consultez la documentation de la méthode captions.insert pour obtenir des exemples de code.

Télécharger une piste de sous-titres

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car celui-ci ne permet pas de télécharger des fichiers.

Pour télécharger une piste de sous-titres spécifique, appelez la méthode captions.download. Définissez la valeur du paramètre id sur l'ID de la piste de sous-titres YouTube qui identifie de manière unique la piste de sous-titres que vous téléchargez. Votre requête doit être autorisée à l'aide du protocole OAuth 2.0.

La version 3 de l'API est compatible avec les options suivantes:

• Pour spécifier qu'une piste de sous-titres doit être renvoyée dans un format spécifique, définissez la valeur du paramètre tfmt pour identifier le format souhaité. La définition du paramètre répertorie les valeurs acceptées.

• Pour obtenir la traduction d'une piste de sous-titres, définissez la valeur du paramètre tlang sur un code de langue ISO 639-1 à deux lettres identifiant la langue de sous-titres souhaitée. La traduction est générée à l'aide de la traduction automatique, telle que Google Traduction.

Consultez la documentation de la méthode captions.download pour obtenir des exemples de code.

Modifier une piste de sous-titres

L'API permet de modifier l'état du brouillon d'une piste de sous-titres et/ou d'importer une nouvelle piste de sous-titres pour un fichier.

Vous pouvez utiliser l'explorateur des API pour tester la capacité à modifier l'état de brouillon d'un canal. Toutefois, vous ne pouvez pas utiliser l'explorateur des API pour mettre à jour la piste de sous-titres, car cet outil ne permet pas d'importer des fichiers.

La requête ci-dessous permet de récupérer la liste des sous-titres d'une vidéo de la chaîne YouTube Google Stories:

La demande définit l'état de brouillon d'une piste de sous-titres sur true, ce qui signifie que la piste ne sera pas visible publiquement. Pour terminer la requête dans APIs Explorer, vous devez définir la valeur de la propriété id pour identifier une piste de sous-titres.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

Consultez la documentation de la méthode captions.update pour obtenir des exemples de code.

Supprimer une piste de sous-titres

Cet exemple montre comment supprimer une piste de sous-titres. L'exemple comprend les étapes suivantes:

• Étape 1: Récupérez l'ID de la piste de sous-titres

  Suivez les étapes ci-dessus pour récupérer la liste des pistes de sous-titres d'une vidéo. Cette liste peut être utilisée pour afficher une liste de pistes de sous-titres, en utilisant l'ID de chaque piste comme clé.

• Étape 2: Supprimez le canal

  Appelez la méthode captions.delete pour supprimer une vidéo spécifique. Dans la requête, le paramètre id spécifie l'ID de la piste de sous-titres que vous souhaitez supprimer. La requête doit être autorisée à l'aide d'OAuth 2.0. Si vous testez cette requête dans l'explorateur des API, vous devez remplacer l'ID de la piste de sous-titres valide par la valeur du paramètre id.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
  id=CAPTION_TRACK_ID