[Alpha]{class="badge informative"}

Aperçu des méthodes

Le SDK du serveur fournit ses fonctionnalités en tant que méthodes sur l’objet que createInstance renvoie. Si vous avez utilisé le Web SDK, ces méthodes correspondent aux commandes du Web SDK, mais vous les appelez différemment :

Web SDK (navigateur)
SDK du serveur
alloy("sendEvent", { xdm })
alloy.sendEvent({ xdm })
alloy("getIdentity")
alloy.getIdentity()

Web SDK utilise une seule fonction qui prend le nom de la commande sous forme de chaîne, de sorte qu’une page puisse mettre les commandes en file d’attente avant que le chargement de la bibliothèque ne se termine. Un serveur charge la bibliothèque avant de traiter toute requête. Le SDK du serveur utilise donc des méthodes standard à la place, que votre éditeur peut suggérer et vérifier au fur et à mesure que vous tapez.

Méthodes disponibles methods

Méthode
Description
Instance de niveau supérieur
poignée de forRequest
configure
Définit le flux de données, l’organisation, les informations d’identification et d’autres options. Appelez-le une fois au démarrage de votre serveur.
Oui
Non
forRequest
Renvoie un objet Handle dont la portée est limitée à la demande d’un visiteur.
Oui
Non
sendEvent
Envoie un événement à Edge Network et renvoie les résultats, tels que des propositions de personnalisation.
Oui
Oui
getIdentity
Renvoie l’ECID du visiteur sans envoyer d’événement.
Oui
Oui
appendIdentityToUrl
Ajoute l’identité du visiteur à une URL afin qu’un autre domaine puisse reconnaître le visiteur.
Oui
Oui
setConsent
Enregistre les préférences de consentement du visiteur.
Oui
Oui
applyResponse
Traite une réponse Edge Network que vous avez obtenue d’une autre manière.
Oui
Oui
getLibraryInfo
Renvoie la version de la bibliothèque et sa configuration actuelle.
Oui
Oui
setDebug
Active ou désactive la journalisation du débogage.
Oui
Oui

Pour le trafic des visiteurs, appelez des méthodes sur un handle de forRequest plutôt que sur l’instance de niveau supérieur. Voir ​ Instances et requêtes ​.

Gérer les résultats results

Chaque méthode, sauf forRequest, renvoie une promesse. La promesse est résolue avec un objet de résultat lorsque la méthode réussit et est rejetée avec un Error lorsqu’elle échoue. Utilisez await avec try...catch ou then et catch :

try {
  const result = await visitor.sendEvent({
    xdm: {
      eventType: "web.webpagedetails.pageViews",
      identityMap: {
        Email: [{ id: "visitor@example.com", primary: true }]
      }
    }
  });
  console.log("Propositions", result.propositions);
} catch (error) {
  console.error("sendEvent failed", error.message);
}

Le contenu de l’objet de résultat dépend de la méthode . La page de chaque méthode décrit son objet de résultat. Certaines méthodes, telles que setConsent, sont résolues avec un objet vide.

Le résultat dépend également du consentement du visiteur. Si le visiteur s’est désabonné, des méthodes telles que sendEvent sont résolues avec un objet vide sans rien envoyer à Adobe.

Erreurs errors

Une méthode rejette dans les cas suivants, entre autres :

  • Options non valides : le SDK valide chaque option avant d’envoyer quoi que ce soit. Une option inconnue ou mal orthographiée, ou une valeur du mauvais type, est rejetée avec un message qui nomme le problème, comme 'bogus': Unknown field.
  • Échecs d’authentification : si le SDK ne parvient pas à obtenir un jeton d’accès, la méthode le rejette avec un message contenant des Failed to acquire an IMS access token. Voir Authentification.
  • Erreurs Edge Network : si l’Edge Network rejette la demande, par exemple parce que l’événement n’a pas d’identité principale, la méthode la rejette avec l’erreur renvoyée par l’Edge Network.
  • Défaillances réseau : si votre serveur ne parvient pas à joindre Adobe, la méthode est rejetée avec l’erreur réseau sous-jacente.

forRequest ne renvoie pas de promesse. Elle renvoie immédiatement un objet Handle ou renvoie une erreur si configure n’a pas encore été résolu.

Selon votre exécution et la manière dont elle est configurée, un rejet de promesse non géré peut arrêter le traitement du serveur ou faire échouer la requête. Gérez toujours les rejets des méthodes SDK, de sorte qu’un problème d’envoi de données à Adobe n’interrompe pas la réponse que votre serveur envoie au visiteur.

recommendation-more-help
experience-platform-help-collection