[Alpha]{class="badge informative"}

Server-SDK konfigurieren

Auf dieser Seite wird beschrieben, wie Sie den SDK-Server konfigurieren. Informationen zur Web-SDK finden Sie unter Konfigurieren der Web-SDK.

Sie konfigurieren den SDK-Server mit der configure. Rufen Sie sie in jeder Instanz einmal auf, wenn Ihr Server gestartet wird, und bevor Sie forRequest oder eine andere Methode aufrufen. Jedes forRequest-Handle verwendet die Konfiguration der Instanz, die es erstellt hat.

Die Eigenschaften datastreamId, orgId und edgeCredentials sind erforderlich. Alle anderen Eigenschaften sind optional. Das folgende Beispiel zeigt ein Konfigurationsobjekt, das alle verfügbaren Eigenschaften verwendet:

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

Konfigurationseigenschaften properties

Eigenschaft
Typ
Erforderlich
Standard
datastreamId
Zeichenfolge
Ja
Keine
orgId
Zeichenfolge
Ja
Keine
edgeCredentials
Objekt
Ja
Keine
debugEnabled
Boolesch
Nein
false
defaultConsent
Zeichenfolge
Nein
"in"
edgeBasePath
Zeichenfolge
Nein
"ee"
edgeConfigOverrides
Objekt
Nein
Keine
edgeDomain
Zeichenfolge
Nein
"edge.adobedc.net"
idMigrationEnabled
Boolesch
Nein
true
onBeforeEventSend
Funktion
Nein
Keine
thirdPartyCookiesEnabled
Boolesch
Nein
true

Die defaultConsent-Eigenschaft ist nur verfügbar, wenn die Instanz die Einverständniskomponente enthält, die createInstance standardmäßig enthält. Siehe Erstellen einer benutzerdefinierten Instanz.

Optionen, die vom SDK-Server nicht unterstützt werden unsupported

Web SDK verfügt über Konfigurationsoptionen für browserabhängige Funktionen, z. B. Link-Klick-Erfassung, Rendern personalisierter Inhalte und Push-Benachrichtigungen. Der SDK-Server akzeptiert diese Optionen nicht. Wenn Sie eine Option einbeziehen, werden configure mit einem Unknown field Fehler zurückgewiesen, der die Option benennt.

Die folgenden Web SDK-Optionen sind nicht verfügbar: autoCollectPropositionInteractions, clickCollection, clickCollectionEnabled, context, conversation, downloadLinkQualifier, onBeforeLinkClickSend, personalizationStorageEnabled, prehidingStyle, pushNotifications, streamingMedia und targetMigrationEnabled.

Ergebnis und Fehler result

Die configure Methode gibt eine Zusage zurück, die mit einem leeren Objekt aufgelöst wird, wenn die Konfiguration erfolgreich ist. Er lehnt in folgenden Fällen ab:

  • edgeCredentials fehlt oder eine der erforderlichen Eigenschaften fehlt.
  • defaultConsent ist auf "pending" festgelegt. Siehe defaultConsent.
  • Eine Eigenschaft hat einen ungültigen Wert oder wird nicht erkannt.
  • configure wurde bereits erfolgreich in derselben Instanz aufgerufen. Jede Instanz kann nur einmal konfiguriert werden.

Wenn configure ablehnt, bleibt die Instanz nicht konfiguriert und gibt forRequest einen Fehler aus, bis ein Aufruf von configure erfolgreich ist.

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