Descarga una pista de subtítulos. La pista de subtítulos se devuelve 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 de la cuota: Una llamada a este método tiene un costo de cuota de 200 unidades.
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 está recuperando. El valor es un ID de pista de subtítulos, tal como lo identifica la propiedad id en un recurso caption . |
|
Parámetros opcionales | ||
onBehalfOfContentOwner |
string Este parámetro solo se puede usar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido 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 varios 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 no se incluye el parámetro en la solicitud, la pista se muestra en su formato original.Los valores admitidos son los siguientes:
|
|
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 ISO 639-1 de dos letras que identifica el idioma deseado para los subtítulos. La traducción se genera con traducciones automáticas, como Google Traductor. |
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud cuando invoques este método.
Respuesta
Si se ejecuta correctamente, este método muestra un archivo binario. El encabezado Content-Type
para 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 o que el orden del video no haya habilitado las contribuciones de terceros para estos subtítulos. |
invalidValue (400) |
couldNotConvert |
No se pudieron convertir los datos de la pista de subtítulos al idioma o formato solicitado. 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 ha encontrado la pista de subtítulos. Comprueba el valor del parámetro id de la solicitud para asegurarte de que sea correcto. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.