[Alpha]{class="badge informative"}

Übersicht über Methoden

Die Server-SDK stellt ihre Funktionen als Methoden für das -Objekt bereit, das createInstance zurückgibt. Wenn Sie Web-SDK verwendet haben, entsprechen diese Methoden Web-SDK-Befehlen, sie werden jedoch anders aufgerufen:

Web SDK (Browser)
Server-SDK
alloy("sendEvent", { xdm })
alloy.sendEvent({ xdm })
alloy("getIdentity")
alloy.getIdentity()

Web SDK verwendet eine einzige Funktion, die den Befehlsnamen als Zeichenfolge akzeptiert, damit eine Seite Befehle in die Warteschlange stellen kann, bevor das Laden der Bibliothek abgeschlossen ist. Da ein Server die Bibliothek lädt, bevor er Anforderungen verarbeitet, verwendet der SDK-Server stattdessen reguläre Methoden, die Ihr Editor bei der Eingabe vorschlagen und überprüfen kann.

Verfügbare Methoden methods

Methode
Beschreibung
Instanz der obersten Ebene
forRequest
configure
Legt den Datenstrom, die Organisation, die Anmeldeinformationen und andere Optionen fest. Rufen Sie sie einmal auf, wenn Ihr Server gestartet wird.
Ja
Nein
forRequest
Gibt ein Handle zurück, das sich auf die Anfrage eines Besuchers bezieht.
Ja
Nein
sendEvent
Sendet ein Ereignis an die Edge Network und gibt die Ergebnisse zurück, z. B. Personalisierungsvorschläge.
Ja
Ja
getIdentity
Gibt die ECID des Besuchers zurück, ohne ein Ereignis zu senden.
Ja
Ja
appendIdentityToUrl
Fügt die Identität des Besuchers zu einer URL hinzu, damit eine andere Domain den Besucher erkennen kann.
Ja
Ja
setConsent
Zeichnet die Einverständniseinstellungen des Besuchers auf.
Ja
Ja
applyResponse
Verarbeitet eine Edge Network-Antwort, die Sie auf eine andere Weise erhalten haben.
Ja
Ja
getLibraryInfo
Gibt die Bibliotheksversion und die aktuelle Konfiguration zurück.
Ja
Ja
setDebug
Schaltet die Debug-Protokollierung ein oder aus.
Ja
Ja

Rufen Sie für Besucher-Traffic die Methoden in einem forRequest-Handle auf statt in der Instanz der obersten Ebene. Siehe Instanzen und Anfragen.

Ergebnisse verarbeiten results

Jede Methode außer forRequest gibt ein versprechen zurück. Die Zusage wird mit einem Ergebnisobjekt aufgelöst, wenn die Methode erfolgreich ist, und wird mit einem Error zurückgewiesen, wenn sie fehlschlägt. Verwenden Sie await mit try...catch oder verwenden Sie then und catch:

try {
  const result = await visitor.sendEvent({
    xdm: {
      eventType: "web.webpagedetails.pageViews",
      identityMap: {
        Email: [{ id: "visitor@example.com", primary: true }]
      }
    }
  });
  console.log("Propositions", result.propositions);
} catch (error) {
  console.error("sendEvent failed", error.message);
}

Der Inhalt des Ergebnisobjekts hängt von der -Methode ab. Jede Methodenseite beschreibt ihr Ergebnisobjekt. Einige Methoden, z. B. setConsent, werden mit einem leeren -Objekt aufgelöst.

Das Ergebnis hängt auch von der Zustimmung des Besuchers ab. Wenn der Besucher sich abgemeldet hat, lösen Methoden wie sendEvent mit einem leeren Objekt auf, ohne etwas an Adobe zu senden.

Fehler errors

Eine Methode lehnt unter anderem in folgenden Fällen ab:

  • Ungültige Optionen: Die SDK validiert jede Option, bevor sie etwas sendet. Eine unbekannte oder falsch geschriebene Option oder ein Wert vom falschen Typ wird mit einer Meldung zurückgewiesen, die das Problem benennt, z. B. 'bogus': Unknown field.
  • Authentifizierungsfehler: Wenn der SDK kein Zugriffstoken erhalten kann, wird die Methode mit einer Meldung zurückgewiesen, die Failed to acquire an IMS access token enthält. Siehe Authentifizierung.
  • Edge Network-Fehler: Wenn der Edge Network die Anfrage ablehnt, weil das Ereignis beispielsweise keine primäre Identität hat, lehnt die Methode die Anfrage mit dem Fehler ab, den der Edge Network zurückgegeben hat.
  • Netzwerkfehler: Wenn Ihr Server Adobe nicht erreichen kann, wird die Methode mit dem zugrunde liegenden Netzwerkfehler zurückgewiesen.

forRequest gibt kein Versprechen zurück. Sie gibt sofort einen Handle zurück oder gibt einen Fehler aus, wenn configure noch nicht aufgelöst wurde.

Je nach Laufzeit und Konfiguration kann eine nicht verarbeitete Versprechensablehnung den Serverprozess stoppen oder die Anfrage fehlschlagen lassen. Behandeln Sie immer Ablehnungen von SDK-Methoden, damit ein Problem beim Senden von Daten an Adobe nicht die Antwort beeinträchtigt, die Ihr Server an den Besucher sendet.

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