Configurare l’SDK web per Platform

La configurazione per l’SDK viene eseguita con la configure comando.

IMPORTANTE

configure è sempre il primo comando chiamato.

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

È possibile impostare molte opzioni durante la configurazione. Di seguito sono riportate tutte le opzioni, raggruppate per categoria.

Opzioni generali

edgeConfigId

NOTA

Le configurazioni Edge sono state rinominate in Datastreams. Un ID datastream è lo stesso di un ID di configurazione.

Tipo Obbligatorio Valore predefinito
Stringa Nessuna

L'ID di configurazione assegnato, che collega l'SDK agli account e alla configurazione appropriati. Quando configuri più istanze all’interno di una singola pagina, devi configurare un edgeConfigId per ogni istanza.

context

Tipo Obbligatorio Valore predefinito
Array di stringhe No ["web", "device", "environment", "placeContext", "highEntropyUserAgentHints"]

Indica le categorie di contesto da raccogliere automaticamente come descritto in Informazioni automatiche. Se questa configurazione non è specificata, vengono utilizzate tutte le categorie per impostazione predefinita.

IMPORTANTE

Tutte le proprietà del contesto, ad eccezione di highEntropyUserAgentHints, sono abilitate per impostazione predefinita. Se hai specificato manualmente le proprietà di contesto nella configurazione dell’SDK per web, devi abilitare tutte le proprietà di contesto per continuare a raccogliere le informazioni necessarie.

Per abilitare suggerimenti client entropici elevati nella distribuzione dell’SDK web, devi includere highEntropyUserAgentHints contestuale, accanto alla configurazione esistente.

Ad esempio, per recuperare suggerimenti client entropici elevati dalle proprietà web, la configurazione sarà simile alla seguente:

context: ["highEntropyUserAgentHints", "web"]

debugEnabled

Tipo Obbligatorio Valore predefinito
Booleano No false

Indica se il debug è abilitato. Impostazione della configurazione su true abilita le seguenti funzionalità:

Funzione Funzione
Registrazione della console Abilita la visualizzazione dei messaggi di debug nella console JavaScript del browser

edgeDomain

Compilare questo campo con il dominio di prime parti. Per maggiori dettagli, consulta la documentazione.

Il dominio è simile a data.{customerdomain.com} per un sito web all'indirizzo www.{customerdomain.com}.

edgeBasePath

Percorso successivo a edgeDomain utilizzato per comunicare e interagire con i servizi Adobe. Spesso questo cambiamento si verifica solo quando non si utilizza l’ambiente di produzione predefinito.

Tipo Obbligatorio Valore predefinito
Stringa No ee

orgId

Tipo Obbligatorio Valore predefinito
Stringa Nessuna

Assegnato Experience Cloud ID organizzazione. Quando configuri più istanze all’interno di una pagina, devi configurare un orgId per ogni istanza.

Raccolta dati

clickCollectionEnabled

Tipo Obbligatorio Valore predefinito
Booleano No true

Indica se i dati associati ai clic sul collegamento vengono raccolti automaticamente. Vedi Tracciamento automatico dei collegamenti per ulteriori informazioni. I collegamenti sono anche etichettati come collegamenti di download se includono un attributo di download o se il collegamento termina con un’estensione di file. I qualificatori di collegamento per il download possono essere configurati con un’espressione regolare. Il valore predefinito è "\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"

onBeforeEventSend

Tipo Obbligatorio Valore predefinito
Funzione No () => non definito

Configura un callback chiamato per ogni evento immediatamente prima dell'invio. Un oggetto con il campo xdm viene inviato al callback. Per modificare l’invio, modifica il xdm oggetto. All'interno del callback, il xdm oggetto dispone già dei dati passati nel comando evento e delle informazioni raccolte automaticamente. Per ulteriori informazioni sulla tempistica di questo callback e un esempio, vedi Modifica degli eventi a livello globale.

onBeforeLinkClickSend

Tipo Obbligatorio Valore predefinito
Funzione No () => non definito

Configura un callback che viene chiamato per ogni evento di tracciamento dei clic del collegamento immediatamente prima dell’invio. Il callback invia un oggetto con xdm, clickedElemente data campi.

Quando filtri il tracciamento dei collegamenti utilizzando la struttura degli elementi DOM, puoi utilizzare la funzione clickElement comando. clickedElement è il nodo dell'elemento DOM su cui è stato fatto clic e che ha incapsulato la struttura dei nodi padre.

Per modificare i dati inviati, modifica la xdm e/o data oggetti. All'interno del callback, il xdm oggetto dispone già dei dati passati nel comando evento e delle informazioni raccolte automaticamente.

  • Qualsiasi valore diverso da false consentirà all’evento di elaborare e di inviare il callback.
  • Se il callback restituisce il false l'elaborazione dell'evento viene interrotta senza un errore e l'evento non viene inviato. Questo meccanismo consente di filtrare alcuni eventi esaminando i dati dell’evento e restituendo false se l’evento non deve essere inviato.
  • Se il callback genera un'eccezione, l'elaborazione per l'evento viene interrotta e l'evento non viene inviato.

Opzioni privacy

Tipo Obbligatorio Valore predefinito
Oggetto No "in"

Imposta il consenso predefinito dell’utente. Utilizza questa impostazione quando non è già stata salvata alcuna preferenza di consenso per l’utente. Gli altri valori validi sono "pending" e "out". Questo valore predefinito non viene mantenuto nel profilo dell’utente. Il profilo dell’utente viene aggiornato solo quando setConsent viene chiamato.

  • "in": Quando questa impostazione è impostata o non viene fornito alcun valore, il lavoro procede senza le preferenze di consenso dell’utente.
  • "pending": Quando questa impostazione è impostata, il lavoro viene messo in coda fino a quando l’utente non fornisce le preferenze di consenso.
  • "out": Quando questa impostazione è impostata, il lavoro viene scartato finché l’utente non fornisce le preferenze di consenso.
    Dopo aver fornito le preferenze dell’utente, lavorare procede o viene interrotto in base alle preferenze dell’utente. Vedi Consenso di supporto per ulteriori informazioni.

Opzioni di personalizzazione

prehidingStyle

Tipo Obbligatorio Valore predefinito
Stringa No Nessuna

Utilizzato per creare una definizione di stile CSS che nasconde le aree contenuto della pagina web mentre il contenuto personalizzato viene caricato dal server. Se non viene fornita questa opzione, l’SDK non tenta di nascondere alcuna area di contenuto durante il caricamento del contenuto personalizzato, generando potenzialmente una visualizzazione momentanea di altri contenuti.

Ad esempio, se un elemento nella pagina web ha un ID di container, il cui contenuto predefinito da nascondere durante il caricamento di contenuto personalizzato dal server, utilizza il seguente stile di pre-hiding:

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

targetMigrationEnabled

Questa opzione deve essere utilizzata per la migrazione di singole pagine da at.js all'SDK web.

Usa questa opzione per abilitare l’SDK web alla lettura e scrittura delle versioni precedenti mbox e mboxEdgeCluster cookie utilizzati da at.js. In questo modo puoi mantenere il profilo del visitatore mentre passi da una pagina che utilizza l’SDK per web a una pagina che utilizza il at.js libreria e viceversa.

Tipo Obbligatorio Valore predefinito
Booleano No false

Opzioni del pubblico

cookieDestinationsEnabled

Tipo Obbligatorio Valore predefinito
Booleano No true

Abilita Audience Manager destinazioni cookie, che consente di impostare cookie in base alla qualifica del segmento.

urlDestinationsEnabled

Tipo Obbligatorio Valore predefinito
Booleano No true

Abilita Audience Manager Destinazioni URL, che consentono di attivare gli URL in base alla qualifica del segmento.

Opzioni di identità

idMigrationEnabled

Tipo Obbligatorio Valore predefinito
Booleano No true

Se true, l'SDK legge e imposta i cookie AMCV precedenti. Questa opzione aiuta nella transizione all'utilizzo di Adobe Experience Platform Web SDK, mentre alcune parti del sito potrebbero ancora utilizzare Visitor.js.

Se nella pagina è definita l’API del visitatore, l’SDK invia una query all’API del visitatore per l’ECID. Questa opzione consente di utilizzare pagine con doppio tag con Adobe Experience Platform Web SDK e di disporre comunque dello stesso ECID.

thirdPartyCookiesEnabled

Tipo Obbligatorio Valore predefinito
Booleano No true

Abilita l’impostazione di cookie di terze parti di Adobe. L'SDK può mantenere l'ID visitatore in un contesto di terze parti per consentire l'utilizzo dello stesso ID visitatore nei diversi siti. Utilizza questa opzione se disponi di più siti o desideri condividere dati con i partner; tuttavia, a volte questa opzione non è desiderata per motivi di privacy.

In questa pagina