adobe.target.sendNotifications(options)

Cette fonction envoie une notification à Target Edge lorsqu’une expérience est générée sans utiliser adobe.target.applyOffer() ou adobe.target.applyOffers().

REMARQUE

Cette fonction a été introduite dans at.js 2.1.0 et sera disponible pour toutes les versions ultérieures à 2.1.0.

Clé Type Obligatoire ? Description
consumerId Chaîne Non La valeur par défaut est la mbox globale du client si elle n’est pas fournie. Cette clé sert à générer l’identifiant de données supplémentaire utilisé pour l’intégration A4T.
Demande Objet Oui Consultez les requêtes ci-dessous.
timeout Nombre Non Délai d’attente de requête. Si cette valeur n’est pas spécifiée, c’est le délai d’attente par défaut d’at.js qui sera utilisé.

Demande

Nom du champ Type Obligatoire ? Limite Description
Request > notifications Tableau d’objets Oui Notifications pour le contenu affiché, les sélecteurs cliqués et/ou les affichages ou mbox consultés.
Request > notifications > address Objet Non
Request > notifications > address > url Chaîne Non URL à partir de laquelle la notification a été déclenchée.
Request > notifications > address > referringUrl Chaîne Non URL de référence à partir de laquelle la notification a été déclenchée.
Request > notifications > parameters Chaîne Non Les noms suivants ne sont pas autorisés pour les paramètres :
  • orderId
  • orderTotal
  • productPurchasedIds
Tenez compte des points suivants :
  • Limite de 50 paramètres max.
  • Le nom du paramètre ne doit pas être vide.
  • Longueur de paramètre 128 max.
  • Le nom du paramètre ne doit pas commencer par « profile ».
  • Longueur de la valeur du paramètre 5 000 max.
Request > notifications > profileParameters Chaîne Non Les noms suivants ne sont pas autorisés pour les paramètres :
  • orderId
  • orderTotal
  • productPurchasedIds
Tenez compte des points suivants :
  • Limite de 50 paramètres max.
  • Le nom du paramètre ne doit pas être vide.
  • Longueur de paramètre 128 max.
  • Le nom du paramètre ne doit pas commencer par « profile ».
  • Longueur de la valeur du paramètre 5 000 max.
Request > notifications > order Objet Non Objet décrivant les détails de la commande.
Request > notifications > order > id Chaîne Non <= 250 caractères. ID de commande.
Request > notifications > order > total Chaîne Non >= 0 Total de la commande.
Request > notifications > order > purchasedProductIds Tableau de chaîne Non
  • Aucune valeur vide n’est autorisée.
  • Longueur de chaque id de produit 50 max.
  • Les ID de produit, séparés par des virgules et concaténées, ne doivent pas dépasser 250.
ID des produits commandés.
Request > notifications > product Objet Non
Request > notifications > product > id Chaîne Non <= 128 caractères ; ne peut pas être vide. ID de produit.
Request > notifications > product > categoryId Chaîne Non <= 128 caractères ; ne peut pas être vide. ID de catégorie
Request > notifications > id Chaîne Oui <= 200 caractères. L’ID de notification est renvoyé en réponse et indique que la notification a bien été traitée.
Request > notifications > impressionId Chaîne Non <= 128 caractères. L’ID d’impression est utilisé pour associer (lier) la notification actuelle à une notification précédente ou à une demande d’exécution. Au cas où ces deux requêtes correspondent, la deuxième requête et les requêtes suivantes ne généreront pas de nouvelle impression pour l’activité ou l’expérience.
Request > notifications > type Chaîne Oui « click » ou « display » est pris en charge. Type de notification.
Request > notifications > timestamp Nombre<int64> Oui Horodatage de la notification en millisecondes écoulées depuis l’époque UNIX considérée.
Request > notifications > tokens Tableau de chaîne Oui Liste des jetons pour le contenu affiché ou les sélecteurs cliqués, en fonction du type de notification.
Request > notifications > mbox Objet Non Notifications pour la mbox.
Request > notifications > mbox > name Chaîne Non Aucune valeur vide n’est autorisée.
Caractères autorisés : Voir la remarque ci-dessous.
nom de mbox.
Request > notifications > mbox > state Chaîne Non jeton d’état de mbox.
Request > notifications > view Objet Non
Request > notifications > view > id Entier <int64> Non Id de la vue. ID affecté à la vue lorsque la vue a été créée via l’API d’affichage.
Request > notifications > view > name Chaîne Non <= 128 caractères. Nom de la vue.
Request > notifications > view > key Chaîne Non <= 512 caractères. Clé de la vue. Clé qui a été définie avec la vue via l’API.
Request > notifications > view > state Chaîne Non jeton d’état de la vue.

Remarque : Les caractères suivants ** ne sont pas autorisés pour Request > notifications > mbox > name:

- '-, ./=`:;&!@#$%^&*()+|?~[]{}'

Appel sendNotifications() après le rendu des mbox prérécupérées

function createTokens(options) {
  return options.map(e => e.eventToken);
}

function createNotification(mbox, type, tokens) {
  const id = 11111; // here we should use a random ID like UUID
  const timestamp = Date.now();
  const { name, state, parameters, profileParameters, order, product } = mbox;
  const result = {
    id,
    type,
    timestamp,
    parameters,
    profileParameters,
    order,
    product
  };

  result.mbox = { name, state };
  result.tokens = tokens;

  return result;
}

adobe.target.getOffers({
  request: {
    prefetch: {
      mboxes: [
        {
          index: 0,
          name: "a1-serverside-ab"
        }
      ]
    }
  }
})
.then(response => {
  const mboxes = response.prefetch.mboxes;
  const notifications = mboxes.map(mbox => {
    const type = "display";
    const tokens = createTokens(mbox.options);

    return createNotification(mbox, type, tokens);
  });
  
  adobe.target.sendNotifications({
    request: { notifications }
  });
})
REMARQUE

Si vous utilisez Adobe Analytics, getOffers() avec prérécupération uniquement et sendNotifications(), la requête Analytics doit être déclenchée après l’exécution de sendNotifications(). Cela permet de garantir que le SDID généré par sendNotifications() correspondra au SDID envoyé à Analytics et Target.

Sur cette page