REST Resource: 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.

Métodos

create

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

list

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