Suivi des événements

Pour envoyer des données de événement à Adobe Experience Cloud, utilisez la commande sendEvent. La commande sendEvent constitue le principal moyen pour envoyer des données à et pour récupérer du contenu personnalisé, des identités et des destinations d’audience.Experience Cloud

Les données envoyées à Adobe Experience Cloud entrent dans deux catégories :

• Données XDM
• Données autres que XDM (actuellement non prises en charge)

Envoi de données XDM

Les données XDM sont un objet dont le contenu et la structure correspondent à un schéma que vous avez créé dans Adobe Experience Platform. En savoir plus sur la création d’un schéma.

Toutes les données XDM que vous souhaitez intégrer à vos analyses, personnalisation, audiences ou destinations doivent être envoyées à l’aide de l’option xdm.

alloy("sendEvent", {
  "xdm": {
    "commerce": {
      "order": {
        "purchaseID": "a8g784hjq1mnp3",
        "purchaseOrderNumber": "VAU3123",
        "currencyCode": "USD",
        "priceTotal": 999.98
      }
    }
  }
});

Un certain temps peut s'écouler entre l'exécution de la commande sendEvent et l'envoi des données au serveur (par exemple, si la bibliothèque du SDK Web n'a pas été entièrement chargée ou si le consentement n'a pas encore été reçu). Si vous souhaitez modifier une partie de l'objet xdm après avoir exécuté la commande sendEvent, il est vivement recommandé de cloner l'objet xdm avant d'exécuter la commande. sendEvent Par exemple :

var clone = function(value) {
  return JSON.parse(JSON.stringify(value));
};

var dataLayer = {
  "commerce": {
    "order": {
      "purchaseID": "a8g784hjq1mnp3",
      "purchaseOrderNumber": "VAU3123",
      "currencyCode": "USD",
      "priceTotal": 999.98
    }
  }
};

alloy("sendEvent", {
  "xdm": clone(dataLayer)
});

// This change will not be reflected in the data sent to the 
// server for the prior sendEvent command.
dataLayer.commerce = null;

Dans cet exemple, la couche de données est clonée en la sérialisant sur JSON, puis en la désérialisant. Ensuite, le résultat cloné est transmis dans la commande sendEvent. Cela permet de s'assurer que la commande sendEvent contient un instantané de la couche de données telle qu'elle existait lors de l'exécution de la commande sendEvent, de sorte que les modifications ultérieures apportées à l'objet de couche de données d'origine ne soient pas répercutées dans les données envoyées au serveur. Si vous utilisez une couche de données pilotée par un événement, le clonage de vos données est probablement déjà géré automatiquement. Par exemple, si vous utilisez la couche de données client Adobe, la méthode getState() fournit un instantané calculé et cloné de toutes les modifications antérieures. Cela est également géré automatiquement si vous utilisez l’extension Adobe Experience Platform Web SDK dans Adobe Experience Platform Launch.

Envoi de données autres que XDM

Actuellement, l’envoi de données qui ne correspondent pas à un schéma XDM n’est pas pris en charge. La prise en charge est prévue pour une date ultérieure.

Définition de eventType

Dans un événement d’expérience XDM, il existe un champ eventType facultatif. Il contient le type d’événement principal pour l’enregistrement. Définir un type d'événement peut vous aider à différencier les différents événements que vous allez envoyer. XDM fournit plusieurs types d'événement prédéfinis que vous pouvez utiliser ou vous créez toujours vos propres types d'événement personnalisés pour vos cas d'utilisation. Vous trouverez ci-dessous une liste de tous les types d'événement prédéfinis fournis par XDM. Pour en savoir plus, consultez le rapport public XDM.

Ces types d'événement s'afficheront dans une liste déroulante si vous utilisez l'extension Adobe Experience Platform Launch ou si vous pouvez toujours les transmettre sans Experience Platform Launch. Ils peuvent être transmis dans le cadre de l'option xdm.

alloy("sendEvent", {
  "xdm": {
    "eventType": "commerce.purchases",
    "commerce": {
      "order": {
        "purchaseID": "a8g784hjq1mnp3",
        "purchaseOrderNumber": "VAU3123",
        "currencyCode": "USD",
        "priceTotal": 999.98
      }
    }
  }
});

Vous pouvez également transmettre eventType dans la commande d’événement à l’aide de l’option type. Cela est ajouté aux données XDM en arrière-plan. Disposer de type comme option permet de définir plus facilement eventType sans avoir à modifier la charge utile XDM.

var myXDMData = { ... };

alloy("sendEvent", {
  "xdm": myXDMData,
  "type": "commerce.purchases"
});

Remplacement de l’ID de jeu de données

Dans certains cas, vous pouvez envoyer un événement à un jeu de données autre que celui configuré dans l’interface utilisateur de configuration. Pour cela, vous devez définir l'option datasetId sur la commande sendEvent :

var myXDMData = { ... };

alloy("sendEvent", {
  "xdm": myXDMData,
  "type": "commerce.checkout",
  "datasetId": "YOUR_DATASET_ID"
});

Ajouter des informations d'identité

Des informations d'identité personnalisées peuvent également être ajoutées au événement. Voir Récupération de l’ID d’Experience Cloud.

Utilisation de l’API sendBeacon

Il peut s’avérer difficile d’envoyer des données d’événement juste avant que l’utilisateur ne quitte une page web. Si la requête prend trop de temps, le navigateur peut l’annuler. Certains navigateurs ont implémenté une API web appelée sendBeacon pour faciliter la collecte des données pendant cette période. Lors de l’utilisation de sendBeacon, le navigateur effectue la demande web dans le contexte de navigation globale. Cela signifie que le navigateur effectue la demande de balise en arrière-plan et n’interrompt pas la navigation dans la page. Pour indiquer à Adobe Experience Platform Web SDK d’utiliser sendBeacon, ajoutez l’option "documentUnloading": true à la commande événement. Voici un exemple :

alloy("sendEvent", {
  "documentUnloading": true,
  "xdm": {
    "commerce": {
      "order": {
        "purchaseID": "a8g784hjq1mnp3",
        "purchaseOrderNumber": "VAU3123",
        "currencyCode": "USD",
        "priceTotal": 999.98
      }
    }
  }
});

Les navigateurs ont imposé des limites à la quantité de données pouvant être simultanément envoyées avec sendBeacon. Dans de nombreux navigateurs, la limite est de 64 Ko. Si le navigateur rejette le événement car la charge utile est trop importante, Adobe Experience Platform Web SDK revient à utiliser sa méthode de transport normale (par exemple, récupérer).

Gestion des réponses d’événements

Si vous souhaitez gérer une réponse d’un événement, vous pouvez être averti d’un succès ou d’un échec de la manière suivante :

alloy("sendEvent", {
  "renderDecisions": true,
  "xdm": {
    "commerce": {
      "order": {
        "purchaseID": "a8g784hjq1mnp3",
        "purchaseOrderNumber": "VAU3123",
        "currencyCode": "USD",
        "priceTotal": 999.98
      }
    }
  }
}).then(function(results) {
    // Tracking the event succeeded.
  })
  .catch(function(error) {
    // Tracking the event failed.
  });

Modification globale des événements

Si vous souhaitez ajouter, supprimer ou modifier des champs d’événements globalement, vous pouvez configurer un rappel onBeforeEventSend. Ce rappel est appelé chaque fois qu’un événement est envoyé. Il est transmis dans un objet d’événement avec un champ xdm. Modifiez content.xdm pour modifier les données envoyées avec le événement.

alloy("configure", {
  "edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId": "ADB3LETTERSANDNUMBERS@AdobeOrg",
  "onBeforeEventSend": function(content) {
    // Change existing values
    content.xdm.web.webPageDetails.URL = xdm.web.webPageDetails.URL.toLowerCase();
    // Remove existing values
    delete content.xdm.web.webReferrer.URL;
    // Or add new values
    content.xdm._adb3lettersandnumbers.mycustomkey = "value";
  }
});

Les champs xdm sont définis dans l’ordre suivant :

1. Valeurs transmises sous forme d’options à la commande d’événement alloy("sendEvent", { xdm: ... });
2. Valeurs collectées automatiquement (voir Informations automatiques)
3. Modifications apportées dans le rappel onBeforeEventSend

Quelques remarques sur le rappel onBeforeEventSend :

• Le événement XDM peut être modifié lors du rappel. Une fois le rappel renvoyé, tous les champs et valeurs modifiés de
  les objets content.xdm et content.data sont envoyés avec le événement.

  onBeforeEventSend: function(content){
    //sets a query parameter in XDM
    const queryString = window.location.search;
    const urlParams = new URLSearchParams(queryString);
    content.xdm.marketing.trackingCode = urlParams.get('cid')
  }
  

• Si le rappel renvoie une exception, le traitement du événement s’arrête et le événement n’est pas envoyé.

• Si le rappel renvoie la valeur booléenne false, le traitement du événement s’interrompt,
  sans erreur et le événement n’est pas envoyé. Ce mécanisme permet à certains événements d'être facilement ignorés par
  examiner les données du événement et renvoyer false si le événement ne doit pas être envoyé.

  REMARQUE

  Veillez à ne pas renvoyer la valeur false le premier événement d’une page. Le renvoi de la valeur false au premier événement peut avoir un impact négatif sur la personnalisation.

   onBeforeEventSend: function(content) {
     // ignores events from bots
     if (MyBotDetector.isABot()) {
       return false;
     }
   }

Toute valeur de retour autre que la valeur booléenne false permet au événement de traiter et d'envoyer après le rappel.

• Les événements peuvent être filtrés en examinant le type d'événement (voir Types d'événement.) :

    onBeforeEventSend: function(content) {  
      // augments XDM if link click event is to a partner website
      if (
        content.xdm.eventType === "web.webinteraction.linkClicks" &&
        content.xdm.web.webInteraction.URL ===
          "http://example.com/partner-page.html"
      ) {
        content.xdm.partnerWebsiteClick = true;
      }
   }

Erreurs potentielles

Lors de l’envoi d’un événement, une erreur peut être générée si les données envoyées sont trop volumineuses (plus de 32 Ko pour la requête complète). Dans ce cas, vous devez réduire la quantité de données envoyées.