Eventos personalizados da at.js

Informações sobre at.js custom events, que informam quando uma solicitação ou oferta de mbox falha ou é bem-sucedida.

Historicamente, a mbox.js (agora obsoleta) não permitiu que outro código JavaScript executado na página saiba o que acontece nos bastidores. Com o avanço da at.js, tivemos uma oportunidade única de corrigir este problema.

De acordo com nossos clientes, há vários cenários dos quais eles gostariam de ser notificados, incluindo:

  • Uma falha em uma solicitação da mbox devido ao tempo limite, código do status incorreto, erro de análise do JSON, etc.
  • Uma solicitação da mbox foi bem-sucedida.
  • Falha na renderização da oferta devido à ausência do elemento da mbox de encapsulamento, não foi possível encontrar o seletor, etc.
  • Renderização de oferta bem-sucedida. As alterações de DOM foram aplicadas.

Os eventos predefinidos têm uma estrutura que permite que você extraia os dados necessários conforme o tipo de evento.

Para certificar-se de que os eventos possam ser usados em diferentes cenários, os eventos personalizados têm um objeto de carga que é atribuído à propriedade detalhada do objeto do evento (que é transmitido ao manipulador). Para evitar, também, transmitir sequências de caracteres como nomes de evento, os eventos são expostos como constantes usando o espaço de nome adobe.target.event.

Estrutura

Chave Tipo Descrição
type String Há vários cenários em que você gostaria de receber notificações para ajudar com o rastreamento, depuração e personalização da interação com a at.js.
Cada evento personalizado listado abaixo tem dois formatos: um "constante" e um "valor em sequência".
  • Constantes: Prefixado com adobe.target.event., apresentado em todas as maiúsculas e contém caracteres sublinhados. Para se inscrever em eventos personalizados após o carregamento da at.js, mas antes de receber a resposta da mbox, use o constante.
  • Valores da string: Minúsculas e contêm hifens. Para se inscrever em eventos personalizados antes do carregamento da at.js, use os valores em sequência.
Solicitação com Falha
Constante: adobe.target.event.REQUEST_FAILED
Valor da string: at-request-failed
Descrição: Falha em uma solicitação de mbox devido ao tempo limite, código de status incorreto, erro de análise JSON, etc.
Solicitação bem-sucedida
Constante: adobe.target.event.REQUEST_SUCCEEDED
Valor da string: at-request-succeeded
Descrição: Uma solicitação de mbox foi bem-sucedida.
Renderização de conteúdo com falha
Constante: adobe.target.event.CONTENT_RENDERING_FAILED
Valor da string: at-content-rendering-failed
Descrição: A renderização da oferta falhou devido ao vínculo do elemento da mbox ausente, o seletor não pode ser encontrado, etc.
Renderização de conteúdo bem-sucedida
Constante: adobe.target.event.CONTENT_RENDERING_SUCCEEDED
Valor da string: at-content-rendering-succeeded
Descrição: A renderização da oferta foi bem-sucedida. As alterações de DOM foram aplicadas.
Biblioteca carregada
Constante: adobe.target.event.LIBRARY_LOADED
Valor da string: at-library-loaded
Descrição: Esse evento é ideal para rastrear quando o at.js foi totalmente carregado. Você pode usar este evento para personalizar a execução da mbox global. Você também pode usar este evento para desativar a mbox global e depois ouvir este evento disparar a mbox global posteriormente.
Início da solicitação
Constante: adobe.target.event.REQUEST_START
Valor da string: at-request-start
Descrição: Esse evento é disparado antes da execução de uma solicitação HTTP. Você pode usar este evento para avaliações de desempenho usando a API do Resource Timing.
Início da renderização de conteúdo
Constante: adobe.target.event.CONTENT_RENDERING_START
Valor da string: at-content-rendering-start
Descrição: Esse evento é disparado antes de a pesquisa do seletor ser iniciada e o conteúdo ser renderizado na página. Você pode usar este evento para monitorar o progresso da renderização de conteúdo.
Renderização de conteúdo Não há ofertas
Constante: adobe.target.event.CONTENT_RENDERING_NO_OFFERS
Valor da string: at-content-rendering-no-offers
Descrição: Esse evento é disparado quando não há ofertas retornadas.
Renderização de conteúdo Redirecionamento
Constante: adobe.target.event.CONTENT_RENDERING_REDIRECT
Valor da string: at-content-rendering-redirect
Descrição: Esse evento é disparado quando uma oferta é redirecionada e o Target redirecionará para um URL diferente.
mbox String nome da mbox
message String Contém descrição para leitura humana, como o que aconteceu, mensagem de erro, etc.
rastreamento Objeto Contém o sessionId e deviceId. Em alguns casos, o deviceId pode estar ausente, porque o Target não foi capaz de recuperá-lo do servidor do Edge.
type String O artefato de decisão no dispositivo foi bem-sucedido
Constante:
adobe.target.event.ARTIFACT_DOWNLOAD_SUCCEEDED
Valor da string: artifactDownloadSucceeded
Descrição: Chamado quando o artefato de decisão no dispositivo é baixado com êxito.
Falha no artefato de decisão no dispositivo
Constante: adobe.target.event.ARTIFACT_DOWNLOAD_FAILED
Valor da string: artifactDownloadFailed
Descrição: Chamado quando o artefato de decisão no dispositivo não pôde ser baixado.

Uso

document.addEventListener(adobe.target.event.REQUEST_SUCCEEDED, function(event) {
  console.log('Event', event);
});

Vídeo de treinamento: Tokens de resposta e os eventos personalizados da at.js Selo do tutorial

Assista ao vídeo a seguir para saber como usar Tokens de resposta e Eventos personalizados de at.js para compartilhar informações de perfil do Target com sistemas de terceiros.

Nesta página