[Alpha]{class="badge informative"}

Configurare Server SDK

In questa pagina viene descritto come configurare Server SDK. Per il Web SDK, vedere Configurare il Web SDK.

Configurare Server SDK con il metodo configure. Chiamala una volta per ogni istanza, all’avvio del server e prima di chiamare forRequest o qualsiasi altro metodo. Ogni handle forRequest utilizza la configurazione dell’istanza che lo ha creato.

Le proprietà datastreamId, orgId e edgeCredentials sono obbligatorie. Tutte le altre proprietà sono facoltative. L’esempio seguente mostra un oggetto di configurazione che utilizza tutte le proprietà disponibili:

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
});

Proprietà di configurazione properties

Proprietà
Tipo
Obbligatorio
Predefinito
datastreamId
Stringa
Sì
None (Nessuno)
orgId
Stringa
Sì
None (Nessuno)
edgeCredentials
Oggetto
Sì
None (Nessuno)
debugEnabled
Booleano
No
false
defaultConsent
Stringa
No
"in"
edgeBasePath
Stringa
No
"ee"
edgeConfigOverrides
Oggetto
No
None (Nessuno)
edgeDomain
Stringa
No
"edge.adobedc.net"
idMigrationEnabled
Booleano
No
true
onBeforeEventSend
Funzione
No
None (Nessuno)
thirdPartyCookiesEnabled
Booleano
No
true

La proprietà defaultConsent è disponibile solo quando l’istanza include il componente Consent, che createInstance include per impostazione predefinita. Vedi Creare un’istanza personalizzata.

Opzioni non supportate da Server SDK unsupported

Il Web SDK dispone di opzioni di configurazione per le funzioni che dipendono da un browser, come la raccolta di clic sui collegamenti, il rendering di contenuti personalizzati e le notifiche push. Server SDK non accetta queste opzioni. Se ne includi uno, configure rifiuta con un errore Unknown field che nomina l’opzione.

Le seguenti opzioni di Web SDK non sono disponibili: autoCollectPropositionInteractions, clickCollection, clickCollectionEnabled, context, conversation, downloadLinkQualifier, onBeforeLinkClickSend, personalizationStorageEnabled, prehidingStyle, pushNotifications, streamingMedia e targetMigrationEnabled.

Risultato ed errori result

Il metodo configure restituisce una promessa che viene risolta con un oggetto vuoto quando la configurazione riesce. Essa respinge nei seguenti casi:

  • Manca edgeCredentials oppure manca una delle proprietà richieste.
  • defaultConsent è impostato su "pending". Vedere defaultConsent.
  • Una proprietà ha un valore non valido o non è riconosciuta.
  • Chiamata di configure già eseguita correttamente sulla stessa istanza. Ogni istanza può essere configurata una sola volta.

Se configure rifiuta, l’istanza rimane non configurata e forRequest genera un errore fino a quando una chiamata a configure non riesce.

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