Captions: insert

Sube una pista de subtítulos.

Este método admite la carga de medios. Los archivos cargados deben cumplir con los siguientes requisitos:

  • Tamaño máximo del archivo: 100 MB
  • Tipos de MIME de contenido multimedia admitidos: text/xml, application/octet-stream, */*

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

Casos de uso habituales

Solicitud

Solicitud HTTP

POST https://www.googleapis.com/upload/youtube/v3/captions

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes permisos. Para obtener más información sobre la autenticación y autorización, consulta Cómo implementar la autorización de OAuth 2.0.

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

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part especifica las partes de recursos caption que incluirá la respuesta de la API. Establece el valor del parámetro en snippet.

La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
  • id
  • snippet
Parámetros opcionales
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente.

Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario del 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.
sync boolean
Este parámetro dejó de estar disponible. El parámetro sync indica si YouTube debe sincronizar automáticamente el archivo de subtítulos con la pista de audio del video. Si estableces el valor 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 establecer el parámetro sync en true si subes 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.

Cuerpo de la solicitud

Proporciona un recurso caption en el cuerpo de la solicitud. Para ese recurso:

Debes especificar un valor para estas propiedades:

  • snippet.videoId
  • snippet.language
  • snippet.name

Puedes establecer los valores de las siguientes propiedades:

  • snippet.videoId
  • snippet.language
  • snippet.name
  • snippet.isDraft

Respuesta

Si la respuesta es correcta, este método muestra un recurso caption en el cuerpo de la respuesta.

Errores

En la siguiente tabla, se identifican los mensajes de error que podría mostrar la API en respuesta a una llamada a este método. Para obtener más detalles, consulta API de datos de YouTube: Errores.

Tipo de error Detalle del error Descripción
badRequest (400) contentRequired La solicitud no contiene el contenido de la pista de subtítulos.
conflict (409) captionExists El video especificado ya tiene una pista de subtítulos con los snippet.language y snippet.name proporcionados. Un video puede tener varias pistas para el mismo idioma, pero cada una debe tener un nombre diferente.

Existen varias formas de corregir el error. Puedes borrar la pista existente y, luego, insertar una nueva, o bien cambiar el nombre de la nueva pista antes de insertarla.
forbidden (403) forbidden Los permisos asociados con la solicitud no son suficientes para subir la pista de subtítulos. Puede que la solicitud no esté debidamente autorizada.
invalidValue (400) invalidMetadata La solicitud contiene valores de metadatos no válidos, lo que impide que se cree la pista. Confirma que la solicitud especifique valores válidos para las propiedades snippet.language, snippet.name y snippet.videoId. También se puede incluir la propiedad snippet.isDraft, pero no es obligatoria.
notFound (404) videoNotFound No se pudo encontrar el video identificado por el parámetro videoId.
invalidValue (400) nameTooLong El snippet.name especificado en la solicitud es demasiado largo. La longitud máxima admitida es de 150 caracteres.

Pruébalo

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