Integrieren von Platform Web SDK zur Verarbeitung von Kundeneinverständnisdaten
- Themen:
- Einverständnis
Erstellt für:
- Entwickler
Mit der Adobe Experience Platform Web SDK können Sie Einverständnissignale von Kundinnen und Kunden abrufen, die von Einverständnisverwaltungsplattformen (CMPs) generiert wurden, und sie an Adobe Experience Platform senden, wenn ein Einverständnisänderungsereignis auftritt.
Der SDK stellt standardmäßig keine Schnittstelle zu CMPs bereit. Es liegt an Ihnen zu bestimmen, wie Sie die SDK in Ihre Website integrieren, auf Einverständnisänderungen in der CMP zu warten und den entsprechenden Befehl aufzurufen. Dieses Dokument enthält allgemeine Anleitungen zum Integrieren Ihres CMP mit Platform Web SDK.
Voraussetzungen
In diesem Tutorial wird davon ausgegangen, dass Sie bereits bestimmt haben, wie Einverständnisdaten in Ihrer CMP generiert werden, und einen Datensatz mit Einverständnisfeldern 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 der SDK mithilfe der Tag-Erweiterung in der Benutzeroberfläche. Wenn Sie die -Erweiterung nicht verwenden möchten und es vorziehen würden, die eigenständige Version der SDK direkt auf Ihrer Site einzubetten, lesen Sie bitte die folgenden Dokumente anstelle dieses Handbuchs:
Die Installationsschritte in diesem Handbuch erfordern ein grundlegendes Verständnis von Tag-Erweiterungen und ihrer Installation in Web-Anwendungen. Weiterführende Informationen finden Sie in der folgenden Dokumentation:
Einrichten eines Datenstroms
Damit SDK Daten an Experience Platform senden kann, müssen Sie zunächst einen Datenstrom konfigurieren. Wählen Sie in der Datenerfassungs-Benutzeroberfläche oder der Experience Platform-Benutzeroberfläche Datenströme in der linken Navigationsleiste.
Nachdem Sie einen neuen Datenstrom erstellt oder einen vorhandenen ausgewählt haben, um ihn zu bearbeiten, klicken Sie auf die Umschaltfläche neben Adobe Experience Platform. Verwenden Sie als Nächstes die unten aufgeführten Werte, um das Formular auszufüllen.
Wenn Sie fertig sind wählen Sie unten Bildschirm „Speichern“ aus und folgen Sie weiteren Eingabeaufforderungen, um die Konfiguration abzuschließen.
Installieren und Konfigurieren von Platform Web SDK
Nachdem Sie einen Datenstrom wie im vorherigen Abschnitt beschrieben erstellt haben, müssen Sie dann die Platform Web SDK-Erweiterung konfigurieren, die Sie schließlich auf Ihrer Site bereitstellen. Wenn Sie die SDK-Erweiterung nicht in Ihrer Tag-Eigenschaft installiert haben, wählen Sie Erweiterungen im linken Navigationsbereich und dann die Registerkarte Katalog aus. Wählen Sie dann Installieren unter der Platform SDK-Erweiterung in der Liste der verfügbaren Erweiterungen aus.
Wählen Sie beim Konfigurieren von SDK unter Edge Konfigurationen den Datenstrom aus, den Sie im vorherigen Schritt erstellt haben.
Wählen Speichern, um die Erweiterung zu installieren.
Erstellen eines Datenelements zum Festlegen des Standardeinverständnisses
Wenn die SDK-Erweiterung installiert ist, haben Sie die Möglichkeit, ein Datenelement zu erstellen, das den standardmäßigen Einverständniswert für die Datenerfassung (collect.val) für Ihre Benutzerinnen und Benutzer darstellt. Dies kann nützlich sein, wenn Sie je nach Benutzer unterschiedliche Standardwerte verwenden 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 das Standardeinverständnis basierend auf der Region des Benutzers festzulegen:
- Bestimmen der Region des Benutzers auf dem Webserver
- Rendern Sie vor dem
script-Tag (Einbettungs-Code) auf der Web-Seite ein separatesscript-Tag, das eineadobeDefaultConsent-Variable basierend auf der Region des Benutzers festlegt. - Richten Sie ein Datenelement ein, das die
adobeDefaultConsentJavaScript-Variable verwendet, und verwenden Sie dieses Datenelement als standardmäßigen Einverständniswert für den Benutzer.
Wenn die Region des Benutzers durch eine CMP bestimmt wird, können Sie stattdessen die folgenden Schritte verwenden:
- Behandeln Sie das Ereignis „CMP Loaded“ auf der Seite.
- Legen Sie im Ereignishandler eine
adobeDefaultConsentVariable basierend auf der Region des Benutzers fest und laden Sie dann das Tag-Bibliotheksskript mit JavaScript. - Richten Sie ein Datenelement ein, das die
adobeDefaultConsentJavaScript-Variable verwendet, und verwenden Sie dieses Datenelement als standardmäßigen Einverständniswert für den Benutzer.
Um ein Datenelement in der Benutzeroberfläche zu erstellen, wählen Sie Datenelemente in der linken Navigationsleiste aus und klicken Sie dann auf Datenelement hinzufügen, um zum Dialogfeld für die Erstellung von Datenelementen zu navigieren.
Von hier aus müssen Sie ein Datenelement JavaScript-Variable basierend auf adobeDefaultConsent erstellen. Wählen Sie Speichern, wenn Sie fertig sind.
Nachdem das Datenelement erstellt wurde, navigieren Sie zurück zur Konfigurationsseite der Web-SDK-Erweiterung. Wählen Sie im Datenschutz die Option Von Datenelement bereitgestellt und verwenden Sie das bereitgestellte Dialogfeld, um das zuvor erstellte standardmäßige Datenelement zum Einverständnis auszuwählen.
Bereitstellen der Erweiterung auf Ihrer Website
Nachdem Sie die Konfiguration der Erweiterung abgeschlossen haben, kann sie in Ihre Website integriert werden. Ausführliche Informationen zur Bereitstellung aktualisierten Bibliotheks-Builds finden Sie„Veröffentlichungshandbuch“ in der Tags-Dokumentation.
Erstellen von Befehlen zur Einverständnisänderung
Nachdem Sie die SDK-Erweiterung in Ihre Website integriert haben, können Sie mit dem Befehl Platform Web SDK setConsent beginnen, Einverständnisdaten an Platform zu senden.
Der Befehl setConsent führt zwei Aktionen aus:
- Aktualisiert die Profilattribute des Benutzers direkt im Profilspeicher. Dadurch werden keine Daten an den Data Lake gesendet.
- Erstellt ein Erlebnisereignis das ein mit einem Zeitstempel versehenes Konto des Einverständnisänderungsereignisses aufzeichnet. Diese Daten werden direkt an den Data Lake gesendet und können verwendet werden, um Änderungen der Einverständnispräferenzen im Laufe der Zeit zu verfolgen.
Wann setConsent aufgerufen werden soll
Es gibt zwei Szenarien, in denen setConsent auf Ihrer Site aufgerufen werden sollten:
- Wenn das Einverständnis auf der Seite geladen wird (d. h. bei jedem Laden der Seite)
- Als Teil eines CMP-Hooks oder Ereignis-Listeners, der Änderungen an den Einverständniseinstellungen erkennt
setConsent
Der setConsent-Befehl erwartet ein Payload-Objekt, das eine einzige Eigenschaft vom Typ Array enthält: consent. Das consent-Array muss mindestens ein Objekt enthalten, das die erforderlichen Einverständnisfelder für den Adobe-Standard bereitstellt.
Die erforderlichen Einverständnisfelder für den Adobe-Standard werden im folgenden Beispiel setConsent Aufruf gezeigt:
alloy("setConsent", {
consent: [{
standard: "Adobe",
version: "2.0",
value: {
collect: {
val: "y"
},
share: {
val: "y"
},
personalize: {
content: {
val: "y"
}
},
metadata: {
time: "YYYY-10-12T15:52:25+00:00"
}
}
}]
});
standardAdobe gesetzt werden.versionstandard angegeben ist. Dieser Wert muss für die Einverständnisverarbeitung nach Adobe-Standard auf 2.0 gesetzt werden.value
NOTEAdobe verwenden (z. B. IAB TCF), können Sie dem consent-Array für jeden Standard zusätzliche Objekte hinzufügen. Jedes Objekt muss geeignete Werte für standard, version und value für den Einverständnisstandard enthalten, den sie repräsentieren.Der folgende JavaScript zeigt ein Beispiel für eine Funktion, die Änderungen der Einverständnisvoreinstellungen auf einer Website verarbeitet, die als Callback in einem Ereignis-Listener oder CMP-Hook verwendet werden können:
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. um Bestätigungsnachrichten an den Kunden anzuzeigen. Weitere Informationen finden unter.
Nachdem Sie setConsent Aufrufe mit der SDK erfolgreich durchgeführt haben, können Sie mit dem Profil-Viewer in der Platform-Benutzeroberfläche überprüfen, ob Daten im Profilspeicher landen. Weitere Informationen finden Sie im Abschnitt Durchsuchen von Profilen nach).
Nächste Schritte
In diesem Handbuch haben Sie die Platform Web SDK-Erweiterung so konfiguriert, dass Einverständnisdaten an Experience Platform gesendet werden. Anleitungen zum Testen Ihrer Implementierung finden Sie in der Dokumentation zum Einverständnisstandard, den Sie implementieren: