[Alpha]{class="badge informative"}

Configuration du SDK du serveur

Cette page décrit comment configurer le SDK du serveur. Pour le SDK Web, voir Configuration du SDK Web.

Vous configurez le SDK du serveur à l’aide de la méthode configure. Appelez-le une fois sur chaque instance, lorsque votre serveur démarre et avant d’appeler forRequest ou toute autre méthode. Chaque gestionnaire de forRequest utilise la configuration de l’instance qui l’a créé.

Les propriétés datastreamId, orgId et edgeCredentials sont requises. Toutes les autres propriétés sont facultatives. L’exemple suivant illustre un objet de configuration qui utilise chaque propriété disponible :

import { createInstance } from "@adobe/alloy-node";

const alloy = createInstance();

await alloy.configure({
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  edgeCredentials: {
    clientId: process.env.ADOBE_CLIENT_ID,
    clientSecret: process.env.ADOBE_CLIENT_SECRET,
    scopes: process.env.ADOBE_SCOPES.split(",")
  },
  debugEnabled: false,
  defaultConsent: "in",
  edgeBasePath: "ee",
  edgeConfigOverrides: {
    com_adobe_target: {
      propertyToken: "01dbc634-07c1-d8f9-ca69-b489a5ac5e94"
    }
  },
  edgeDomain: "data.example.com",
  idMigrationEnabled: false,
  onBeforeEventSend: (content) => {
    content.xdm.application ??= {};
    content.xdm.application.name = "Example storefront";
  },
  thirdPartyCookiesEnabled: false
});

Propriétés de configuration properties

Propriété
Type
Obligatoire
Par défaut
datastreamId
Chaîne
Oui
None
orgId
Chaîne
Oui
None
edgeCredentials
Objet
Oui
None
debugEnabled
Booléen
Non
false
defaultConsent
Chaîne
Non
"in"
edgeBasePath
Chaîne
Non
"ee"
edgeConfigOverrides
Objet
Non
None
edgeDomain
Chaîne
Non
"edge.adobedc.net"
idMigrationEnabled
Booléen
Non
true
onBeforeEventSend
Fonction
Non
None
thirdPartyCookiesEnabled
Booléen
Non
true

La propriété defaultConsent n’est disponible que lorsque l’instance inclut le composant Consentement, qui inclut createInstance par défaut . Voir ​ Création d’une instance personnalisée ​.

Options non prises en charge par le SDK du serveur unsupported

Web SDK propose des options de configuration pour les fonctionnalités qui dépendent d’un navigateur, telles que la collecte de clics sur des liens, le rendu de contenu personnalisé et les notifications push. Server SDK n’accepte pas ces options. Si vous en incluez une, configure rejette avec une erreur Unknown field qui nomme l’option.

Les options de SDK Web suivantes ne sont pas disponibles : autoCollectPropositionInteractions, clickCollection, clickCollectionEnabled, context, conversation, downloadLinkQualifier, onBeforeLinkClickSend, personalizationStorageEnabled, prehidingStyle, pushNotifications, streamingMedia et targetMigrationEnabled.

Résultat et erreurs result

La méthode configure renvoie une promesse qui est résolue avec un objet vide lorsque la configuration réussit. Elle rejette dans les cas suivants :

  • edgeCredentials est manquant ou l’une de ses propriétés requises est manquante.
  • defaultConsent est défini sur "pending". Voir defaultConsent.
  • Une propriété a une valeur non valide ou n’est pas reconnue.
  • configure a déjà été appelé avec succès sur la même instance. Chaque instance ne peut être configurée qu’une seule fois.

Si configure le rejette, l’instance reste non configurée et forRequest renvoie une erreur jusqu’à ce qu’un appel à configure réussisse.

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