REST Resource: adBreak.networks.assets.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/{network_code}/assets/{asset_key}/adBreaks/{adBreakId}".

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 Base64 do ponto final 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.

BreakState

O estado de um intervalo de anúncio.

Tipos enumerados
BREAK_STATE_UNSPECIFIED O estado do intervalo de anúncio é desconhecido.
BREAK_STATE_DECISIONED A decisão de intervalo de anúncio foi iniciada, mas ainda não foi entregue aos usuários.
BREAK_STATE_COMPLETE O intervalo de anúncio foi entregue 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. Aplicável somente quando a programação de vários intervalos está ativada no evento de transmissão ao vivo. Por padrão, os intervalos de anúncio expiram 30 minutos após o expectedStartTime ou 30 minutos após o início da decisão do intervalo de anúncio, se o expectedStartTime não estiver definido. É possível definir explicitamente uma validade 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 de posição 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 de tag de anúncio na solicitação de anúncio principal.

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

Em geral, 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 lugares 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 for um número inteiro positivo válido. Isso é válido até 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 exibiçã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 integrado 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, essa etapa será ignorada.

scte35Upid

string

Opcional. UPID (identificador exclusivo do programa) do 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 elemento binário ou XML do SCTE-35. Se estiver vazio, essa etapa será ignorada.

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 do evento de splice/ID do evento de segmentação). O ID do evento é um valor analisado do elemento binário ou XML do SCTE-35. Se estiver vazio, essa etapa será ignorada.

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 o expectedDuration do intervalo de anúncio, com uma tolerância de 100 ms. Se for falso, essa etapa será ignorada.

ServedBreak

Representa as 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. A hora em que o intervalo de anúncio correspondente é detectado. Para a veiculação de pod, esse é o momento em que o primeiro segmento/manifesto do pod de anúncios é solicitado. Para DAI unida, é 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 de anúncio 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 de anúncio 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.