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

Métodos

create

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

list

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