Rede de Display e A API Video 360 v2 foi descontinuada. Use o Display & Video 360 API v3. Para ver as instruções de migração da v2 para a v3, consulte nosso guia de migração.
Anexo: mapeamento de campos de IU para campos de API por tipo de criativo
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A tabela abaixo mapeia os campos da IU para os campos da API correspondentes, separados por tipo de criativo. Alguns campos da API exigem especificações adicionais por meio de um papel ou tipo atribuído para o recurso fornecido.
Criativo de imagem padrão
Tipo de criativo: CREATIVE_TYPE_STANDARD
Origem da hospedagem: HOSTING_SOURCE_HOSTED
Nome
Obrigatório
Nome do campo da API: displayName
Recurso do criativo
Obrigatório
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_MAIN
URL da página de destino
Obrigatório
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Status
Obrigatório
Nome do campo da API:entityStatus
Tag de rastreamento HTML anexada
Opcional
Nome do campo da API:attachingTag
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo HTML5
Tipo de criativo: CREATIVE_TYPE_STANDARD
Origem da hospedagem: HOSTING_SOURCE_HOSTED
Nome
Obrigatório
Nome do campo da API: displayName
Recurso do criativo
Obrigatório
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_MAIN
Status
Obrigatório
Nome do campo da API:entityStatus
Imagens de backup
Opcional
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_BACKUP
URL da página de destino de backup
Opcional
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_BACKUP
Rótulo de relatório de saída de backup
Opcional
Nome do campo da API: exitEvents[].reportingName
Tipo de evento de saída: exit_EVENT_TYPE_BACKUP
Imagens de carregamento discreto
Opcional
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_POLITE_LOAD
Saídas
Obrigatório
Nome do campo da API: exitEvents[]
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Contadores
Opcional
Nome do campo da API:counterEvents[]
Temporizadores
Opcional
Nome do campo da API: timerEvents[]
Tag de rastreamento HTML anexada
Opcional
Nome do campo da API:attachingTag
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Opcional
Nome do campo da API:reviewStatus
Criativo de display de terceiros
Tipo de criativo: CREATIVE_TYPE_STANDARD
Origem da hospedagem: HOSTING_SOURCE_THIRD_PARTY
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
Dimensões
Obrigatório
Nome do campo da API:dimensões
URL da página de destino
Obrigatório
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Requer MRAID
Opcional
Nome do campo da API:requiredMraid
Requer HTML5
Opcional
Nome do campo da API:requiredHTML5
Tag de terceiros
Obrigatório
Nome do campo da API:thirdPartyTag
Requer um ping para atribuição
Opcional
Nome do campo da API:requiredPingForAttribution
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo expansível de terceiros
Tipo de criativo: CREATIVE_TYPE_EXPANDABLE
Origem da hospedagem: HOSTING_SOURCE_THIRD_PARTY
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
Dimensões
Obrigatório
Nome do campo da API:dimensões
URL da página de destino
Obrigatório
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Requer MRAID
Opcional
Nome do campo da API:requiredMraid
Requer HTML5
Opcional
Nome do campo da API:requiredHTML5
Direção da expansão
Obrigatório
Nome do campo da API:expansívelDirection
Abrir ao passar o cursor
Opcional
Nome do campo da API:expandOnHover
Terceiros
Obrigatório
Nome do campo da API:thirdPartyTag
Requer um ping para atribuição
Opcional
Nome do campo da API:requiredPingForAttribution
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo de vídeo de terceiros
Tipo de criativo: CREATIVE_TYPE_VIDEO
Origem da hospedagem: HOSTING_SOURCE_THIRD_PARTY
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
URL da tag VAST
Obrigatório
Nome do campo da API:vastTagUrl
VPAID
Somente leitura
Nome do campo da API:vpaid
Vídeo HTML5
Somente leitura
Nome do campo da API:html5Video
Requer um ping para atribuição
Opcional
Nome do campo da API:requiredPingForAttribution
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo em áudio de terceiros
Tipo de criativo: CREATIVE_TYPE_AUDIO
Origem da hospedagem: HOSTING_SOURCE_THIRD_PARTY
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
URL da tag VAST
Obrigatório
Nome do campo da API:vastTagUrl
Requer um ping para atribuição
Opcional
Nome do campo da API:requiredPingForAttribution
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo em vídeo
Tipo de criativo: CREATIVE_TYPE_VIDEO
Origem da hospedagem: HOSTING_SOURCE_HOSTED
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
Arquivo de origem
Obrigatório
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_MAIN
URL da página de destino
Obrigatório
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Incluir o botão "Pular"
Opcional
Nome do campo da API:pulável
Tempo até a opção pular
Opcional
Nome do campo da API:skipOffset
Tempo sem cobrança
Opcional
Nome do campo da API:progressOffset
ID universal do anúncio
Opcional
Nome do campo da API: universalAdId
OBA
Opcional
Nome do campo da API:obaIcon
Criativos complementares
Opcional
Nome do campo da API:companionCreativeIds
Veiculação de arquivo
Somente leitura
Nome do campo da API:transcodificações.
URLs de terceiros
Opcional
Nome do campo da API:thirdPartyUrls
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo de áudio
Tipo de criativo: CREATIVE_TYPE_AUDIO
Origem da hospedagem: HOSTING_SOURCE_HOSTED
Nome
Obrigatório
Nome do campo da API: displayName
Status
Obrigatório
Nome do campo da API:entityStatus
Arquivo de origem
Obrigatório
Nome do campo da API:recursos
Função do recurso: ASSET_ROLE_MAIN
URL da página de destino
Obrigatório
Nome do campo da API:exitEvents[].url
Tipo de evento de saída: exit_EVENT_TYPE_DEFAULT
Recurso complementar (fazer upload ou atribuir)
Obrigatório
Nome do campo da API:companionCreativeIds
Nome do arquivo de veiculação
Somente leitura
Nome do campo da API: transcodificações[].name
Veiculação de tipo de arquivo
Somente leitura
Nome do campo da API: transcodificações[].mimeType
Taxa de bits de áudio do arquivo de veiculação
Somente leitura
Nome do campo da API: transcodificações[].audioBitRateKbps
Taxa de amostragem de áudio do arquivo de veiculação
Somente leitura
Nome do campo da API: transcodificações[].audioSampleRateHz
URLs de terceiros
Opcional
Nome do campo da API:thirdPartyUrls
Código de integração
Opcional
Nome do campo da API:integrationCode
Observações
Opcional
Nome do campo da API: observações
Status da auditoria
Somente leitura
Nome do campo da API:reviewStatus
Criativo de display nativo
Tipo de criativo:CREATIVE_TYPE_NATIVE, CREATIVE_TYPE_NATIVE_SITE_square
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2023-12-01 UTC."],[[["This document provides a comprehensive mapping of UI fields to their corresponding API fields for various creative types, including Standard Image, HTML5, Third-Party Display, Third-Party Expandable, Third-Party Video, Third-Party Audio, Video, Audio, Native Display, and Native Video."],["Each creative type has a specific set of required and optional fields, along with their API field names and any further specifications for asset roles or exit event types."],["Creative asset specifications, such as required and optional assets, are outlined for Native Video creatives, including details about their roles and corresponding API field names."],["Campaign Manager 360 tracking ad can optionally be included using the `cmTrackingAd` API field."],["This mapping enables developers to understand how UI inputs translate into API data for seamless creative management and integration within the system."]]],[]]
