REST Resource: adBreak.networks.assets.adBreaks

Recurso: AdBreak

Metadados de intervalo de anúncio usados para anúncios de decisão em um intervalo de anúncio em um evento de vídeo ao vivo.

Representação 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

Apenas saída. O nome do recurso do intervalo de anúncio. Esse campo terá o formato "networks//assets//adBreaks/".

network_code é o código da rede no Google Ad Manager a que o conteúdo pertence.

asset_key é a chave do evento de transmissão ao vivo no Google Ad Manager em que a pausa para anúncio foi criada.

adBreakId é a chave do intervalo de anúncio. SOMENTE SAÍDA.
createTime

string (Timestamp format)

Apenas saída. O horário de criação do intervalo de anúncio.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Obrigatório. Duração esperada do intervalo.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
customParams
(deprecated)

string

Opcional. Pares de chave-valor a serem incluídos nas solicitações de anúncio desse intervalo para a segmentação de critérios personalizados no Ad Manager. Exemplo: "key1=value&key2=value2,value22". Descontinuado: defina cust_params em breakParams.ad_tag_params usando a chave "cust_params".
scte35CueOut

string

Opcional. Dados codificados em base 64 da saída de sinalização scte35. Pode incluir o comando splice_insert() ou time_signal(). Exemplos: - com time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - com splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Opcional. Nome do modelo de conjunto do Google Ad Manager. Descontinuado: defina cust_params em breakParams.ad_tag_params usando a chave "ptpln".
breakState

enum (BreakState)

Apenas saída. O estado atual do intervalo de anúncio.
expectedStartTime

string (Timestamp format)

Opcional. O horário de início esperado do intervalo de anúncio.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Opcional. Expira o intervalo de anúncio em expectedStartTime + expireDuration. Se expectedStartTime não estiver definido, o intervalo vai expirar expireDuration após o início da decisão. Padrão: 30 minutos. Mínimo: 5 minutos. Máximo: 6 horas.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
breakSequence

string (int64 format)

Apenas saída. O ID da sequência de mid-roll do intervalo comercial. Várias pausas para anúncios podem ter o mesmo breakSequence se forem especificadas explicitamente usando breakParams.ad_tag_params com a chave mridx. Isso vincula dois intervalos de anúncio do GAM.
breakParams

object (BreakParams)

Opcional. Parâmetros de intervalo a serem incluídos nas solicitações de anúncio para esse intervalo.
matchParams

object (MatchParams)

Opcional. Usado na DAI combinada para determinar como um intervalo de anúncio criado pela API é correspondido a um intervalo de anúncio no manifesto. Quando um novo intervalo é detectado, uma função de correspondência é executada em todos os intervalos de anúncio de um evento que têm um breakState de SCHEDULED ou DECISIONED para verificar se todos os parâmetros definidos em matchParams de um intervalo de anúncio correspondem ao intervalo detectado. Uma correspondência ocorre se uma destas condições for atendida: 1. O intervalo de anúncio tem um campo "matchParams", e todos os parâmetros definidos nele correspondem ao novo intervalo de anúncio. 2. O intervalo comercial é DECISIONED e não tem um campo "matchParams".

Para evitar o comportamento acidental de "correspondência com tudo" (que ocorreria com um matchParams vazio, mas presente), matchParams não pode estar vazio se definido. Se o campo estiver presente em uma solicitação, pelo menos um dos campos dele precisará ser definido.

As pausas para anúncios são verificadas nesta ordem: 1. com matchParams, ordenadas por expectedStartTime crescente, createTime crescente, em que as pausas para anúncios sem expectedStartTime são priorizadas quando classificadas; 2. sem matchParams, ordenadas por expectedStartTime crescente, createTime crescente, em que as pausas para anúncios sem expectedStartTime são priorizadas quando classificadas.

Se todos os EABNs pendentes não corresponderem, a DAI vai voltar ao comportamento de tomada de decisão JIT usando o próximo índice de mid-roll disponível.
servedBreak

object (ServedBreak)

Apenas saída. Isso reflete as informações reais do intervalo de anúncio veiculado. Definido apenas para intervalos de anúncio com um COMPLETE breakState.

BreakState

O estado de um intervalo de anúncio.

Tipos enumerados
BREAK_STATE_UNSPECIFIED O estado do intervalo comercial é desconhecido.
BREAK_STATE_DECISIONED A decisão de intervalo comercial foi iniciada, mas ainda não foi entregue aos usuários.
BREAK_STATE_COMPLETE A pausa para anúncio foi veiculada aos usuários.
BREAK_STATE_SCHEDULED O intervalo de anúncio está programado para tomada de decisão.
BREAK_STATE_EXPIRED O intervalo de anúncio expirou e não pode ser usado. Por padrão, os intervalos comerciais expiram 30 minutos após o expectedStartTime ou 30 minutos após o início da decisão de intervalo comercial, se expectedStartTime não estiver definido. Uma validade pode ser definida explicitamente usando o campo "expireDuration".

BreakParams

Parâmetros associados a um intervalo de anúncio.

Representação JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Campos
macros[]

object (KeyValue)

Opcional. Valores de macro personalizados que substituem um marcador arbitrário na tag de anúncio. No momento da solicitação de anúncio, a DAI vai expandir as macros de tag de anúncio no formato %%DAI_PATTERN:[MACRO_KEY]%%, em que MACRO_KEY é a chave.

Se definidas, essas macros terão precedência sobre as macros definidas em uma solicitação de veiculação de pod.
adTagParams[]

object (KeyValue)

Opcional. Substitui os parâmetros da tag de anúncio na solicitação de anúncio principal.

Eles são usados para tomada de decisões se forem acionados antes das solicitações de veiculação de pod com cust_params definidos.

Geralmente, os parâmetros substituem um parâmetro de string de consulta na solicitação de anúncio principal do intervalo. Em alguns servidores de anúncios com formatos de URL personalizados, os parâmetros podem substituir locais específicos na tag de anúncio para atender aos requisitos do servidor. Definir o valor "mridx" no AdBreak vai substituir o campo "breakSequence" pelo valor fornecido, se ele for um número inteiro positivo válido. Isso é válido mesmo para servidores de anúncios que não são do GAM.

Se definidos, esses parâmetros terão precedência sobre os parâmetros definidos em uma solicitação de serviço de pod.

KeyValue

Representa um par de chave-valor.

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string

Obrigatório. Chave desse par de chave-valor.
value

string

Obrigatório. Valor desse par de chave-valor.

MatchParams

Parâmetros para corresponder a um intervalo de anúncio de DAI costurada detectado.

Representação JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Campos
scte35Binary

string

Opcional. Binário SCTE-35. Para corresponder a esse campo, o intervalo de anúncio no manifesto precisa ter a mesma string binária SCTE-35 (codificada em base64). Se estiver vazio, será ignorado.
scte35Upid

string

Opcional. UPID (identificador exclusivo do programa) SCTE-35. Para corresponder a esse campo, o intervalo de anúncio no manifesto precisa ter o mesmo UPID SCTE-35. O UPID é um valor analisado do binário SCTE-35. Se estiver vazio, será ignorado.
scte35EventId

integer (uint32 format)

Opcional. ID do evento SCTE-35. Para corresponder a esse campo, o intervalo de anúncio no manifesto precisa ter o mesmo ID de evento (ID de evento de junção/ID de evento de segmentação). O ID do evento é um valor analisado do binário SCTE-35. Se estiver vazio, será ignorado.
breakDuration

boolean

Opcional. Duração do intervalo. Para corresponder a esse campo, o intervalo de anúncio no manifesto precisa ter a mesma duração que expectedDuration do intervalo de anúncio, com uma tolerância de 1 ms. Se for "false", essa etapa será ignorada.

ServedBreak

Representa informações reais do intervalo de anúncio veiculado.

Representação JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Campos
breakDetectTime

string (Timestamp format)

Apenas saída. O momento em que o intervalo de anúncio correspondente é detectado. Para a veiculação de pods, esse é o momento em que o primeiro segmento/manifesto do conjunto de anúncios é solicitado. Para a DAI costurada, é quando o intervalo de anúncio é detectado pela primeira vez no manifesto.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Apenas saída. A duração detectada transmitida no intervalo de anúncio correspondente.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
scte35CueOut

string

Apenas saída. A mensagem SCTE-35 codificada em base64 detectada foi transmitida no intervalo de anúncio correspondente.

Métodos

create

 API para criar um intervalo comercial na transmissão ao vivo.

delete

 API para excluir um intervalo de anúncio na transmissão ao vivo.

get

 API para receber um intervalo comercial na transmissão ao vivo.

list

 API para listar intervalos de anúncio na transmissão ao vivo.

patch

 API para atualizar um intervalo de anúncio na transmissão ao vivo.