Integrieren des Platform Web SDK zur Verarbeitung von Daten zur Kundenzustimmung

Mit dem Adobe Experience Platform Web SDK können Sie von Consent Management Platforms (CMP) generierte Zustimmungssignale von Kunden abrufen und an Adobe Experience Platform senden, sobald ein Zustimmungsänderungsereignis eintritt.

Das SDK verfügt nicht standardmäßig über eine Schnittstelle mit CMPs. Sie müssen bestimmen, wie das SDK in Ihre Website integriert werden kann, auf Zustimmungsänderungen in der CMP warten und den entsprechenden Befehl aufrufen. Dieses Dokument enthält allgemeine Anleitungen zur Integration Ihres CMP mit dem Platform Web SDK.

Voraussetzungen

In diesem Tutorial wird davon ausgegangen, dass Sie bereits ermittelt haben, wie Einwilligungsdaten in Ihrer CMP generiert werden, und einen Datensatz mit Einwilligungsfeldern erstellt haben, die dem Adobe-Standard oder dem IAB Transparency and Consent Framework (TCF) 2.0-Standard entsprechen. Wenn Sie diesen Datensatz noch nicht erstellt haben, lesen Sie die folgenden Tutorials, bevor Sie zu diesem Handbuch zurückkehren:

Dieses Handbuch folgt dem Workflow zum Einrichten des SDK mithilfe der Tag-Erweiterung in der Benutzeroberfläche. Wenn Sie die -Erweiterung nicht verwenden möchten und die eigenständige Version des SDK lieber direkt auf Ihrer Site einbetten möchten, lesen Sie die folgenden Dokumente anstelle dieses Handbuchs:

Die Installationsschritte in diesem Handbuch erfordern ein Verständnis der Tag-Erweiterungen und deren Installation in Webanwendungen. Weiterführende Informationen finden Sie in der folgenden Dokumentation:

Einrichten eines Datenstroms

Damit das SDK Daten an Experience Platform senden kann, müssen Sie zunächst einen Datenspeicher konfigurieren. Wählen Sie in der Datenerfassungs-Benutzeroberfläche oder der Benutzeroberfläche "Experience Platform"die Option Datenspeicher in der linken Navigation.

Nachdem Sie einen neuen Datensatz erstellt oder einen vorhandenen ausgewählt haben, den Sie bearbeiten möchten, wählen Sie die Umschalter-Schaltfläche neben Adobe Experience Platform. Verwenden Sie anschließend die unten aufgeführten Werte, um das Formular auszufüllen.

Datenspeicherfeld Wert
Sandbox Der Name der Plattform Sandbox , die die erforderliche Streaming-Verbindung und Datensätze zum Einrichten des Datastreams enthält.
Ereignis-Datensatz Ein XDM ExperienceEvent Datensatz, an den Sie Ereignisdaten mit dem SDK senden möchten. Sie müssen zwar einen Ereignis-Datensatz bereitstellen, um einen Platform-Datenspeicher zu erstellen, beachten Sie jedoch, dass über Ereignisse gesendete Zustimmungsdaten in nachgelagerten Durchsetzungs-Workflows nicht berücksichtigt werden.
Profildatensatz Die Profile-aktivierter Datensatz mit von Ihnen erstellten Feldern zur Kundenzustimmung früher.

Wenn Sie fertig sind, wählen Sie Speichern unten auf dem Bildschirm und folgen Sie weiteren Anweisungen, um die Konfiguration abzuschließen.

Installieren und Konfigurieren des Platform Web SDK

Nachdem Sie einen Datenspeicher erstellt haben, wie im vorherigen Abschnitt beschrieben, müssen Sie die Platform Web SDK-Erweiterung konfigurieren, die Sie letztendlich auf Ihrer Site bereitstellen werden. Wenn die SDK-Erweiterung nicht in Ihrer Tag-Eigenschaft installiert ist, wählen Sie Erweiterungen im linken Navigationsbereich, gefolgt von der Katalog Registerkarte. Wählen Sie anschließend Installieren unter der Platform SDK-Erweiterung in der Liste der verfügbaren Erweiterungen.

Beim Konfigurieren des SDK finden Sie unter Edge-Konfigurationen, wählen Sie den Datenspeicher aus, den Sie im vorherigen Schritt erstellt haben.

Auswählen Speichern , um die Erweiterung zu installieren.

Erstellen eines Datenelements zum Festlegen der Standardzustimmung

Wenn die SDK-Erweiterung installiert ist, können Sie ein Datenelement erstellen, das den standardmäßigen Datenerfassungs-Zustimmungswert darstellt (collect.val) für Ihre Benutzer. Dies kann nützlich sein, wenn Sie je nach Benutzer unterschiedliche Standardwerte haben möchten, z. B. pending für Benutzer der Europäischen Union und in für nordamerikanische Benutzer.

In diesem Anwendungsfall können Sie Folgendes implementieren, um die Standardzustimmung auf Grundlage der Region des Benutzers festzulegen:

  1. Bestimmen Sie die Region des Benutzers auf dem Webserver.
  2. Vor script -Tag (Einbettungscode) auf der Web-Seite ein separates script -Tag, das adobeDefaultConsent auf Grundlage der Region des Benutzers.
  3. Richten Sie ein Datenelement ein, das die adobeDefaultConsent JavaScript-Variable und verwenden Sie dieses Datenelement als standardmäßigen Zustimmungswert für den Benutzer.

Wenn die Region des Benutzers durch eine CMP bestimmt wird, können Sie stattdessen die folgenden Schritte verwenden:

  1. Behandeln Sie das Ereignis "CMP geladen"auf der Seite.
  2. Legen Sie im Ereignis-Handler eine adobeDefaultConsent auf Grundlage der Region des Benutzers und laden Sie dann das Tag-Bibliotheksskript mithilfe von JavaScript.
  3. Richten Sie ein Datenelement ein, das die adobeDefaultConsent JavaScript-Variable und verwenden Sie dieses Datenelement als standardmäßigen Zustimmungswert für den Benutzer.

Um ein Datenelement in der Benutzeroberfläche zu erstellen, wählen Sie Datenelemente Wählen Sie im linken Navigationsbereich die Option Datenelement hinzufügen , um zum Dialogfeld zur Datenelementerstellung zu navigieren.

Von hier aus müssen Sie eine JavaScript-Variable Datenelement basierend auf adobeDefaultConsent. Wählen Sie Speichern, wenn Sie fertig sind.

Nachdem das Datenelement erstellt wurde, navigieren Sie zurück zur Konfigurationsseite der Web SDK-Erweiterung . Unter dem Datenschutz Bereich, wählen Sie Wird vom Datenelement bereitgestellt und verwenden Sie das bereitgestellte Dialogfeld, um das zuvor erstellte standardmäßige Datenelement für die Einwilligung auszuwählen.

Bereitstellen der Erweiterung auf Ihrer Website

Nachdem Sie die Konfiguration der Erweiterung abgeschlossen haben, kann sie in Ihre Website integriert werden. Siehe Abschnitt Publishing-Handbuch in der Tag-Dokumentation finden Sie detaillierte Informationen zur Bereitstellung Ihres aktualisierten Bibliotheks-Builds.

Festlegen von Befehlen zur Änderung der Zustimmung

Nachdem Sie die SDK-Erweiterung in Ihre Website integriert haben, können Sie mit der Verwendung des Platform Web SDK beginnen setConsent -Befehl zum Senden von Einwilligungsdaten an Platform.

Die setConsent -Befehl führt zwei Aktionen aus:

  1. Aktualisiert die Profilattribute des Benutzers direkt im Profilspeicher. Dadurch werden keine Daten an den Data Lake gesendet.
  2. Erstellt eine Erlebnisereignis , das ein mit Zeitstempel versehenes Konto des Zustimmungsänderungsereignisses aufzeichnet. Diese Daten werden direkt an den Data Lake gesendet und können verwendet werden, um Änderungen der Zustimmungsparameter im Laufe der Zeit zu verfolgen.

Wann wird aufgerufen setConsent

Es gibt zwei Szenarien, in denen setConsent sollte auf Ihrer Site aufgerufen werden:

  1. Wenn die Einwilligung auf der Seite geladen wird (d. h. bei jedem Laden der Seite)
  2. Als Teil eines CMP-Hooks oder Ereignis-Listeners, der Änderungen in den Zustimmungseinstellungen erkennt

setConsent Syntax

HINWEIS

Eine Einführung in die allgemeine Syntax für Platform SDK-Befehle finden Sie im Dokument unter Ausführen von Befehlen.

Die setConsent -Befehl erwartet zwei Argumente:

  1. Eine Zeichenfolge, die den Befehlstyp angibt (in diesem Fall "setConsent")
  2. Ein Payload-Objekt, das eine einzelne Eigenschaft vom Typ Array enthält: consent. Die consent -Array muss mindestens ein Objekt enthalten, das die erforderlichen Einwilligungsfelder für den Adobe-Standard bereitstellt.

Die erforderlichen Einwilligungsfelder für den Adobe-Standard werden im folgenden Beispiel angezeigt setConsent Aufruf:

alloy("setConsent", {
  consent: [{
    standard: "Adobe",
    version: "2.0",
    value: {
      collect: {
        val: "y"
      },
      share: {
        val: "y"
      },
      personalize: {
        content: {
          val: "y"
        }
      },
      metadata: {
        time: "2020-10-12T15:52:25+00:00"
      }
    }
  }]
});
Payload-Eigenschaft Beschreibung
standard Der verwendete Zustimmungsstandard. Für den Adobe-Standard muss dieser Wert auf Adobe.
version Die unter standard. Dieser Wert muss auf 2.0 für die Verarbeitung von Einwilligungen nach Adobe-Standard.
value Die aktualisierten Zustimmungsinformationen des Kunden, die als XDM-Objekt bereitgestellt werden, das der Struktur der Einwilligungsfelder des Profilaktivierten Datensatzes entspricht.
HINWEIS

Wenn Sie andere Zustimmungsstandards in Verbindung mit Adobe (z. B. IAB TCF) können Sie weitere Objekte zur consent -Array für jeden Standard. Jedes Objekt muss die entsprechenden Werte für standard, versionund value für den Einverständnisstandard, den sie darstellen.

Das folgende JavaScript zeigt ein Beispiel für eine Funktion, die Änderungen der Zustimmungsvoreinstellungen auf einer Website verarbeitet, die als Rückruf in einem Ereignis-Listener oder CMP-Erweiterungspunkt verwendet werden kann:

var setConsent = function () {

  // Retrieve the current consent data.
  var categories = getConsentData();

  // If the script is running on a consent change, generate a new timestamp.
  // If the script is running on page load, set the timestamp to when the consent values last changed.
  var now = new Date();
  var collectedAt = consentChanged ? now.toISOString() : categories.collectedAt;

  //  Map the consent values and timestamp to XDM
  var consentXDM = {
    collect: {
      val: categories.collect !== -1 ? "y" : "n"
    },
    personalize: {
      content: {
        val: categories.personalizeContent !== -1 ? "y" : "n"
      }
    },
    share: {
      val: categories.share !== -1 ? "y" : "n"
    },
    metadata: {
      time: collectedAt
    }
  };

  // Pass the XDM object to the Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

Umgang mit SDK-Antworten

Alle Platform SDK -Befehle geben Zusagen zurück, die angeben, ob der Aufruf erfolgreich war oder fehlgeschlagen ist. Sie können diese Antworten dann für zusätzliche Logik verwenden, z. B. für die Anzeige von Bestätigungsnachrichten an den Kunden. Siehe Abschnitt zu Umgang mit Erfolg oder Fehlschlagen im Handbuch zum Ausführen von SDK-Befehlen für spezifische Beispiele.

Nachdem Sie erfolgreich setConsent -Aufrufe mit dem SDK verwenden, können Sie mit dem Profil-Viewer in der Platform-Benutzeroberfläche überprüfen, ob Daten im Profilspeicher landen. Siehe Abschnitt zu Profile nach Identität durchsuchen für weitere Informationen.

Nächste Schritte

In diesem Handbuch haben Sie die Platform Web SDK-Erweiterung so konfiguriert, dass Einwilligungsdaten an Experience Platform gesendet werden. Eine Anleitung zum Testen Ihrer Implementierung finden Sie in der Dokumentation zum Einverständnisstandard, den Sie implementieren:

Auf dieser Seite