DocumentaçãoAnalyticsGuia do Media Analytics

Parâmetros de anúncio ad-parameters

Last update: Fri Mar 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • User
  • Admin
  • Developer

Este tópico apresenta uma lista de dados de anúncios de vídeo, incluindo valores de dados de contexto, que a Adobe coleta por meio das variáveis da solução.

Descrição dos dados da tabela:

  • Implementação: informações sobre valores e requisitos de implementação.

    • Chave - Variável, definida manualmente no aplicativo ou automaticamente pelo SDK do Adobe Media.
    • Obrigatório  - Indica se o parâmetro é necessário para o rastreamento básico de vídeo.
    • Tipo - Especifica o tipo da variável a ser definida, a string ou o número.
    • Enviado com - Indica quando os dados são enviados: Início da mídia é a chamada do Analytics enviada no início da mídia, Início do anúncio é a chamada do Analytics enviada no início do anúncio, e assim por diante; as chamadas de Fechamento são as chamadas compiladas do Analytics enviadas diretamente do servidor do heartbeat para o servidor da Analytics no final da sessão de mídia, ou no final do anúncio, do capítulo, etc. As chamadas de fechamento não estão disponíveis nas chamadas do pacote de rede.
    • Versão mín. do SDK - Indica qual versão do SDK você precisaria para acessar o parâmetro.
    • Valor de exemplo  - Fornece exemplo de uso comum de variável.

  • Parâmetros de rede: exibe os valores passados para os servidores do Adobe Analytics ou Heartbeat. Esta coluna mostra os nomes dos parâmetros que são vistos nas chamadas de rede geradas pelos SDKs do Adobe Media.

  • Relatórios: informações sobre como visualizar e analisar os dados do vídeo.

    • Disponível - Indica se os dados estão disponíveis no relatórios por padrão (Sim) ou se exigem configuração personalizada (Personalizado)
    • Variável reservada  - Indica se os dados são capturados como um evento, eVar, prop ou classificação em uma variável reservada.
    • Nome do relatório  - Nome do relatório do Adobe Analytics para a variável
    • Dados de contexto  - Nome dos dados de contexto do Adobe Analytics passados para o servidor de relatórios e usados nas regras de processamento.
    • Feed de dados  - Nome da coluna para variável encontrada nos feeds de dados da sequência de cliques ou transmissão ao vivo.
    • Audience Manager - Nome da característica encontrada no Adobe Audience Manager
IMPORTANT
Não altere os nomes de classificação de nenhuma variável listada abaixo que esteja
descrita em Relatório/variável reservada como “classificação”.
As classificações de mídia são definidas quando um conjunto de relatórios é ativado para rastreamento
de mídia. De tempos em tempos, a Adobe adiciona novas propriedades e, quando isso ocorre,
os clientes devem reativar seus conjuntos de relatórios para obter acesso a novas propriedades
de mídia. Durante o processo de atualização, a Adobe determina se as
classificações são ativadas verificando os nomes das variáveis. Se alguma delas
estiver ausente, a Adobe adicionará novamente as que estiverem faltando.

Dados de vídeo do anúncio ad-video-data

ID do anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    adId
  • Chave da API:
    media.ad.id
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Valor de exemplo:
     “2125”
  • Descrição:
    ID do anúncio. (Qualquer combinação de número inteiro e/ou letra)
  • Adobe Analytics:
    (a.media.ad.
    name)
  • Heartbeat:
    (s:asset:ad_id)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    On VISIT
  • Nome do relatório:
    Ad
  • Dados de contexto:
    (a.media.ad.
    name)
  • Feed de dados:
    videoad
  • Audience Manager:
    (c_contextdata.
    a.media.ad.name)
  • Caminho do campo XDM:
    advertising.adAssetReference.@id
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.name
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.name

Anúncio na posição do pod

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    position
  • Chave da API:
    media.ad.podPosition
  • Obrigatório:
    Sim
  • Tipo:
    número
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Valor de exemplo:
     1
  • Descrição:
    A posição (índice) do anúncio dentro do ad break principal. O primeiro anúncio tem índice 0, o segundo anúncio tem índice 1, etc.
  • Adobe Analytics:
    (a.media.ad.
    podPosition)
  • Heartbeat:
    (s:asset:pod_position)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Ad In Pod Position
  • Dados de contexto:
    (a.media.ad.
    podPosition)
  • Feed de dados:
    videoadinpod
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podPosition)
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.index
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.index
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.index

Duração do anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    length
  • Chave da API:
    media.ad.length
  • Obrigatório:
    Sim
  • Tipo:
    número
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.1
  • Valor de exemplo:
     “15”
  • Descrição:
    Comprimento do anúncio de vídeo em segundos.
  • Adobe Analytics:
    (a.media.ad.
    length)
  • Heartbeat:
    (l:asset:ad_length)
  • Disponível:
    Sim
  • Variável reservada:
    eVar e classification
  • Expiração:
    No HIT
  • Nome do relatório:
    Ad Length e Ad Length (variável)
  • Dados de contexto:
    (a.media.ad.
    length)
  • Feed de dados:
    videoadlength
  • Audience Manager:
    (c_contextdata.
    a.media.ad.length)
  • Caminho do campo XDM:
    advertising.adAssetReference.
    xmpDM:duration
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.length
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.length

Nome do reprodutor do anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    playerName
  • Chave da API:
    media.ad.playerName
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Exemplo de valor:
     “Freewheel”
  • Descrição:
    O nome do reprodutor responsável pela renderização do anúncio.
  • Adobe Analytics:
    (a.media.ad.
    playerName)
  • Heartbeat:
    (s:sp:player_name)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Ad Player Name
  • Dados de contexto:
    (a.media.ad.
    playerName)
  • Feed de dados:
    videoadplayername
  • Audience Manager:
    (c_contextdata.
    a.media.ad.playerName)
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.playerName
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.
    playerName
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    playerName

Nome do ad break

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    name
  • Chave da API:
    media.ad.podFriendlyName
  • Obrigatório:
    SDK: Sim; API: Não.
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Exemplo de valor:
     “antes da exibição”
  • Descrição:
    O nome amigável do Ad Break.
  • Adobe Analytics:
    (a.media.ad.
    podFriendlyName)
  • Heartbeat:
    (s:asset:pod_name)
  • Disponível:
    Sim
  • Variável reservada:
    Classification
  • Nome do relatório:
    Pod Name
  • Dados de contexto:
    (a.media.ad.
    podFriendlyName)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podFriendlyName)
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.
    adBreak.dc:title
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingPodDetails.
    friendlyName
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingPodDetails.
    friendlyName

Índice de ad break

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    position
  • Chave da API:
    media.ad.podPosition
  • Obrigatório:
    Sim
  • Tipo:
    número
  • Enviado com:
  • Versão mín. do SDK: Any
  • Valor de exemplo:
     1
  • Descrição:
    O índice do ad break dentro do conteúdo que começa em 1. Essa propriedade é usada  somente  pelo SDK do Media para gerar a ID do pod.
  • Adobe Analytics:
  • Heartbeat:
  • Disponível:
    Não
  • Variável reservada:
    N/D
  • Nome do relatório:
    N/D
  • Dados de contexto:
  • Feed de dados:
    N/D
  • Audience Manager:
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.index
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingPodDetails.index

Posição do ad break

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    startTime
  • Chave da API:
    media.ad.podSecond
  • Obrigatório:
    Sim
  • Tipo:
    número
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Valor de exemplo:
     90
  • Descrição:
    O deslocamento do ad break no conteúdo, em segundos.
  • Adobe Analytics:
    (a.media.ad.
    podSecond)
  • Heartbeat:
    (l:asset:pod_offset)
  • Disponível:
    Sim
  • Variável reservada:
    Classification
  • Nome do relatório:
    Pod Position
  • Dados de contexto:
    (a.media.ad.
    podSecond)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podSecond)
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.adBreak.
    offset
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingPodDetails.
    offset
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingPodDetails.
    offset

ID do ad break

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    Definida automaticamente
  • Chave da API:
    N/D
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: Any
  • Exemplo de valor:
     c4a577424c84067899b807c76722d495_1
  • Adobe Analytics:
    (a.media.ad.
    pod)
  • Heartbeat:
    (s:asset:pod_id)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Pod de anúncios
  • Dados de contexto:
    (a.media.ad.
    pod)
  • Feed de dados:
    videoadpod
  • Audience Manager:
  • Caminho do campo XDM:
    advertising.adAssetViewDetails.adBreak.@id
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingPodDetails.
    ID

Nome do anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    name
  • Chave da API:
    media.ad.name
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.1
  • Exemplo de valor:
     “Ford F-150”
  • Descrição:
    Nome amigável do anúncio. Nos relatórios, o “Ad Name” é a classificação e o “Ad Name (variable)” é a eVar.
  • Adobe Analytics:
    (a.media.ad.
    friendlyName)
  • Heartbeat:
    (s:asset:ad_name)
  • Disponível:
    Sim
  • Variável reservada:
    eVar e classification
  • Expiração:
    No HIT
  • Nome do relatório:
    Ad Name e Ad Name (variable)
  • Dados de contexto:
    (a.media.ad.
    friendlyName)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.friendlyName)
  • Caminho do campo XDM:
    advertising.adAssetReference.dc:title
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.friendlyName
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.friendlyName

Metadados de publicidade padrão standard-ad-metadata

Anunciante

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    ADVERTISER
  • Chave da API:
    media.ad.advertiser
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Valor de exemplo:
  • Descrição:
    Empresa/marca cujo produto está em destaque no anúncio.
  • Adobe Analytics:
    (a.media.ad.
    advertiser)
  • Heartbeat:
    (s:meta:
    a.media.ad.advertiser)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Anunciante
  • Dados de contexto:
    (a.media.ad.
    advertiser)
  • Feed de dados:
    videoadvertiser
  • Audience Manager:
    (c_contextdata.
    a.media.ad.advertiser)
  • Caminho do campo XDM:
    advertising.adAssetReference.advertiser
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.advertiser
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.advertiser

ID da campanha

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    CAMPAIGN_ID
  • Chave da API:
    media.ad.campaignId
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Exemplo de valor:
     Número inteiro ou nome (sequência de caracteres).
  • Descrição:
    A ID da campanha publicitária.
  • Adobe Analytics:
    (a.media.ad.
    campaign)
  • Heartbeat:
    (s:meta:
    a.media.ad.campaign)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    ID da campanha
  • Dados de contexto:
    (a.media.ad.
    campaign)
  • Feed de dados:
    videocampaign
  • Audience Manager:
    (c_contextdata.
    a.media.ad.campaign)
  • Caminho do campo XDM:
    advertising.adAssetReference.campaign
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.
    campaignID
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    campaignID

ID de criação

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    CREATIVE_ID
  • Chave da API:
    media.ad.creativeId
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Exemplo de valor:
     Número inteiro ou nome (sequência de caracteres).
  • Descrição:
    A ID da campanha criativa.
  • Adobe Analytics:
    (a.media.ad.
    creative)
  • Heartbeat:
    (s:meta:
    a.media.ad.creative)
  • Disponível:
    Sim
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    ID de criação
  • Dados de contexto:
    (a.media.ad.
    creative)
  • Feed de dados:
    adclassificationcreative
  • Audience Manager:
    (c_contextdata.
    a.media.ad.creative)
  • Caminho do campo XDM:
    advertising.adAssetReference.creativeID
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.creativeID
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.creativeID

ID do site

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    SITE_ID
  • Chave da API:
    media.ad.siteId
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Valor de exemplo:
  • Descrição:
    A ID do site do anúncio.
  • Adobe Analytics:
    (a.media.ad.
    site)
  • Heartbeat:
    (s:meta:
    a.media.ad.site)
  • Disponível:
    Usar regra de processamento personalizada
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Personalizado
  • Dados de contexto:
    (a.media.ad.
    site)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.site)
  • Caminho do campo XDM:
    advertising.adAssetReference.siteID
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.siteID
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.siteID

URL da arte

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    CREATIVE_URL
  • Chave da API:
    media.ad.creativeURL
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Valor de exemplo:
  • Descrição:
    URL da campanha criativa.
  • Adobe Analytics:
    (a.media.ad.
    creativeURL)
  • Heartbeat:
    (s:meta:<c ode=""> a.media.ad.creativeURL) ``
  • Disponível:
    Usar regra de processamento personalizada
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Personalizado
  • Dados de contexto:
    (a.media.ad.
    creativeURL)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.creativeURL)
  • Caminho do campo XDM:
    advertising.adAssetReference.creativeURL
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.
    creativeURL
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    creativeURL

ID de posicionamento

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    PLACEMENT_ID
  • Chave da API:
    media.ad.placementId
  • Obrigatório:
    Não
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Start, Ad Close
  • Versão mín. do SDK: 1.5.7
  • Valor de exemplo:
  • Descrição:
    A ID de posicionamento do anúncio.
  • Adobe Analytics:
    (a.media.ad.
    placement)
  • Heartbeat:
    (s:meta:
    a.media.ad.placement)
  • Disponível:
    Usar regra de processamento personalizada
  • Variável reservada:
    eVar
  • Expiração:
    No HIT
  • Nome do relatório:
    Personalizado
  • Dados de contexto:
    (a.media.ad.
    placement)
  • Feed de dados:
    N/D
  • Audience Manager:
    (c_contextdata.
    a.media.ad.placement)
  • Caminho do campo XDM:
    advertising.adAssetReference.placementID
  • Caminho do campo XDM da coleção:
    mediaCollection.advertisingDetails.
    placementID
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    placementID

Métricas de publicidade ad-metrics

Início do anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    Definida automaticamente
  • Chave da API:
    N/D
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Início do anúncio
  • Versão mín. do SDK: Any
  • Exemplo de valor:
     TRUE
  • Descrição:
    Número de anúncios de vídeo iniciados.
  • Adobe Analytics:
    (a.media.ad.
    view)
  • Heartbeat:
    (s:event:type=start)
    (s:asset:type=ad) ``
  • Disponível:
    Sim
  • Variável reservada:
    event
  • Nome do relatório:
    Ad Starts
  • Feed de dados:
    N/D
  • Dados de contexto:
    (a.media.ad.
    view)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.view)
  • Caminho do campo XDM:
    advertising.starts.value > 0 => “TRUE”
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.isStarted

Anúncio concluído

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    Definida automaticamente
  • Chave da API:
    N/D
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Close
  • Versão mín. do SDK: Any
  • Exemplo de valor:
     TRUE
  • Descrição:
    Número de conclusões de anúncios de vídeo.
  • Adobe Analytics:
    (a.media.ad.
    complete)
  • Heartbeat:
    (s:event:type=complete)
    (s:asset:type=ad)
  • Disponível:
    Sim
  • Variável reservada:
    event
  • Nome do relatório:
    Ad Completes
  • Feed de dados:
    N/D
  • Dados de contexto:
    (a.media.ad.
    complete)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.complete)
  • Caminho do campo XDM:
    advertising.completes.value > 0 => “TRUE”
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    isCompleted

Tempo gasto com anúncio

Implementação
Parâmetros de rede
Relatórios
  • Chave de SDK:
    Definida automaticamente
  • Chave da API:
    N/D
  • Obrigatório:
    Sim
  • Tipo:
    sequência de caracteres
  • Enviado com:
    Ad Close
  • Versão mín. do SDK: Any
  • Valor de exemplo:
     15
  • Descrição:
    A quantidade total de tempo, em segundos, gasta assistindo ao anúncio (ou seja, o número de segundos reproduzidos). O valor será exibido no formato de hora (HH:MM:SS) no Analysis Workspace e no Reports & Analytics. Nos Feeds de dados, Data Warehouse e APIs de relatórios, os valores serão exibidos em segundos.
    Data de lançamento: 13/09/18
  • Adobe Analytics:
    (a.media.ad.
    timePlayed)
  • Heartbeat:
  • Disponível:
    Sim
  • Variável reservada:
    event
  • Nome do relatório:
    Tempo gasto com anuncio
  • Feed de dados:
    N/D
  • Dados de contexto:
    (a.media.ad.
    timePlayed)
  • Audience Manager:
    (c_contextdata.
    a.media.ad.timePlayed)
  • Caminho do campo XDM:
    advertising.timePlayed.value
  • Caminho do campo XDM do relatório:
    mediaReporting.advertisingDetails.
    timePlayed

createAdObject APIs:

createAdBreakObject APIs:

MediaHeartbeatConfig APIs:

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb