Configuration de Platform Web SDK

La configuration du SDK est effectuée à l’aide de la commande configure.

IMPORTANT

configure est ** toujours la première commande appelée.

alloy("configure", {
  "edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId":"ADB3LETTERSANDNUMBERS@AdobeOrg"
});

De nombreuses options peuvent être définies lors de la configuration. Vous trouverez ci-dessous toutes les options regroupées par catégorie.

Options générales

edgeConfigId

Type Obligatoire Valeur par défaut
Chaîne Oui Aucun

L’ID de configuration que vous avez attribué, qui lie le SDK aux comptes et à la configuration appropriés. Lors de la configuration de plusieurs instances dans une seule page, vous devez configurer un edgeConfigId différent pour chaque instance.

context

Type Obligatoire Valeur par défaut
Tableau de chaînes Non ["web", "device", "environment", "placeContext"]

Indique les catégories contextuelles à collecter automatiquement, comme décrit dans la section Informations automatiques. Si cette configuration n’est pas spécifiée, toutes les catégories sont utilisées par défaut.

debugEnabled

Type Obligatoire Valeur par défaut
Booléen Non false

Indique si le débogage est activé. La définition de cette configuration sur la valeur true permet d’activer les fonctionnalités suivantes :

Fonctionnalité Fonction
Validation synchrone Valide les données collectées par rapport au schéma et renvoie une erreur dans la réponse sous le libellé suivant : collect:error OR success
Journalisation de la console Permet l’affichage des messages de débogage dans la console JavaScript du navigateur.

edgeDomain

Renseignez ce champ avec votre domaine propriétaire. Pour plus de détails, consultez la documentation.

Le domaine est similaire à data.{customerdomain.com} pour un site Web à l’adresse www.{customerdomain.com}.

orgId

Type Obligatoire Valeur par défaut
Chaîne Oui Aucun

ID d'organisation Experience Cloud que vous avez attribué. Lors de la configuration de plusieurs instances dans une page, vous devez configurer un orgId différent pour chaque instance.

Collecte de données

clickCollectionEnabled

Type Obligatoire Valeur par défaut
Booléen Non true

Indique si les données associées aux clics sur les liens sont automatiquement collectées. Voir Suivi automatique des liens pour plus d’informations.

onBeforeEventSend

Type Obligatoire Valeur par défaut
Fonction Non () => non définie

Configurez un rappel appelé pour chaque événement juste avant son envoi. Un objet avec le champ xdm est envoyé dans le rappel. Pour modifier ce qui est envoyé, modifiez l'objet xdm. Dans le rappel, l'objet xdm contient déjà les données transmises dans la commande événement et les informations collectées automatiquement. Pour plus d’informations sur le minutage de ce rappel et pour obtenir un exemple, voir Modification globale des événements.

Options de confidentialité

Type Obligatoire Valeur par défaut
Objet Non "in"

Définit le consentement par défaut de l’utilisateur. Utilisez ce paramètre lorsqu’aucune préférence de consentement n’est déjà enregistrée pour l’utilisateur. Les autres valeurs valides sont "pending" et "out". Cette valeur par défaut n’est pas conservée au profil de l’utilisateur. Le profil de l’utilisateur n’est mis à jour que lorsque setConsent est appelé.

  • "in": Lorsque ce paramètre est défini ou qu’aucune valeur n’est fournie, le travail se poursuit sans les préférences de consentement de l’utilisateur.
  • "pending": Lorsque ce paramètre est défini, le travail est mis en file d’attente jusqu’à ce que l’utilisateur donne ses préférences de consentement.
  • "out": Lorsque ce paramètre est défini, le travail est ignoré jusqu’à ce que l’utilisateur donne ses préférences de consentement.
    Une fois les préférences de l’utilisateur fournies, le travail se poursuit ou est abandonné en fonction de celles-ci. Pour plus d’informations, voir Prise en charge du consentement.

Options de personnalisation

prehidingStyle

Type Obligatoire Valeur par défaut
Chaîne Non Aucun

Permet de créer une définition de style CSS qui masque les zones de contenu de votre page web pendant le chargement du contenu personnalisé à partir du serveur. Si cette option n’est pas fournie, le SDK ne tente pas de masquer les zones de contenu pendant le chargement du contenu personnalisé, ce qui peut entraîner un "scintillement".

Par exemple, si un élément de votre page Web a l’identifiant container, dont vous souhaitez masquer le contenu par défaut pendant le chargement du contenu personnalisé à partir du serveur, utilisez le style de prémasquage suivant :

  prehidingStyle: "#container { opacity: 0 !important }"

Options d’audiences

cookieDestinationsEnabled

Type Obligatoire Valeur par défaut
Booléen Non true

Active les destinations de cookie Audience Manager, ce qui permet la définition de cookies en fonction de la qualification du segment.

urlDestinationsEnabled

Type Obligatoire Valeur par défaut
Booléen Non true

Active les destinations URL Audience Manager, ce qui permet de déclencher des URL en fonction de la qualification des segments.

Options d’identité

idMigrationEnabled

Type Obligatoire Valeur par défaut
Booléen Non true

Si la valeur est true, le SDK lit et définit les anciens cookies AMCV. Cette option permet de passer à l’utilisation du SDK Web Adobe Experience Platform, tandis que certaines parties du site peuvent toujours utiliser Visiteur.js. Si l’API du Visiteur est définie sur la page, l’API du Visiteur de requêtes du SDK pour l’ECID. Cette option vous permet de créer des pages à deux balises avec le SDK Web de Adobe Experience Platform et d’avoir toujours le même ECID.

thirdPartyCookiesEnabled

Type Obligatoire Valeur par défaut
Booléen Non true

Active le paramètre des cookies tiers Adobe. Le SDK peut conserver l’ID de visiteur dans un contexte tiers afin de permettre l’utilisation du même ID de visiteur sur plusieurs sites. Utilisez cette option si vous avez plusieurs sites ou si vous souhaitez partager des données avec des partenaires ; toutefois, cette option n'est pas toujours souhaitée pour des raisons de confidentialité.

Sur cette page