Captions: insert

Carga 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 MIME de los medios aceptados: 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 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

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 del recurso 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 utilizar 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.
sync boolean
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 encuentran en el archivo de subtítulos subido y generará códigos de hora nuevos para los subtítulos.

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

Cuerpo de la solicitud

Proporciona un recurso de subtítulos 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 se aplica correctamente, este método muestra un recurso de subtítulo en el cuerpo de la respuesta.

Errores

En la siguiente tabla se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a 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
badRequest (400) contentRequired La solicitud no incluye el contenido de la pista de subtítulos.
conflict (409) captionExists El video especificado ya tiene una pista de subtítulos con los valores de snippet.language y snippet.name especificados. Un video puede tener varias pistas para el mismo idioma, pero cada una debe tener un nombre diferente.

Existen varias maneras de solucionar el error. Puedes eliminar la pista existente y luego insertar una nueva, o 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 que impiden 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.

Pruébela.

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