Rastrear anúncios usando o JavaScript 3.x

Última atualização em 2023-11-08
  • Criado para:
  • User
    Admin
    Developer

As instruções a seguir fornecem orientação para a implementação usando os SDKs 3.x.

IMPORTANTE

Se estiver implementando uma versão anterior do SDK, você pode baixar os Guias dos desenvolvedores aqui: Baixar SDKs.

Constantes de rastreamento do anúncio

Nome da constante Descrição
AdBreakStart Constante para rastrear o evento AdBreak Start
AdBreakComplete Constante para rastrear o evento AdBreak Complete
AdStart Constante para rastrear o evento Ad Start
AdComplete Constante para rastrear o evento Ad Complete
AdSkip Constante para rastrear o evento Ad Skip

Etapas da implementação

  1. Identifique o início do limite do ad break, incluindo o anúncio precedente, e crie um AdBreakObject usando as informações do ad break.

    AdBreakObject referência:

    Nome da variável Tipo Descrição
    name string String não vazia que indica o nome do ad break (precedente, intermediário e posterior).
    position number A posição do número do ad break, começando com 1.
    startTime number Valor do indicador de reprodução no início do ad break.

    Criação do objeto Ad break:

    var adBreakObject =
      ADB.Media.createAdBreakObject(<ADBREAK_NAME>,
                                       <POSITION>,
                                       <START_TIME>);
    
  2. Chame trackEvent() com AdBreakStart na instância MediaHeartbeat para começar a rastrear o ad break:

    tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakObject);
    
  3. Identifique o início do anúncio e crie uma instância AdObject usando as informações do anúncio.

    AdObject referência:

    Nome da variável Tipo Descrição
    name string String não vazia que indica o nome do anúncio.
    adId string String não vazia que indica o identificador de anúncio.
    position number O número da posição do anúncio no ad break, começando com 1.
    length number Número positivo que indica a duração do anúncio.

    Criação do objeto de anúncio:

    var adObject =
      ADB.Media.createAdObject.createAdObject(<AD_NAME>,
                                    <AD_ID>,
                                    <POSITION>,
                                    <LENGTH>);
    
  4. (Opcional) Anexe metadados padrão e/ou de anúncio à sessão de rastreamento de mídia por meio de variáveis de dados de contexto.

    • Implementar metadados de publicidade padrão no JavaScript

    • Metadados de anúncio personalizados - Para metadados personalizados, crie um objeto de variável para as variáveis de dados personalizadas e preencha com os dados do anúncio atual:

      /* Set context data */
      // Standard metadata keys provided by adobe.
      adMetadata[ADB.Media.AdMetadataKeys]  ="Sample Advertiser";
      adMetadata[ADB.Media.AdMetadataKeys] = "Sample Campaign";
      
      // Custom metadata keys
      adMetadata["affiliate"] = "Sample affiliate";
      adMetadata["campaign"] = "Sample ad campaign";
      adMetadata["creative"] = "Sample creative";
      
  5. Chame trackEvent() com o evento AdStart na instância MediaHeartbeat para começar a rastrear a reprodução de anúncio.

    Inclua uma referência na variável de metadados personalizada (ou um objeto vazio) como o terceiro parâmetro na chamada de evento:

    _onAdStart = function() {
        tracker.trackEvent(ADB.Media.Event.AdStart, adObject, adMetadata);
    };
    
  6. Quando a reprodução atingir o fim do anúncio, chame trackEvent() com o eventoAdComplete:

    _onAdComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdComplete);
    };
    
  7. Se a reprodução do anúncio não tiver sido concluída porque o usuário optou por ignorar o anúncio, rastreie o evento AdSkip

    _onAdSkip = function() {
        tracker.trackEvent(ADB.Media.Event.AdSkip);
    };
    
  8. Se houver algum anúncio adicional em um mesmo AdBreak, repita novamente as etapas 3 a 7.

  9. O ad break está concluído, use o evento AdBreakComplete para rastrear:

    _onAdBreakComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdBreakComplete);
    };
    

Consulte o cenário de rastreamento Reprodução de VOD com anúncios antes da exibição para obter mais informações.

Rastreamento de anúncios granulares

O intervalo de ping de anúncio padrão é 10 seconds.

É possível configurar o rastreamento granular de anúncios para habilitar 1 second rastreamento de anúncios.

IMPORTANTE

Essas informações devem ser fornecidas ao iniciar uma sessão de rastreamento.

Sintaxe

ADB.Media.MediaObjectKey = {
   GranularAdTracking: "media.granularadtracking"
   }

Exemplo

var mediaObject = ADB.Media.createMediaObject("media-name", "media-id", 60, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video);

// Enable granular ad tracking
mediaObject[ADB.Media.MediaObjectKey.GranularAdTracking] = true;

tracker.trackSessionStart(mediaObject);

Nesta página