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

A API Dynamic Ad Insertion permite solicitar e rastrear streams sob demanda da DAI.

Serviço: dai.google.com

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

Método: criar stream

Esse método cria um stream diretamente do dispositivo, retornando todos os recursos necessários para que o aplicativo cliente reproduza e rastreie anúncios, além de mostrar elementos da interface.

Métodos
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Crie uma sessão de vídeo sob demanda de veiculação de conjunto da DAI.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
network_code string

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

Corpo da solicitação

O corpo da solicitação é do tipo application/json e precisa conter um objeto CreateStreamRequest.

Corpo da resposta

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

Método: registrar stream

Esse método registra um fluxo no back-end da DAI do Google no dispositivo, retornando todos os recursos necessários para que o aplicativo cliente rastreie anúncios e mostre elementos da interface. Ao contrário do método create stream, esse método não retorna um manifesto de anúncios jogáveis. Em vez disso, essa ação é realizada em uma chamada de servidor separada: decision ad pods.

Métodos
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Registra uma sessão de vídeo sob demanda de veiculação de conjunto da DAI.

Solicitação HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Parâmetros de caminho

Parâmetros
network_code string

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

Corpo da solicitação

O corpo da solicitação é do tipo application/json e precisa conter um objeto StreamRegistrationRequest.

Corpo da resposta

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

Método: recuperar conjuntos de anúncios

Esse método segue uma chamada register stream de um dispositivo e é necessário para recuperar manifestos de anúncios reproduzíveis e juntar manifestos de conteúdo.

Métodos
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Conjuntos de anúncios de decisão para uma sessão de VOD de veiculação de conjunto DAI.

Solicitação HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Parâmetros de caminho

Parâmetros
network_code string

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

stream_id string

O stream_id recebido de uma chamada stream_registration.

Corpo da solicitação

O corpo da solicitação é do tipo application/json e precisa conter um objeto AdPodDecisionRequest.

Corpo da resposta

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

Método: metadados de conjuntos de anúncios

Esse método retorna todas as informações necessárias para que o app cliente rastreie anúncios e renderize elementos de interface adequados com precisão.

Métodos
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Recupera metadados de conjuntos de anúncios para uma sessão específica. Esse URL é retornado no atributo StreamRegistrationResponse metadata_url.

Solicitação HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter um objeto Ad pods metadata.

Objetos de API

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)],
  "polling_frequency": number,
}
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.
polling_frequency number

Frequência recomendada de pesquisa do URL de metadados, em segundos. Preenchido para transmissões de VOD usando decisões on demand.

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 enviado por ping ao 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/pré/pós) 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 fluxo.
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 do 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 opcional do anunciante.
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 medição aberta 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.

MatchOpts

MatchOpts especifica requisitos rigorosos de correspondência de mídia para um stream.
Representação JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Campos
audio_channels boolean

Corresponda os canais de áudio entre o conteúdo e os anúncios.
audio_sample_rate boolean

Corresponda a taxa de amostragem de áudio entre o conteúdo e os anúncios.

CreateStreamRequest

CreateStreamRequest descreve as informações encontradas em solicitações HTTP para a API de exibição de pods de VOD. A criação do stream é iniciada pelo VTP (parceiro de tecnologia de vídeo), em nome do SDK e do editor, para cada usuário. O stream criado resulta em conjuntos de anúncios decididos para o VTP unir. Isso contrasta com o fluxo StreamRegistrationRequest+AdPodDecisionRequest, que registra um stream e decide adpods em várias solicitações.
Representação JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Campos
encoding_profiles [object(EncodingProfile)]

Uma lista de perfis de codificação. Obrigatório.
ad_tag string

A tag de anúncio básica para tomada de decisões. Obrigatório.
cuepoints number

Uma lista de pontos de sinalização em segundos. Obrigatório quando a resposta da tag de anúncio usa compensações de tempo posicionais.
manifest_type string

Os tipos de manifesto válidos são: hls e dash. Padrão: hls. Opcional.
enable_hls_asset_list boolean

Indica se os intersticiais da lista de recursos HLS estão ativados. Quando ativada, a DAI retorna URLs de lista de recursos para cada intervalo de anúncio, que podem ser usados para intersticiais HLS.
targeting_parameters string

Parâmetros adicionais de segmentação do Ad Manager. Opcional.
content_duration_seconds number

ContentDurationSeconds é a duração do conteúdo em segundos. Obrigatório quando a resposta da tag de anúncio usa compensações de tempo em porcentagem.
decision_timing_options object(DecisionTimingOptions)

Indica quando os adpods devem ser decididos.
enable_inline_manifests boolean

Indica se os manifestos de quebra precisam ser inlinados na resposta JSON.
dai_options object(CreateStreamOptions)

DAIOptions para criação de fluxos.

CreateStreamOptions

"CreateStreamOptions" representa as opções disponíveis no fluxo de trabalho de criação de stream em uma etapa.
Representação JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Campos
dash_profile string

Perfil MPEG-DASH a ser usado: "live" ou "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Permite que os editores substituam a política padrão de compartilhamento de dados da rede.
sam_id string

sam_id é a chave de depuração do SAM para a sessão, opcional.
session_title string

session_title é o título da sessão do SAM para o stream, opcional.
dash_inband_event_stream boolean

dash_inband_event_stream indica que a DAI insere mensagens ID3 como eventos em banda (na mídia) usando o elemento InbandEventStream, em vez de elementos EventStream (no manifesto).
distinct_ad_profiles boolean

Se definido como "true", indica que o servidor usará qualquer perfil de anúncio disponível no máximo uma vez ao corresponder aos perfis de codificação solicitados.
tracking_mode string

tracking_mode é o tipo de acompanhamento de anúncios a ser usado no stream. É opcional. Os valores válidos são: "ad_media", "server", "client".
emsg_version uint32

emsg_version força o uso de uma versão específica do emsg para ID3s no conteúdo. Compatível apenas quando dash_inband_event_stream é verdadeiro.

StreamRegistrationRequest

O StreamRegistrationRequest registra um stream do dispositivo para decisões futuras de adpods. Isso contrasta com um CreateStreamRequest, que cria um stream e adpods de decisões em uma única solicitação.
Representação JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Campos
targeting_parameters string

Parâmetros adicionais de segmentação do Ad Manager. Opcional.
dai_options object(StreamRegistrationOptions)

DAIOptions para registro de stream.

StreamRegistrationOptions

StreamRegistrationOptions lista as opções disponíveis para a criação de streams.
Representação JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Campos
sam_id string

sam_id é a chave de depuração do SAM para a sessão, opcional.
tracking_mode string

tracking_mode é o tipo de acompanhamento de anúncios a ser usado no stream. É opcional. Os valores válidos são: "ad_media", "server", "client".
emsg_version uint32

emsg_version força o uso de uma versão específica do emsg para ID3s no conteúdo. Compatível apenas quando dash_inband_event_stream é verdadeiro.
skippable_ads_supported boolean

Indica se os anúncios puláveis são compatíveis.

StreamRegistrationResponse

StreamRegistrationResponse representa a resposta JSON enviada de volta ao cliente em resposta a um StreamRegistrationRequest. Ele inclui o ID da transmissão e todos os URLs de que o dispositivo vai precisar. O ID do stream pode ser referenciado em uma solicitação de decisão de adpod subsequente. Isso contrasta com um CreateStreamResponse, que representa uma resposta para criar um fluxo e adpods de decisão ao mesmo tempo.
Representação JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Campos
stream_id string

O StreamID é o identificador exclusivo da transmissão atual do espectador.
media_verification_url string

MediaVerificationURL é o prefixo de URL a ser usado nas solicitações de verificação de mídia de anúncios descritas abaixo. Ausente para streams de beacon do lado do cliente.
valid_for string

"ValidFor" é a duração em que este fluxo é válido, no formato "00h00m00s".
valid_until string

ValidUntil é a data e a hora até quando esta transmissão é válida.
metadata_url string

MetadataURL é o URL de metadados a ser usado para solicitar metadados de adpod.

DecisionTimingOptions

"DecisionTimingOptions" descreve as opções de tempo para intervalos comerciais de decisão na transmissão.
Representação JSON
{
  "type": string,
  "on_create_breaks": [],
}
Campos
type string

O tipo descreve quando os adpods são decididos para o stream. Os tipos válidos são: on_create (padrão) e on_demand. Quando o tipo é "on_demand", os anúncios são decididos de forma lenta quando o manifesto é solicitado para uma interrupção específica. Quando o tipo é "on_create", todos os anúncios são decididos quando o stream é criado.
on_create_breaks string

OnCreateBreaks é uma lista de breakIDs da VMAP sensíveis a maiúsculas e minúsculas que precisam ser decididos na criação da transmissão. Esse campo só é permitido se o tipo for "on_demand". Os identificadores especiais de intervalo de anúncio "preroll" e "postroll" podem ser usados para indicar que o intervalo precedente ou in-stream pós-vídeo deve ser decidido no momento da criação do stream.

EncodingProfile

O EncodingProfile descreve a codificação de uma única variante de conteúdo. Ele pode conter apenas configurações de vídeo, apenas configurações de áudio (no caso do tipo de mídia), configurações de vídeo e áudio ou nenhuma delas (no caso de legendas).
Representação JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Campos
profile_name string

O nome do perfil fornecido pelo publisher. Exclusivo por stream. Obrigatório.
type string

Os tipos válidos são: media, iframe, subtitles. Obrigatório.
container_type string

Os tipos válidos são: mpeg2ts, fmp4cmaf e hls_packed_audio. Obrigatório para mídia e iframe do tipo.
video_settings object(VideoSettings)

As configurações de vídeo são necessárias se o tipo de contêiner for iframe. Caso contrário, eles só vão aparecer se o perfil tiver vídeos.
audio_settings object(AudioSettings)

As configurações de áudio aparecem se o perfil tiver áudio. As configurações de áudio só são permitidas se o tipo de contêiner for mídia.
subtitle_settings object(SubtitleSettings)

As configurações de legendas são obrigatórias para o tipo "Digitar legendas".

VideoSettings

"VideoSettings" descreve o vídeo de um perfil de codificação. Se uma configuração de vídeo estiver presente, todas precisam estar.
Representação JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Campos
codec string

A string de codec RFC6381 do vídeo.
bitrate int32

A taxa de bits máxima do vídeo no perfil de codificação.
frames_per_second number

Os quadros por segundo do vídeo.
resolution object(Resolution)

A resolução de largura x altura do vídeo.

AudioSettings

AudioSettings descreve o áudio de um perfil de codificação. Se uma configuração de áudio estiver presente, todas precisarão estar.
Representação JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Campos
codec string

A string de codec RFC6381 do áudio.
bitrate int32

A taxa de bits máxima de áudio do perfil de codificação.
channels int32

O número de canais de áudio (incluindo canais de baixa frequência).
sample_rate int64

A taxa de amostragem do áudio, em hertz.

SubtitleSettings

SubtitleSettings descreve as legendas de um perfil de codificação.
Representação JSON
{
  "format": string,
  "language": string,
}
Campos
format string

O formato das legendas: webvtt para hls, webvtt ou ttml para dash.
language string

O idioma a ser inserido no manifesto.

Resolução

A resolução descreve a largura x altura de um vídeo.
Representação JSON
{
  "width": int32,
  "height": int32,
}
Campos
width int32

Largura do vídeo em pixels. Obrigatório.
height int32

Altura do vídeo, em pixels. Obrigatório.

AdPodDecisionRequest

"AdPodDecisionRequest" representa uma solicitação para decidir conjuntos de anúncios de uma transmissão registrada anteriormente.
Representação JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Campos
encoding_profiles [object(EncodingProfile)]

Uma lista de perfis de codificação. Obrigatório.
ad_tag string

A tag de anúncio básica para tomada de decisões. Obrigatório.
cuepoints number

Uma lista de pontos de sinalização em segundos. Obrigatório quando a resposta da tag de anúncio usa compensações de tempo posicionais.
manifest_type string

Os tipos de manifesto válidos são: hls e dash. Padrão: hls. Opcional.
enable_hls_asset_list boolean

Indica se os intersticiais da lista de recursos HLS estão ativados. Quando ativada, a DAI retorna URLs de lista de recursos para cada intervalo de anúncio, que podem ser usados para intersticiais HLS.
targeting_parameters string

Parâmetros adicionais de segmentação do Ad Manager. Opcional.
content_duration_seconds number

ContentDurationSeconds é a duração do conteúdo em segundos. Obrigatório quando a resposta da tag de anúncio usa compensações de tempo em porcentagem.
decision_timing_options object(DecisionTimingOptions)

Indica quando os adpods devem ser decididos.
enable_inline_manifests boolean

Indica se os manifestos de quebra precisam ser inlinados na resposta JSON.
dai_options object(AdPodDecisionOptions)

DAIOptions para decisão de conjunto de anúncios.

AdPodDecisionResponse

AdPodDecisionResponse representa uma resposta a adpods de decisão para um stream registrado anteriormente. Ela contém uma lista dos conjuntos de anúncios decididos para esse stream.
Representação JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Campos
valid_for string

"ValidFor" é a duração em que este fluxo é válido, no formato "00h00m00s".
valid_until string

ValidUntil é a data e a hora até quando esta transmissão é válida.
ad_pods [object(AdPod)]

Uma lista de conjuntos de anúncios ordenada por pedido de inserção.

CreateStreamResponse

CreateStreamResponse representa a resposta JSON enviada de volta ao cliente em resposta a um CreateStreamRequest.
Representação JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Campos
valid_for string

"ValidFor" é a duração em que este fluxo é válido, no formato "00h00m00s".
valid_until string

ValidUntil é a data e a hora até quando esta transmissão é válida.
ad_pods [object(AdPod)]

Uma lista de conjuntos de anúncios ordenada por pedido de inserção.
stream_id string

O StreamID é o identificador exclusivo da transmissão atual do espectador.
media_verification_url string

MediaVerificationURL é o prefixo de URL a ser usado nas solicitações de verificação de mídia de anúncios descritas abaixo. Ausente para streams de beacon do lado do cliente.
pod_metadata object(PodMetadata)

PodMetadata contém as informações extras necessárias para renderizar o pod no dispositivo e acionar a verificação. Conforme descrito na documentação da API Linear de Inserção de anúncios dinâmicos. Incluído apenas para streams de beacon do lado do cliente.
metadata_url string

MetadataURL é o URL de metadados a ser usado para solicitar metadados de adpod.

AdPod

O AdPod representa um intervalo de anúncio decidido pronto para reprodução.
Representação JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Campos
manifest_uris string

ManifestURIs é um mapa do nome do perfil de codificação para manifest_uris variantes do HLS para conteúdo HLS.
multivariant_uri string

MultivariantURI é o URI do manifesto multivariante para conteúdo HLS.
mpd_uri string

MPDURI é o URI do MPD para conteúdo DASH.
manifests string

Manifests é um mapa do nome do perfil de codificação para o manifesto de variante HLS. Preenchido apenas se o fluxo tiver enable_inline_manifests definido como "true".
multivariant_manifest string

MultivariantManifest é o manifesto multivariante para conteúdo HLS. Preenchido apenas se o fluxo tiver enable_inline_manifests definido como "true".
mpd_manifest string

MPDManifest é o manifesto MPD para conteúdo DASH. Preenchido apenas se o fluxo tiver enable_inline_manifests definido como "true".
asset_list_uri string

AssetListURI é o URI da lista de recursos intersticiais HLS para conteúdo HLS. Preenchido apenas se a transmissão tiver intersticiais de lista de recursos HLS ativados.
start number

Horário de início do conjunto de anúncios na linha do tempo do recurso (sem incluir os conjuntos de anúncios anteriores) em segundos de ponto flutuante.
duration number

Duração do conjunto de anúncios em segundos de ponto flutuante.
type string

Tipo de intervalo de anúncio.
midroll_index number

Índice de base 1 dos anúncios intermediários em uma transmissão, com base no ID do intervalo do VMAP. Omitido para anúncios precedentes e finais.

AdPodDecisionOptions

"AdPodDecisionOptions" representa outras opções para o stream.
Representação JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Campos
dash_profile string

Perfil MPEG-DASH a ser usado: "live" ou "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Permite que os editores substituam a política padrão de compartilhamento de dados da rede.
sam_id string

sam_id é a chave de depuração do SAM para a sessão, opcional.
session_title string

session_title é o título da sessão do SAM para o stream, opcional.
dash_inband_event_stream boolean

dash_inband_event_stream indica que a DAI insere mensagens ID3 como eventos em banda (na mídia) usando o elemento InbandEventStream, em vez de elementos EventStream (no manifesto).
distinct_ad_profiles boolean

Se definido como "true", indica que o servidor usará qualquer perfil de anúncio disponível no máximo uma vez ao corresponder aos perfis de codificação solicitados.

Stream

O stream é usado para renderizar uma lista de todos os recursos de um stream recém-criado no formato JSON .
Representação JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Campos
stream_id string

Identificador de stream.
valid_for string

Período de validade da stream de duração, no formato "00h00m00s".
valid_until string

Data até quando o stream é válido, no formato RFC 3339.
media_verification_url string

URL de verificação de mídia.

Í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 click-through 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 criativo do anúncio usado para o anúncio wrapper.
deal_id string

ID opcional da transação para o anúncio 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

A estrutura de API para este complemento.
tracking_events [object(TrackingEvent)]

Lista de eventos de rastreamento para esse 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.