REST Resource: networks.sources.content.adBreaks

Recurso: AdBreak

Metadados de intervalo de anúncio usados para decidir os anúncios de um intervalo 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)
  },
  "adTag": string
}
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 de rede no Google Ad Manager ao qual esse conteúdo pertence.

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

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 vão ser 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 a segmentação por critérios personalizados usando a chave "cust_params" em breakParams.ad_tag_params.

scte35CueOut

string

Opcional. Dados codificados em base-64 da saída 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 o nome do modelo de conjunto usando a chave "ptpln" em breakParams.ad_tag_params.

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 for definido, o intervalo de anúncio vai expirar expireDuration após o início da decisão.

Requer que a programação de vários intervalos esteja ativada no evento de transmissão ao vivo.

Padrão: 30m Mínimo: 5m Máximo: 6h

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 intermediária do intervalo de anúncio. Vários intervalos de anúncio podem ter o mesmo breakSequence se especificado explicitamente por 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 para a DAI unida para determinar como um intervalo de anúncio criado pela API é correspondido a um intervalo de anúncio no manifesto. Requer que a programação de vários intervalos esteja ativada no evento de transmissão ao vivo. Quando um novo intervalo é detectado no manifesto, uma função de correspondência é executada em todos os intervalos de anúncio do 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.
  2. O intervalo de anúncio é DECISIONED e não tem um campo matchParams

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

Os intervalos de anúncio são verificados nesta ordem: 1. com matchParams, ordenados por expectedStartTime crescente, createTime crescente, em que os intervalos de anúncio sem expectedStartTime são priorizados quando classificados 2. sem matchParams, ordenados por expectedStartTime crescente, createTime crescente, em que os intervalos de anúncio sem expectedStartTime são priorizados quando classificados

Se todos os intervalos de anúncio pendentes não forem correspondentes, a DAI vai voltar ao comportamento de decisão JIT.

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 breakState COMPLETE.

adTag

string

Opcional. Substitui a tag de anúncio padrão do evento para esse intervalo de anúncio.

Métodos

create

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

list

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