LiveBroadcasts: cuepoint

Inserta un punto de inserción en una transmisión en vivo. Es posible que el punto de inserción active una pausa publicitaria.

Nota: Este método reemplaza al método liveCuepoints.insert, que exigía que una cuenta asociada a un propietario de contenido de YouTube autorizara las solicitudes. Este método no tiene el mismo requisito de autorización.

Solicitud

Solicitud HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

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 autenticación de OAuth 2.0.

Alcance
https://www.googleapis.com/auth/youtube
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
id string
El parámetro id identifica la transmisión en la que se inserta el punto de inserción. La transmisión debe estar transmitiendo contenido de forma activa cuando se inserta el punto de inserción.
Parámetros opcionales
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada adecuada.
Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite que los propietarios de contenido se autentiquen una vez y realicen acciones en nombre del canal especificado en el valor del parámetro, sin tener que proporcionar credenciales de autenticación diferentes para cada canal independiente. La cuenta con la que se autentica el usuario debe estar vinculada al propietario del contenido de YouTube especificado.
El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de YouTube que actúa en nombre del propietario del contenido de YouTube especificado en el valor del parámetro. Este parámetro está destinado a los socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes.
onBehalfOfContentOwnerChannel string
Este parámetro solo se puede usar en una solicitud autorizada adecuada.
Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite que los propietarios de contenido se autentiquen una vez y realicen acciones en nombre del canal especificado en el valor del parámetro, sin tener que proporcionar credenciales de autenticación para cada canal por separado.
El parámetro onBehalfOfContentOwnerChannel especifica el ID del canal de YouTube asociado con la transmisión en la que se inserta el punto de inserción. Este parámetro es obligatorio cuando una solicitud especifica un valor para el parámetro onBehalfOfContentOwner y solo se puede usar junto con ese parámetro. También se aplican los siguientes requisitos:
  • La solicitud debe estar autorizada con una cuenta de usuario vinculada al propietario del contenido que especifica el parámetro onBehalfOfContentOwner.
  • El canal que especifica el valor del parámetro onBehalfOfContentOwnerChannel debe estar vinculado al propietario del contenido que especifica el parámetro onBehalfOfContentOwner.

Cuerpo de la solicitud

Proporciona un recurso cuepoint en el cuerpo de la solicitud. En la siguiente estructura JSON, se muestra el formato de un recurso cuepoint:

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }
 En el cuerpo de la solicitud, el campo cueType es obligatorio y debe establecerse como cueTypeAd. También puedes establecer valores para estas propiedades:
  • durationSecs
  • insertionOffsetTimeMs (no se debe establecer si se establece walltimeMs)
  • walltimeMs (no se debe establecer si se establece insertionOffsetTimeMs)

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
id string
Es un valor que YouTube asigna para identificar de forma única el punto de inserción. Ten en cuenta que este valor es diferente del parámetro id obligatorio, que identifica la transmisión. Este valor se puede omitir cuando se envía una solicitud para insertar un punto de inserción. El valor se propagará en la respuesta de la API.
insertionOffsetTimeMs long
El valor de la propiedad identifica una compensación horaria, en milisegundos, cuando se debe insertar el punto de inserción. El valor se mide desde el principio de la transmisión del monitor y su valor predeterminado es 0, lo que indica que el punto de inserción se debe insertar lo antes posible. No debes especificar un valor para este parámetro si tu transmisión no tiene una transmisión de monitor.

Aunque se mide en milisegundos, el valor es en realidad una aproximación, y YouTube insertará el punto de inserción lo más cerca posible de ese tiempo.

Los valores distintos de cero para este campo solo se admiten si la transmisión de la transmisión está retrasada. Si tu transmisión de emisión no se retrasa, 0 es el único valor válido. Para obtener más detalles, consulta Cómo comenzar.

Nota: Si tu transmisión tuvo una fase de prueba, el desfase se mide desde el momento en que comenzó la fase de prueba.

La API muestra un error si una solicitud intenta insertar un punto de inserción que especifique un valor para esta propiedad y para la propiedad walltimeMs.
walltimeMs integer
El valor de la propiedad especifica la hora real en la que se debe insertar el punto de inserción. El valor es un número entero que representa una marca de tiempo de época (en milisegundos).

La API muestra un error si una solicitud intenta insertar un punto de inserción que especifique un valor para esta propiedad y para la propiedad insertionOffsetTimeMs.
durationSecs unsigned integer
Es la duración del punto de inserción, en segundos. El valor debe ser un número entero positivo. El valor predeterminado es 30.
cueType string
Es el tipo de punto de inserción. El valor de la propiedad debe establecerse en cueTypeAd.

Respuesta

Si la respuesta es correcta, este método muestra el recurso cuepoint insertado 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 información, consulta API de YouTube Live Streaming: Errores.

Tipo de error Detalle del error Descripción
insufficientPermissions (403) insufficientLivePermissions La solicitud no está autorizada para insertar un punto de inserción en la transmisión en vivo.
insufficientPermissions (403) liveStreamingNotEnabled El usuario que autorizó la solicitud no está habilitado para transmitir video en vivo en YouTube. El usuario puede encontrar más información en Cómo comenzar a transmitir en vivo y Elegibilidad para las funciones.
rateLimitExceeded (403) userRequestsExceedRateLimit El usuario envió demasiadas solicitudes en un período determinado.
required (400) idRequired El parámetro id obligatorio debe identificar la transmisión en la que deseas insertar un punto de inserción.
required (400) cueTypeRequired El campo cueType obligatorio se debe especificar en el cuerpo de la solicitud a la API.
notFound (404) liveBroadcastNotFound No existe la transmisión especificada por el parámetro id.
invalidValue (400) conflictingTimeFields Solo se puede especificar uno de insertionOffsetTimeMs y walltimeMs. Si estableces ambos valores, se generará un error. Si no estableces ninguno de los valores, YouTube usará el tiempo predeterminado de insertionOffsetTimeMs (0), lo que significa que el punto de inserción se insertará lo antes posible.
invalidValue (400) invalidInsertionOffsetTimeMs El recurso cuepoint especificó un valor no válido para la propiedad insertionOffsetTimeMs. El valor debe ser 0 o un número entero positivo.
invalidValue (400) invalidWalltimeMs El recurso cuepoint especificó un valor no válido para la propiedad walltimeMs. El valor debe ser un número entero que represente una marca de tiempo de época (en milisegundos).
backendError (5xx) serviceUnavailable El servicio no está disponible. Vuelve a realizar la solicitud en unos minutos.

Pruébalo

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