Datenelementtypen für Web-Erweiterungen
In Datenerfassungs-Tags sind Datenelemente im Wesentlichen Aliase zu Datensegmenten auf einer Seite. Diese Daten finden Sie in Abfragezeichenfolgenparametern, Cookies, DOM-Elementen oder anderen Speicherorten. Ein Datenelement kann durch Regeln referenziert werden und dient als Abstraktion für den Zugriff auf diese Datenelemente.
Datenelementtypen werden von Erweiterungen bereitgestellt und ermöglichen es Benutzenden, Datenelemente so zu konfigurieren, dass sie auf bestimmte Weise auf Datenelemente zugreifen können. Als Beispiel könnte eine Erweiterung einen Datenelementtyp „Lokales Speicherelement“ bereitstellen, bei dem der Benutzer einen lokalen Speicherelementnamen angeben kann. Wenn das Datenelement durch eine Regel referenziert wird, kann die Erweiterung den Elementwert der lokalen Datenspeicherung mithilfe des Elementnamens der lokalen Datenspeicherung nachschlagen, den der Benutzer beim Konfigurieren des Datenelements angegeben hat.
In diesem Dokument wird beschrieben, wie Sie Datenelementtypen für eine Web-Erweiterung in Adobe Experience Platform definieren.
Datenelementtypen bestehen in der Regel aus Folgendem:
- Eine Ansicht die in der Experience Platform-Benutzeroberfläche und der Datenerfassungs-Benutzeroberfläche angezeigt wird und es Benutzern ermöglicht, die Einstellungen für das Datenelement zu ändern.
- Ein Bibliotheksmodul, das in der Tag-Laufzeitbibliothek ausgegeben wird, um die Einstellungen zu interpretieren und Datensegmente abzurufen.
Stellen Sie sich eine Situation vor, in der Sie den Benutzern erlauben möchten, ein Datenelement aus einem lokalen Speicherelement namens productName
abzurufen. Ihr Modul könnte wie folgt aussehen:
module.exports = function(settings) {
return localStorage.getItem('productName');
}
Wenn Sie möchten, dass der Adobe Experience Platform-Benutzer den Elementnamen des lokalen Datenspeichers konfigurieren kann, können Sie den Benutzer einen Namen eingeben und diesen im settings
-Objekt speichern lassen. Das Objekt könnte etwa so aussehen:
{
itemName: "campaignId"
}
Um mit dem benutzerdefinierten Namen des lokalen Datenspeichers arbeiten zu können, muss Ihr Modul wie folgt geändert werden:
module.exports = function(settings) {
return localStorage.getItem(settings.itemName);
}
Unterstützung von Standardwerten
Beachten Sie, dass Benutzer die Möglichkeit haben, einen Standardwert für ein Datenelement zu konfigurieren. Wenn Ihr Datenelement-Bibliotheksmodul den Wert undefined
oder null
zurückgibt, wird dieser automatisch durch den Standardwert ersetzt, den der Benutzer für das Datenelement konfiguriert hat.
Kontextbezogene Ereignisdaten
Wenn das Datenelement als Ergebnis einer ausgelösten Regel abgerufen wird (z. B. wenn Datenelemente in den Bedingungen und Aktionen der Regel verwendet werden), wird ein zweites Argument an Ihr Modul übergeben, das Kontextinformationen zu dem Ereignis enthält, das die Regel ausgelöst hat. Das kann in bestimmten Fällen von Vorteil sein. Auf dieses Argument wird wie folgt zugegriffen:
module.exports = function(settings, event) {
// event contains information regarding the event that fired the rule
};
Das event
-Objekt muss die folgenden Eigenschaften enthalten:
$type
youtube.play
.$rule
Ein Objekt, das Informationen zu der Regel enthält, die derzeit ausgeführt wird. Das Objekt muss die folgenden Untereigenschaften enthalten:
id
: Die ID der derzeit ausgeführten Regel.name
: Der Name der derzeit ausgeführten Regel.
Die Erweiterung, die den Ereignistyp bereitstellt, der die Regel ausgelöst hat, kann optional weitere nützliche Informationen zu diesem event
-Objekt hinzufügen.