événements personnalisés at.js

Informations sur at.js custom events, qui permet de savoir quand une requête ou une offre mbox échoue ou réussit.

Dans le passé, mbox.js ne laissait aucun autre code JavaScript s’exécutant sur la page savoir ce qui se passait en coulisses. Avec l’évolution d’at.js, nous avions une opportunité unique de résoudre ce problème.

Nos clients nous ont ainsi indiqué qu’ils souhaiteraient être informés dans différentes situations, notamment lorsque :

  • Une requête mbox a échoué en raison du délai d’attente, d’un code d’état erroné, d’une erreur d’analyse JSON, etc.
  • Une requête mbox a réussi.
  • Le rendu d’une offre a échoué en raison d’un élément mbox d’encapsulage manquant, d’un sélecteur introuvable, etc.
  • Le rendu d’une offre a réussi. Des modifications ont été appliquées au modèle DOM.

Les événements prédéfinis ont une structure qui vous permet d’extraire les données requises en fonction du type d’événement.

Pour s’assurer que des événements peuvent être utilisés dans différents scénarios, les événements personnalisés ont un objet de charge utile affecté à la propriété Détail de l’objet d’événement (transféré au gestionnaire). De plus, pour éviter de transférer des chaînes comme noms d’événements, les événements sont exposés sous la forme de constantes par le biais de l’espace de noms adobe.target.event.

Structure

Clé Type Description
type Chaîne Il existe plusieurs scénarios dans lesquels vous pouvez souhaiter être notifié afin de faciliter les activités de traçage, de débogage et de personnalisation de l’interaction avec at.js.
Chacun des événements personnalisés ci-dessous comporte deux formats : une « constante » et une « valeur de chaîne ».
  • Constantes : précédées de adobe.target.event., présentées en majuscules et contenant des traits de soulignement. Pour vous abonner à des événements personnalisés après le chargement d’at.js, mais avant que la réponse mbox n’ait été reçue, utilisez le format de la constante.
  • Valeurs de chaîne : en minuscules avec des tirets. Pour vous abonner à des événements personnalisés avant le chargement d’at.js, utilisez la valeur de chaîne.
Échec de la demande
Constante : adobe.target.event.REQUEST_FAILED
Valeur de chaîne : at-request-failed
Description : Une requête de mbox a échoué en raison d’un dépassement de délai, d’un code d’état incorrect, d’une erreur d’analyse JSON, etc.
Requête Réussie
Constante : adobe.target.event.REQUEST_SUCCEEDED
Valeur de chaîne : at-request-succeeded
Description : Une requête mbox a abouti.
La restitution de contenu a échoué
Constante : adobe.target.event.CONTENT_RENDERING_FAILED
Valeur de chaîne : at-content-rendering-failed
Description : La restitution de l’offre a échoué en raison d’un élément mbox d’encadrement manquant, d’un sélecteur introuvable, etc.
La restitution de contenu a réussi
Constante : adobe.target.event.CONTENT_RENDERING_SUCCEEDED
Valeur de chaîne : at-content-rendering-succeeded
Description : La restitution des offres a réussi. Des modifications ont été appliquées au modèle DOM.
Bibliothèque chargée
 : Constante : adobe.target.event.LIBRARY_LOADED
Valeur de chaîne : at-library-loaded
Description : Cet événement est idéal pour effectuer le suivi lorsque at.js a été entièrement chargé. Vous pouvez utiliser cet événement pour personnaliser l’exécution globale de mbox. Vous pouvez également l’utiliser pour désactiver la mbox globale, puis écouter cet événement de manière à en différer le déclenchement.
Lancement de requête
Constante : adobe.target.event.REQUEST_START
Valeur de chaîne : at-request-start
Description : Cet événement est déclenché avant l’exécution d’une requête HTTP. Vous pouvez utiliser cet événement pour effectuer des mesures de performances à l’aide de l’API de temporisation de ressources.
Lancement de restitution de contenu
Constante : adobe.target.event.CONTENT_RENDERING_START
Valeur de chaîne : at-content-rendering-start
Description : Cet événement est déclenché avant le déclenchement du sondage du sélecteur et la restitution du contenu sur la page. Vous pouvez utiliser cet événement pour effectuer le suivi de la progression du rendu du contenu.
Restitution de contenu sans offre
Constante : adobe.target.event.CONTENT_RENDERING_NO_OFFERS
Valeur de chaîne : at-content-rendering-no-offers
Description : Cet événement est déclenché lorsqu’aucune offre n’est renvoyée.
Redirection de restitution de contenu
Constante : adobe.target.event.CONTENT_RENDERING_REDIRECT
Valeur de chaîne : at-content-rendering-redirect
Description : Cet événement est déclenché lorsqu’une offre est une redirection et que Target redirige vers une autre URL.
mbox Chaîne nom de mbox
message Chaîne Contient une description explicite indiquant ce qui s’est passé, le message d’erreur, etc.
Suivi Objet Contient sessionId et deviceId. Dans certains cas, deviceId peut être absent si Target n’est pas parvenu à le récupérer dans le serveur Edge.
type Chaîne Artefact de décision sur périphérique
successConstant:
adobe.target.event.ARTIFACT_DOWNLOAD_SUCCEEDED
Valeur de chaîne : artifactDownloadSucceeded
Description : Appelé lorsque l’artefact de prise de décision sur le périphérique est correctement téléchargé.
Artefact de décision sur périphérique
failedConstant : adobe.target.event.ARTIFACT_DOWNLOAD_FAILED
Valeur de chaîne : artifactDownloadFailed
Description : Appelé lorsque le téléchargement de l’artefact de prise de décision sur le périphérique a échoué.

Utilisation

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

Vidéo de formation : Jetons de réponse et événements personnalisés at.js Badge didactique

Regardez la vidéo suivante pour savoir comment utiliser les jetons de réponse et les événements personnalisés at.js pour partager des informations de profil de Target avec des systèmes tiers.

Sur cette page