Captions: download

Descarga una pista de subtítulos. La pista de subtítulos se muestra en su formato original, a menos que la solicitud especifique un valor para el parámetro tfmt, y en su idioma original, a menos que la solicitud especifique un valor para el parámetro tlang.

Impacto en la cuota: Una llamada a este método tiene un costo de cuota de 200 unidades.

Este método requiere que el usuario tenga permiso para editar el video.

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/captions/id

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parámetros

La tabla a continuación muestra los parámetros compatibles con esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
id string
El parámetro id identifica la pista de subtítulos que se recuperará. El valor es un ID de pista de subtítulos, según lo identifica la propiedad id en un recurso caption.
Parámetros opcionales
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud debidamente autorizada. Nota: Este parámetro está destinado exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios de contenido autenticarse una vez y acceder a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.
tfmt string
El parámetro tfmt especifica que la pista de subtítulos debe mostrarse en un formato específico. Si el parámetro no se incluye en la solicitud, la pista se muestra en su formato original.

Los valores admitidos son los siguientes:
  • sbv : Subtítulo de SubViewer
  • scc : Formato de subtítulos codificados de Scenarist
  • srt : Subtítulo de SubRip
  • ttml : Subtítulo de Timed Text Markup Language
  • vtt : Subtítulo de Web Video Text Tracks
tlang string
El parámetro tlang especifica que la respuesta de la API debe mostrar una traducción de la pista de subtítulos especificada. El valor del parámetro es un código de idioma de dos letras de la norma ISO 639-1 que identifica el idioma de subtítulos deseado. La traducción se genera mediante la traducción automática, como Google Traductor.

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud cuando invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un archivo binario. El encabezado Content-Type de la respuesta es application/octet-stream.

Errores

En la tabla a continuación se identifican los mensajes de error que la API podría mostrar en respuesta a una invocación de este método. Consulta la documentación sobre mensajes de error para obtener más información.

Tipo de error Detalle del error Descripción
forbidden (403) forbidden Los permisos asociados con la solicitud no son suficientes para descargar la pista de subtítulos. Puede que la solicitud no esté debidamente autorizada.
invalidValue (400) couldNotConvert No se pudieron convertir los datos de la pista de subtítulos al idioma o formato solicitados. Asegúrate de que los valores tfmt y tlang solicitados sean válidos y que el snippet.status de la pista de subtítulos solicitada no sea failed.
notFound (404) captionNotFound No se encontró la pista de subtítulos. Verifica el valor del parámetro id de la solicitud para asegurarte de que sea correcto.

Pruébalo

Usa el APIs Explorer para llamar a esta API y ver la solicitud a la API y la respuesta.