REST Resource: adBreak.networks.assets.adBreaks

Recurso: AdBreak

Son los metadatos de la pausa publicitaria que se usan para tomar decisiones sobre los anuncios de una pausa publicitaria en un evento de video en vivo.

Representación JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Campos
name

string

Solo salida. Es el nombre del recurso de la pausa publicitaria. Este campo tendrá el formato "networks//assets//adBreaks/".

network_code es el código de red en Google Ad Manager al que pertenece este contenido.

asset_key es la clave del evento de transmisión en vivo en Google Ad Manager en el que se creó la pausa publicitaria.

adBreakId es la clave de la pausa publicitaria. SOLO SALIDA.
createTime

string (Timestamp format)

Solo salida. Es la fecha y hora de creación de la pausa publicitaria.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Obligatorio. Es la duración esperada de la pausa.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
customParams
(deprecated)

string

Opcional. Pares clave-valor que se incluirán en las solicitudes de anuncios de esta pausa para la segmentación de criterios personalizados en Ad Manager. Ejemplo: "key1=value&key2=value2,value22" En desuso: Establece cust_params en breakParams.ad_tag_params con la clave "cust_params".
scte35CueOut

string

Opcional. Son los datos codificados en Base64 del indicador de salida de scte35. Puede incluir el comando splice_insert() o time_signal(). Ejemplos: - Con time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - Con splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Opcional. Es el nombre de la plantilla del grupo de anuncios de Google Ad Manager. Obsoleto: Configura cust_params en breakParams.ad_tag_params con la clave "ptpln".
breakState

enum (BreakState)

Solo salida. Es el estado actual de la pausa publicitaria.
expectedStartTime

string (Timestamp format)

Opcional. Es la hora de inicio esperada de la pausa publicitaria.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Opcional. Vence la pausa publicitaria en expectedStartTime + expireDuration. Si no se establece expectedStartTime, el corte publicitario vencerá expireDuration después de que comience la toma de decisiones. Valor predeterminado: 30 min. Mínimo: 5 min. Máximo: 6 h

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
breakSequence

string (int64 format)

Solo salida. Es el ID de la secuencia de anuncios durante el video de la pausa publicitaria. Es posible que varias pausas publicitarias tengan el mismo breakSequence si se especifica de forma explícita a través de breakParams.ad_tag_params con la clave mridx. Esto vincula de manera eficaz dos pausas publicitarias de GAM.
breakParams

object (BreakParams)

Opcional. Son los parámetros de la pausa que se incluirán en las solicitudes de anuncios para esta pausa.
matchParams

object (MatchParams)

Opcional. Se usa para la DAI unida para determinar cómo se relaciona una pausa publicitaria creada a través de la API con una pausa publicitaria en el manifiesto. Cuando se detecta una nueva pausa, se ejecutará una función de coincidencia en todas las pausas publicitarias de un evento que tengan un breakState de SCHEDULED o DECISIONED para verificar si todos los parámetros establecidos en matchParams de una pausa publicitaria coinciden con la pausa detectada. Se produce una coincidencia si se cumple alguna de las siguientes condiciones: 1. El corte publicitario tiene un campo matchParams, y todos los parámetros establecidos en él coinciden con el corte nuevo. 2. La pausa publicitaria es DECISIONED y no tiene un campo matchParams.

Para evitar el comportamiento accidental de "coincidencia con todo" (que ocurriría con un matchParams vacío pero presente), matchParams no puede estar vacío si se configura. Si el campo está presente en una solicitud, se debe establecer al menos uno de sus propios campos.

Las pausas publicitarias se verifican en este orden: 1. Con matchParams, ordenadas por expectedStartTime ascendente y createTime ascendente, donde se priorizan las pausas publicitarias sin expectedStartTime cuando se ordenan 2. Sin matchParams, ordenadas por expectedStartTime ascendente y createTime ascendente, donde se priorizan las pausas publicitarias sin expectedStartTime cuando se ordenan

Si no coinciden todos los EABN pendientes, la DAI recurrirá al comportamiento de toma de decisiones JIT utilizando el siguiente índice de anuncios intercalados disponible.
servedBreak

object (ServedBreak)

Solo salida. Esto refleja la información real de la pausa publicitaria publicada. Solo se configura para las pausas publicitarias con un COMPLETE breakState.

BreakState

Es el estado de una pausa publicitaria.

Enums
BREAK_STATE_UNSPECIFIED Se desconoce el estado de la pausa publicitaria.
BREAK_STATE_DECISIONED Se inició la toma de decisiones sobre la pausa publicitaria, pero aún no se entregó a los usuarios.
BREAK_STATE_COMPLETE Se entregó la pausa publicitaria a los usuarios.
BREAK_STATE_SCHEDULED La pausa publicitaria está programada para la toma de decisiones.
BREAK_STATE_EXPIRED La pausa publicitaria venció y no se puede usar. De forma predeterminada, las pausas publicitarias caducarán 30 minutos después de expectedStartTime o 30 minutos después de que la pausa publicitaria comience a tomar decisiones si no se establece expectedStartTime. Se puede establecer una fecha de vencimiento de forma explícita con el campo expireDuration.

BreakParams

Son los parámetros asociados a una pausa publicitaria.

Representación JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Campos
macros[]

object (KeyValue)

Opcional. Son valores de macros personalizados que reemplazan un marcador de posición arbitrario en la etiqueta de anuncio. En el momento de la solicitud de anuncio, la DAI expandirá las macros de etiquetas de anuncio en el formato %%DAI_PATTERN:[MACRO_KEY]%%, donde MACRO_KEY es la clave.

Si se configuran, estas macros tendrán prioridad sobre las macros establecidas en una solicitud de publicación de Pod.
adTagParams[]

object (KeyValue)

Opcional. Anula los parámetros de la etiqueta del anuncio en la solicitud de anuncio principal.

Se usan para la toma de decisiones si se activan antes de las solicitudes de publicación de Pod con cust_params establecidos.

Por lo general, los parámetros anulan un parámetro de cadena de consulta en la solicitud de anuncio principal de la pausa. En algunos servidores de anuncios con formatos de URL personalizados, los parámetros pueden anular lugares específicos en la etiqueta del anuncio para cumplir con los requisitos del servidor de anuncios. Si se establece el valor "mridx" en AdBreak, se anulará el campo breakSequence con el valor proporcionado, si es un número entero positivo válido. Esto se aplica incluso a los servidores de anuncios que no son de GAM.

Si se configuran, estos parámetros tendrán prioridad sobre los parámetros establecidos en una solicitud de Pod Serving.

KeyValue

Representa un par clave-valor.

Representación JSON 
{
  "key": string,
  "value": string
}
Campos
key

string

Obligatorio. Es la clave de este par clave-valor.
value

string

Obligatorio. Es el valor de este par clave-valor.

MatchParams

Son los parámetros que deben coincidir con una pausa publicitaria de DAI unida detectada.

Representación JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Campos
scte35Binary

string

Opcional. Es un valor binario de SCTE-35. Para que coincida este campo, la pausa publicitaria en el manifiesto debe tener la misma cadena binaria SCTE-35 (codificada en base64). Si está vacío, se omite.
scte35Upid

string

Opcional. Es el UPID (identificador de programa único) de SCTE-35. Para que coincida con este campo, la pausa publicitaria en el manifiesto debe tener el mismo UPID de SCTE-35. El UPID es un valor que se analiza a partir del objeto binario SCTE-35. Si está vacío, se omite.
scte35EventId

integer (uint32 format)

Opcional. ID del evento de SCTE-35. Para que este campo coincida, la pausa publicitaria en el manifiesto debe tener el mismo ID de evento (ID de evento de empalme o ID de evento de segmentación). El ID del evento es un valor que se analiza a partir del código binario SCTE-35. Si está vacío, se omite.
breakDuration

boolean

Opcional. Es la duración de la pausa. Para que coincida con este campo, la pausa publicitaria en el manifiesto debe tener la misma duración que la propiedad expectedDuration de la pausa publicitaria, con una tolerancia de 1 ms. Si es falso, se omite.

ServedBreak

Representa la información real de la pausa publicitaria publicada.

Representación JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Campos
breakDetectTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se detecta la pausa publicitaria coincidente. En el caso de la publicación de Pods, es el momento en que se solicita el primer segmento o manifiesto del Pod de anuncios. En el caso de la DAI unida, es el momento en que se detecta la pausa publicitaria por primera vez en el manifiesto.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Solo salida. Es la duración detectada que se pasó en la pausa publicitaria coincidente.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
scte35CueOut

string

Solo salida. Es el mensaje SCTE-35 codificado en base64 detectado que se pasó en la pausa publicitaria coincidente.

Métodos

create

 API para crear una pausa publicitaria en la transmisión en vivo.

delete

 API para borrar una pausa publicitaria dentro de la transmisión en vivo.

get

 API para obtener una pausa publicitaria dentro de la transmisión en vivo.

list

 API para enumerar las pausas publicitarias dentro de la transmisión en vivo.

patch

 API para actualizar una pausa publicitaria dentro de la transmisión en vivo.