API dinâmica de veiculação de conjunto de Inserção de anúncios dinâmicos

A API Dynamic Ad Insertion permite solicitar e rastrear transmissões ao vivo da DAI.

Serviço: dai.google.com

Todos os URIs são relativos a https://dai.google.com.

Método: stream

Métodos
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Registra uma sessão de transmissão ao vivo de veiculação de conjunto DAI.

Solicitação HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.

custom_asset_key string

O identificador personalizado associado a esse evento no Google Ad Manager.

Corpo da solicitação

O corpo da solicitação é do tipo application/x-www-form-urlencoded e contém os seguintes parâmetros:

Parâmetros
Parâmetros de segmentação do DFP Opcional Outros parâmetros de segmentação.
Modificar os parâmetros de stream Opcional Substitua os valores padrão de um parâmetro de criação de stream.
Autenticação HMAC Opcional Autentique usando um token baseado em HMAC.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter um novo objeto Stream.

Open Measurement

A API DAI contém informações para verificação do Open Measurement no campo Verifications. Esse campo contém um ou mais elementos Verification que listam os recursos e metadados necessários para executar o código de medição de terceiros e verificar a reprodução do criativo. Somente JavaScriptResource é aceito. Para mais informações, consulte o IAB Tech Lab (em inglês) e a especificação do VAST 4.1 (em inglês).

Método: segmento de pod

Métodos
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Cria um stream de DAI para o ID do evento especificado.

Solicitação HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.

custom_asset_key string

O identificador personalizado associado a esse evento no Google Ad Manager.

pod_identifier

Os seguintes formatos são compatíveis:

pod/{integer}

O identificador numérico do intervalo de anúncio atual. Os IDs de agrupamento de anúncios são atribuídos de forma incremental para cada evento de intervalo de anúncio, começando em 1.

ad_break_id/{string}

O identificador de string do intervalo de anúncio atual. Um ID de intervalo comercial fornecido pelo publisher não tem as mesmas restrições que um ID de conjunto de anúncios. Qualquer ID de intervalo de anúncio desconhecido fornecido a esse endpoint cria um novo intervalo de anúncio para o evento de transmissão ao vivo.

profile_name string

O nome do perfil de codificação DAI do Google Ad Manager solicitado. O perfil de codificação precisa ser um dos perfis configurados para o evento selecionado.

segment_number integer

O índice do segmento solicitado no pod de anúncio atual, começando em zero.
segment_format string

A extensão de arquivo associada ao formato de segmento solicitado. As extensões aceitas são: ts, mp4, vtt, aac, ac3 ou eac3.

Parâmetros de consulta

Parâmetros
stream_id required string

O ID do fluxo da sessão do usuário atual. Esse valor é retornado por uma solicitação bem-sucedida ao endpoint stream.
sd required1 integer

A duração do segmento solicitado, em milissegundos.
so opcional

O deslocamento do segmento solicitado no conjunto de anúncios, em milissegundos. Se você omitir o parâmetro so, ele será calculado multiplicando a duração do segmento pelo número do segmento.
pd obrigatório2 integer

A duração do conjunto de anúncios, em milissegundos.
auth-token required string

Um token HMAC assinado e codificado por URL para o bloco de anúncios atual.
last opcional boolean

Indica o último segmento no intervalo de anúncio. Omita esse parâmetro para todos os outros segmentos.
scte35 opcional string

Sinal SCTE-35 codificado em Base64 para este intervalo de anúncio.
cust_params opcional string

Um conjunto de pares de chave-valor usado para a segmentação de campanha do Ad Manager. Esses pares precisam ser representados como uma string de consulta codificada em URL.

Exemplo:
Parâmetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Notas de rodapé

  1. sd não é obrigatório para segmentos de inicialização. ↩
  2. pd não é necessário para eventos com intervalos de anúncios sem duração ativados. ↩

Exemplo

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta será um segmento de stream reproduzível que corresponde ao formato e aos parâmetros especificados na solicitação.

Método: manifesto do pod HLS

Recupera um manifesto de bloco de anúncios HLS de uma transmissão ao vivo pronta para ser carregada e reproduzida por um player de vídeo do cliente.

Métodos
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API para recuperar uma playlist multivariante HLS para um conjunto de anúncios.

Solicitação HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.
custom_asset_key string

O identificador personalizado associado a este evento no Google Ad Manager.
pod_identifier

Os seguintes formatos são compatíveis:

pod/{integer}

O identificador numérico do intervalo de anúncio atual. Os IDs de agrupamento de anúncios são atribuídos de forma incremental para cada evento de intervalo de anúncio, começando em 1.

ad_break_id/{string}

O identificador de string do intervalo de anúncio atual. Um ID de intervalo comercial fornecido pelo publisher não tem as mesmas restrições que um ID de conjunto de anúncios. Qualquer ID de intervalo de anúncio desconhecido fornecido a esse endpoint cria um novo intervalo de anúncio para o evento de transmissão ao vivo.

Parâmetros de consulta

Parâmetros
stream_id Obrigatório string

O ID do fluxo da sessão do usuário atual. Esse valor é retornado por uma solicitação bem-sucedida ao endpoint stream.
pd Obrigatório integer

A duração do conjunto de anúncios, em milissegundos.
scte35 opcional string

Sinal SCTE-35 codificado em Base64 para este intervalo de anúncio.
cust_params opcional string

Um conjunto de pares de chave-valor usado para a segmentação de campanha do Ad Manager. Esses pares precisam ser representados como uma string de consulta codificada em URL.

Exemplo:
Parâmetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta será uma playlist multivariante HLS.

Método: manifesto de conjunto DASH

Recupera um manifesto de conjunto de anúncios MPEG-DASH de uma transmissão ao vivo pronta para ser carregada e reproduzida por um player de vídeo do cliente.

Métodos
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API para recuperar uma playlist mpd MPEG-DASH para um conjunto de anúncios.

Solicitação HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.
custom_asset_key string

O identificador personalizado associado a este evento no Google Ad Manager.
stream_id string

O ID do fluxo da sessão do usuário atual. Esse valor é retornado por uma solicitação bem-sucedida ao endpoint stream.
pod_id integer

O identificador numérico do intervalo de anúncio atual. Os IDs de agrupamento de anúncios são atribuídos de forma incremental para cada evento de intervalo de anúncio, começando em 1.

Parâmetros de consulta

Parâmetros
pd Obrigatório integer

A duração do conjunto de anúncios, em milissegundos.
scte35 opcional string

Sinal SCTE-35 codificado em Base64 para este intervalo de anúncio.
cust_params opcional string

Um conjunto de pares de chave-valor usado para a segmentação de campanha do Ad Manager. Esses pares precisam ser representados como uma string de consulta codificada em URL.

Exemplo:
Parâmetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta será uma playlist mpd MPEG-DASH.

Método: modelo de período de pod do DASH

Métodos
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Solicita um modelo de período DASH do Google Ad Manager. Esse modelo contém macros que precisam ser preenchidas com os parâmetros do seu stream. Depois que essas macros forem preenchidas, o modelo vai se tornar seu período de intervalo do anúncio e poderá ser inserido no manifesto DASH.

Solicitação HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.

custom_asset_key string

O identificador personalizado associado a esse evento no Google Ad Manager.

Parâmetros de consulta

Parâmetros
stream_id required string

O ID do fluxo da sessão do usuário atual. Esse valor é retornado por uma solicitação bem-sucedida ao endpoint stream.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter um novo objeto PodTemplateResponse.

Método: metadados de tempo do conjunto de anúncios

Métodos
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Recupera metadados de tempo de um conjunto de anúncios.

Solicitação HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Parâmetros de caminho

Parâmetros
network_code string

O código de rede do Google Ad Manager do publisher.

custom_asset_key string

O identificador personalizado associado a esta transmissão ao vivo no Google Ad Manager.

Parâmetros de consulta

Parâmetros
stream_id Obrigatório string

O ID do stream do Ad Manager no app player de vídeo do cliente.
ad_break_id required string

O ID do próximo intervalo comercial.

Os IDs de intervalo de anúncio são fornecidos pelo servidor de junção ou pelo VTP e precisam corresponder em notificações antecipadas de intervalo de anúncio, solicitações de metadados de tempo de conjunto de anúncios e solicitações de redirecionamento de segmento para o mesmo intervalo de anúncio.

As seguintes restrições se aplicam a IDs de intervalo comercial personalizados:

  • Precisa ter entre 1 e 63 caracteres
  • Precisa conter apenas letras minúsculas, dígitos e hífens.
  • O ID do intervalo de anúncio preroll é reservado para recuperar o conjunto de anúncios precedentes. Não é possível usar para identificar nenhum outro pod de anúncio.
auth-token required string

O auth-token consiste em um token HMAC com os seguintes parâmetros:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout opcional integer

O número de milissegundos que a DAI pode bloquear essa solicitação para aguardar a decisão de publicidade. Use esse parâmetro em solicitações que precisam retornar anúncios preenchidos na primeira solicitação, como intervalos de anúncios pre-roll.

Se o tempo limite for excedido, a solicitação vai retornar um status pendente.

Se incluído, o valor de tempo limite precisa estar entre 1.000 e 15.000 milissegundos. Se omitido, as respostas não serão atrasadas para aguardar a decisão de publicidade.
final opcional boolean

Defina como true para indicar à DAI que esta é a última solicitação que o VTP está disposto a fazer para esse conjunto de anúncios. Se uma decisão de anúncio ainda não estiver disponível (pelo tempo limite opcional), a DAI vai retornar uma tela permanentemente para essa solicitação.

O valor padrão é false.

Parâmetros de decisão de anúncio
pd opcional integer

A duração do intervalo de anúncio (em milissegundos). Também chamada de duração do pod de anúncio.

Se o EABN for usado, o valor de pd precisará corresponder à duração fornecida na notificação de intervalo do anúncio. Se as durações não corresponderem, o valor do EABN terá prioridade.

cust_params opcional string

Parâmetros personalizados para segmentação de intervalos de anúncio, conforme descrito na Central de Ajuda do Ad Manager.
scte35 opcional string

Um sinal SCTE-35 codificado em Base64.

Se o indicador for inválido, uma mensagem será enviada no cabeçalho HTTP X-Ad-Manager-Dai-Warning da resposta, e a solicitação será enviada sem o valor scte35 inválido.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter um novo objeto AdPodTimingMetadataResponse.

Método: verificação de mídia

Depois de encontrar um identificador de mídia de anúncio durante a reprodução, faça imediatamente uma solicitação usando o media_verification_url obtido do endpoint stream acima. Essas solicitações não são necessárias para streams de beacon do lado do servidor, em que o servidor inicia a verificação de mídia.

As solicitações para o endpoint media verification são idempotentes.

Métodos
media verification GET /{media_verification_url}/{ad_media_id}

Notifica a API sobre um evento de verificação de mídia.

Solicitação HTTP

GET https://{media-verification-url}/{ad-media-id}

Corpo da resposta

media verification retorna as seguintes respostas:

  • HTTP/1.1 204 No Content se a verificação de mídia for bem-sucedida e todos os pings forem enviados.
  • HTTP/1.1 404 Not Found se a solicitação não puder verificar a mídia devido à formatação ou expiração incorreta do URL.
  • HTTP/1.1 404 Not Found se uma solicitação de verificação anterior para esse ID foi concluída.
  • HTTP/1.1 409 Conflict se outra solicitação já estiver enviando pings no momento.

IDs da mídia do anúncio

Os identificadores de mídia de anúncios serão codificados em uma faixa de metadados separada: metadados com carimbo de data/hora para fluxo de transporte HLS ou emsg para arquivos mp4. Os identificadores de mídia de anúncio sempre começam com a string google_.

Todo o conteúdo de texto da entrada de metadados precisa ser anexado ao URL de verificação do anúncio antes de cada solicitação de verificação.

Método: metadata

O endpoint de metadados em metadata_url retorna informações usadas para criar uma interface do usuário de anúncios. O endpoint de metadados não está disponível para fluxos de beaconing do lado do servidor, em que o servidor é responsável por iniciar a verificação de mídia de anúncios.

Métodos
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Recupera informações de metadados de anúncios.

Solicitação HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Corpo da resposta

Se a solicitação for bem-sucedida, a resposta vai retornar uma instância de PodMetadata.

Como analisar metadados

Os metadados têm três seções distintas: tags, ads e breaks do anúncio. O ponto de entrada dos dados é a seção tags. Em seguida, itere pelas tags e encontre a primeira entrada cujo nome seja um prefixo do ID da mídia do anúncio encontrado no fluxo de vídeo. Por exemplo, você pode ter um ID de mídia de anúncio como este:

google_1234567890

Em seguida, encontre um objeto de tag chamado google_12345. Nesse caso, ele corresponde ao ID da mídia do seu anúncio. Depois de encontrar o objeto de prefixo de mídia de anúncio correto, você pode pesquisar IDs de anúncio, IDs de intervalo de anúncio e o tipo de evento. Os IDs de anúncio são usados para indexar os objetos ads, e os IDs de intervalo de anúncio são usados para indexar os objetos breaks.

Dados de resposta

Stream

O stream é usado para renderizar uma lista de recursos para um stream recém-criado em formato JSON.
Representação JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Campos
stream_id string

O identificador do fluxo do GAM.
media_verification_url string

O URL de verificação de mídia usado como endpoint base para rastrear eventos de reprodução.
metadata_url string

URL de metadados usado para pesquisar informações periódicas sobre os próximos eventos de anúncios em stream.
session_update_url string

O URL de atualização da sessão usado para atualizar os parâmetros de segmentação deste fluxo. Os valores originais dos parâmetros de segmentação são capturados durante a solicitação inicial de criação de stream.
heartbeat_url string

O URL de pulsação, usado para manter a transmissão de beacons do lado do servidor ativa, precisa ser pingado a cada {PollingFrequency} segundos. Preenchido para streams de beacon do lado do servidor.
polling_frequency number

A frequência de pesquisa, em segundos, ao solicitar metadata_url ou heartbeat_url.
pod_manifest_url string

O modelo de URL do manifesto do conjunto é usado para gerar o URL que recupera o manifesto do conjunto de uma transmissão, correspondente ao URL da playlist multivariante em HLS ou ao MPD em DASH. Preenchido para eventos de transmissão ao vivo do tipo POD_SERVING_MANIFEST da Inserção de anúncios dinâmicos. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

O formato do manifesto é o formato do manifesto recuperado de pod_manifest_url, dash ou hls.

PodMetadata

PodMetadata contém informações de metadados sobre anúncios, intervalos comerciais e tags de ID de mídia.
Representação JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
Campos
tags map[string, object(TagSegment)]

Mapa de segmentos de tag indexados por prefixo de tag.
ads map[string, object(Ad)]

Mapa de anúncios indexados por ID do anúncio.
ad_breaks map[string, object(AdBreak)]

Mapa de intervalos de anúncio indexados pelo ID do intervalo de anúncio.

TagSegment

O TagSegment contém uma referência a um anúncio, à pausa para anúncio e ao tipo de evento. TagSegment com type="progress" não deve ser pingado para o endpoint de verificação de mídia do anúncio.
Representação JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Campos
ad string

O ID do anúncio desta tag.
ad_break_id string

O ID do intervalo de anúncio desta tag.
type string

O tipo de evento desta tag.

AdBreak

"AdBreak" descreve um único intervalo de anúncio no stream. Ele contém uma duração, um tipo (meio/antes/depois) e o número de anúncios.
Representação JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Campos
type string

Os tipos de quebra válidos são: pre, mid e post.
duration number

Duração total do anúncio para este intervalo, em segundos.
expected_duration number

Duração esperada do intervalo de anúncio (em segundos), incluindo todos os anúncios e qualquer slate.
ads number

Número de anúncios no intervalo.
"Ad" descreve um anúncio no stream.
Representação JSON
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Campos
ad_break_id string

O ID do intervalo de anúncio deste anúncio.
position number

Posição deste anúncio no intervalo, começando em 1.
duration number

Duração do anúncio, em segundos.
title string

Título opcional do anúncio.
description string

Descrição opcional do anúncio.
advertiser string

Identificador de anunciante opcional.
ad_system string

Sistema de anúncios opcional.
ad_id string

ID do anúncio opcional.
creative_id string

ID do criativo opcional.
creative_ad_id string

ID opcional do anúncio criativo.
deal_id string

ID da transação opcional.
clickthrough_url string

URL de clique opcional.
click_tracking_urls string

URLs de rastreamento de cliques opcionais.
verifications [object(Verification)]

Entradas opcionais de verificação da Open Measurement que listam os recursos e os metadados necessários para executar o código de medição de terceiros e verificar a reprodução do criativo.
slate boolean

Booleano opcional que indica se a entrada atual é uma recomendação.
icons [object(Icon)]

Uma lista de ícones, omitida se estiver vazia.
wrappers [object(Wrapper)]

Uma lista de Wrappers, omitida se estiver vazia.
universal_ad_id object(UniversalAdID)

ID universal do anúncio opcional.
extensions string

Lista opcional de todos os nós <Extension> no VAST.
companions [object(Companion)]

Complementares opcionais que podem ser exibidos com este anúncio.
interactive_file object(InteractiveFile)

Criativo interativo opcional (SIMID) que deve ser exibido durante a reprodução do anúncio.

PodTemplateResponse

PodTemplateResponse representa o payload JSON retornado a um VTP para junção de pods.
Representação JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Campos
dash_period_template string

DashPeriodTemplate é o modelo XML do período a ser preenchido com os dados adequados antes da junção.
segment_duration_ms int64

SegmentDurationMS é a duração dos segmentos de período em milissegundos.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse contém informações sobre o Ad Pod e como criar URLs de segmento para ele.
Representação JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Campos
status string

Status da decisão para o conjunto de anúncios.
ads [object(AdRendering)]

Matriz de objetos de anúncio que descrevem como renderizar os URLs de segmento de anúncio, indexados a partir de 0.
slate object(SlateRendering)

Uma descrição de como renderizar os URLs de segmentos de slate.
dash_representations map[string, object(DASHRepresentation)]

Lista de representações DASH para que o conjunto de anúncios seja renderizado em manifestos DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Lista de conjuntos de adaptação DASH para que o bloco de anúncios seja renderizado em manifestos DASH.

AdRendering

O AdRendering descreve como renderizar um anúncio com decisão tomada.
Representação JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Campos
duration_ms number

Duração do anúncio, em milissegundos (int).
variants map[string, object(VariantRendering)]

Dicionário de objetos Variant (veja abaixo), indexado pelo ID da variante/perfil, conforme configurado na interface.

SlateRendering

O SlateRendering descreve como renderizar conteúdo do Slate.
Representação JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Campos
duration_ms number

Duração da tela de espera, em milissegundos (int).
variants map[string, object(VariantRendering)]

Dicionário de objetos Variant, indexado por ID de variante/perfil. As durações de tela precisam ser repetidas até que o comprimento necessário seja atingido, inserindo descontinuidades de HLS entre as iterações ou repetindo novos períodos para MPEG-DASH.

VariantRendering

O VariantRendering descreve uma variante/perfil no anúncio/slate.
Representação JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Campos
segment_extension string

String, um destes: ts, mp4, aac, ac3, ec3, m4a, m4v. Extensão do nome de arquivo que faz parte dos URLs de segmento.
segment_durations Objetos object(SegmentDurations)

SegmentDurations. Cada duração de segmento pode ser convertida em um URL de segmento.

SegmentDurations

"SegmentDurations" descreve a duração de uma sequência de segmentos em uma unidade de tempo especificada.
Representação JSON
{
  "timescale": number,
  "values": [],
}
Campos
timescale number

A escala de tempo é o número de unidades por segundo (int) Esperado: 1000 para HLS (milissegundos) 90000 para vídeo DASH (PTS) Taxa de amostragem de áudio para áudio DASH.
values number

Matriz de durações de segmento de números inteiros, em unidades de escala de tempo.

DASHRepresentation

DASHRepresentation descreve os nós de representação a serem renderizados em manifestos DASH.
Representação JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Campos
codecs string

Codecs da representação.
bandwidth number

Largura de banda da representação.
width number

Largura da representação.
height number

Altura da representação.
frame_rate string

Frame rate da representação.
audio_sampling_rate number

Taxa de amostragem de áudio da representação.
audio_channel_config object(SchemeIDURIAndValue)

Configuração do canal de áudio da representação.

DASHAdaptationSet

O DASHAdaptationSet descreve os nós AdaptationSet a serem renderizados em manifestos DASH.
Representação JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Campos
content_type string

Tipo de conteúdo do conjunto de adaptações.
mime_type string

Tipo MIME do conjunto de adaptação.
role object(SchemeIDURIAndValue)

Função do conjunto de adaptação.
inband_event_stream object(SchemeIDURIAndValue)

Fluxo de eventos no canal do conjunto de adaptação.
min_frame_rate string

Frame rate mínimo do conjunto de adaptação.
max_frame_rate string

Frame rate máximo do conjunto de adaptação.
scan_type string

Tipo de verificação do conjunto de adaptação.
start_with_sap string

Comece com o SAP do conjunto de adaptação.
segment_alignment boolean

Alinhamento de segmento do conjunto de adaptação.
representations string

Representações do conjunto de adaptação.

SchemeIDURIAndValue

"SchemeIDURIAndValue" é um par de um ID de esquema e seu valor.
Representação JSON
{
  "scheme_id_uri": string,
  "value": string,
}
Campos
scheme_id_uri string

URI do ID do esquema do valor.
value string

Valor do URI do ID do esquema.

Ícone

O ícone contém informações sobre um ícone VAST.
Representação JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Campos
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData contém informações sobre um clickthrough de ícone.
Representação JSON
{
  "url": string,
}
Campos
url string

FallbackImage

"FallbackImage" contém informações sobre uma imagem substituta VAST.
Representação JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Campos
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

O wrapper contém informações sobre um anúncio wrapper. Ele não inclui um ID de negociação se ele não existir.
Representação JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Campos
system string

Identificador do sistema de publicidade.
ad_id string

ID do anúncio usado para o anúncio wrapper.
creative_id string

ID do criativo usado no anúncio wrapper.
creative_ad_id string

ID do anúncio criativo usado para o anúncio wrapper.
deal_id string

ID opcional da transação para o anúncio de wrapper.

Verificação

A verificação contém informações para o Open Measurement, que facilita a visibilidade e a medição de verificação de terceiros. No momento, apenas recursos JavaScript são aceitos. Consulte https://iabtechlab.com/standards/open-measurement-sdk/
Representação JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Campos
vendor string

O fornecedor de verificação.
java_script_resources [object(JavaScriptResource)]

Lista de recursos JavaScript para a verificação.
tracking_events [object(TrackingEvent)]

Lista de eventos de rastreamento para a verificação.
parameters string

Uma string opaca transmitida ao código de verificação de bootstrap.

JavaScriptResource

JavaScriptResource contém informações para verificação via JavaScript.
Representação JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Campos
script_url string

URI para payload JavaScript.
api_framework string

APIFramework é o nome da estrutura de vídeo que exerce o código de verificação.
browser_optional boolean

Indica se o script pode ser executado fora de um navegador.

TrackingEvent

TrackingEvent contém URLs que precisam ser pingados pelo cliente em determinadas situações.
Representação JSON
{
  "event": string,
  "uri": string,
}
Campos
event string

O tipo do evento de rastreamento.
uri string

O evento de rastreamento a ser pingado.

UniversalAdID

O UniversalAdID é usado para fornecer um identificador exclusivo de criativo que é mantido em todos os sistemas de publicidade.
Representação JSON
{
  "id_value": string,
  "id_registry": string,
}
Campos
id_value string

O ID universal do anúncio do criativo selecionado para o anúncio.
id_registry string

Uma string usada para identificar o URL do site de registro em que o ID universal do anúncio do criativo selecionado está catalogado.

Companion

Companion contém informações para anúncios complementares que podem ser exibidos com o anúncio.
Representação JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Campos
click_data object(ClickData)

Os dados de clique deste complemento.
creative_type string

O atributo "CreativeType" no nó <StaticResource> do VAST se for um complemento do tipo estático.
height int32

A altura em pixels deste complemento.
width int32

A largura em pixels deste complemento.
resource string

Para complementos estáticos e de iframe, esse será o URL a ser carregado e mostrado. Para complementares em HTML, esse será o snippet que deve ser mostrado como o complementar.
type string

Tipo de complemento. Ele pode ser estático, iframe ou HTML.
ad_slot_id string

O ID do slot para esse complemento.
api_framework string

O framework da API para este complemento.
tracking_events [object(TrackingEvent)]

Lista de eventos de rastreamento para este complemento.

InteractiveFile

O InteractiveFile contém informações para o criativo interativo (ou seja, SIMID) que deve ser exibido durante a reprodução do anúncio.
Representação JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Campos
resource string

O URL do criativo interativo.
type string

O tipo MIME do arquivo fornecido como recurso.
variable_duration boolean

Indica se o criativo pode pedir a extensão da duração.
ad_parameters string

O valor do nó <AdParameters> no VAST.