Implementación: Subtítulos

Los siguientes ejemplos muestran cómo utilizar la API de datos de YouTube (v3) para realizar funciones relacionadas con los subtítulos.

Recuperar una lista de pistas de subtítulos de un video

Para recuperar una lista de pistas de subtítulos disponibles para un video específico, invoca el método captions.list. Establece el parámetro videoId en el ID de video de YouTube que identifica de forma exclusiva el video para el que recuperas subtítulos. Tu solicitud debe estar autorizada con OAuth 2.0.

La siguiente solicitud recupera una lista de subtítulos para un video del canal de YouTube Historias de Google:

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

Consulta la documentación del método captions.list para ver muestras de código.

Crear una pista de subtítulos

Esta consulta no se puede probar con el Explorador de API, ya que este no admite la capacidad de subir archivos, lo cual es un requisito para este método.

Puedes usar el método captions.insert de la API para subir una nueva pista de subtítulos para un video. Al subir una pista, debes especificar un valor para las siguientes propiedades de recurso de caption:

Las siguientes opciones adicionales están disponibles cuando se sube una pista de subtítulos:

  • Si configuras el parámetro sync en true, YouTube ignorará los códigos de tiempo que se encuentren en el archivo de subtítulos subido y generará códigos de tiempo nuevos para los subtítulos.

    Debes configurar el parámetro sync como true si vas a subir una transcripción que no tiene códigos de tiempo o si sospechas que los códigos de tiempo de tu archivo son incorrectos y quieres que YouTube intente corregirlos.

  • Si configuras la propiedad snippet.isDraft del recurso caption en true, el segmento no será visible públicamente.

Consulta la documentación del método captions.insert para ver muestras de código.

Descargar una pista de subtítulos

Esta consulta no se puede probar con el Explorador de API, ya que este no admite la capacidad de descargar archivos.

Para descargar una pista de subtítulos específica, llama al método captions.download. Establece el valor del parámetro id en el ID de la pista de subtítulos de YouTube que identifica exclusivamente la pista de subtítulos que deseas descargar. Tu solicitud debe estar autorizada con OAuth 2.0.

La API v3 admite las siguientes opciones:

  • Para especificar que se debe mostrar una pista de subtítulos en un formato específico, establece el valor del parámetro tfmt para identificar el formato deseado. La definición del parámetro muestra los valores admitidos.

  • Para recuperar la traducción de una pista de subtítulos, establece el valor del parámetro tlang en un código de idioma ISO 639-1 de dos letras que identifique el idioma de subtítulos deseado. La traducción se genera mediante una traducción automática, como Google Traductor.

Consulta la documentación del método captions.download para ver muestras de código.

Actualizar una pista de subtítulos

La API admite la capacidad de cambiar el estado del borrador de una pista de subtítulos, subir una nueva pista de subtítulos para un archivo o ambas opciones.

Puedes usar el Explorador de API para probar la capacidad de cambiar el estado de borrador de una pista. Sin embargo, no puedes usar el Explorador de API para actualizar la pista de subtítulos real, ya que la herramienta no permite cargar archivos.

La siguiente solicitud recupera una lista de subtítulos para un video del canal de YouTube Historias de Google:

La solicitud actualiza el estado del borrador de una pista de subtítulos a true, lo que significa que la pista no será visible públicamente. Para completar la solicitud en el Explorador de API, debes establecer el valor de la propiedad id a fin de identificar una pista de subtítulos.

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

Consulta la documentación del método captions.update para ver muestras de código.

Eliminar una pista de subtítulos

En este ejemplo, se muestra cómo eliminar una pista de subtítulos. El ejemplo tiene los siguientes pasos: