Dataelementtyper för webbtillägg
I datainsamlingstaggar är dataelement i princip alias för datadelar på en sida. Dessa data finns i frågesträngsparametrar, cookies, DOM-element eller andra platser. Ett dataelement kan refereras av regler och fungerar som en abstraktion för att komma åt dessa datadelar.
Dataelementtyperna tillhandahålls via tillägg och gör det möjligt för användare att konfigurera dataelement så att de får tillgång till datadelar på ett visst sätt. Ett tillägg kan t.ex. innehålla ett dataelement av typen"lokal lagringspost", där användaren kan ange ett namn på den lokala lagringsposten. När en regel refererar till dataelementet kan tillägget söka efter det lokala lagringsobjektets värde med hjälp av det lokala lagringsobjektets namn som användaren angav när dataelementet konfigurerades.
Det här dokumentet beskriver hur du definierar dataelementtyper för ett webbtillägg i Adobe Experience Platform.
Dataelementtyper består vanligtvis av följande:
- En vy som visas i användargränssnittet för Experience Platform och datainsamlingen och som gör att användare kan ändra inställningarna för dataelementet.
- En biblioteksmodul som skickas i taggens körningsbibliotek för att tolka inställningarna och hämta data.
Tänk på en situation där du vill tillåta användare att hämta data från ett lokalt lagringsobjekt med namnet productName
. Modulen kan se ut så här:
module.exports = function(settings) {
return localStorage.getItem('productName');
}
Om du vill att det lokala lagringsobjektets namn ska kunna konfigureras av Adobe Experience Platform-användaren kan du tillåta att användaren anger ett namn och sedan spara namnet i settings
-objektet. Objektet kan se ut ungefär så här:
{
itemName: "campaignId"
}
Om du vill använda det användardefinierade lokala lagringsobjektnamnet måste modulen ändras till följande:
module.exports = function(settings) {
return localStorage.getItem(settings.itemName);
}
Stöd för standardvärden
Tänk på att användare kan konfigurera ett standardvärde för valfritt dataelement. Om biblioteksmodulen för dataelement returnerar värdet undefined
eller null
ersätts den automatiskt av det standardvärde som användaren har konfigurerat för dataelementet.
Sammanhangsberoende händelsedata
Om dataelementet hämtas som ett resultat av att en regel aktiveras (dataelement används t.ex. i regelns villkor och åtgärder), skickas ett andra argument till modulen som innehåller sammanhangsberoende information om händelsen som utlöste regeln. Det kan vara bra i vissa fall och kan nås på följande sätt:
module.exports = function(settings, event) {
// event contains information regarding the event that fired the rule
};
Objektet event
måste innehålla följande egenskaper:
$type
youtube.play
.$rule
Ett objekt som innehåller information om den regel som körs. Objektet måste innehålla följande underegenskaper:
id
: ID:t för den regel som körs.name
: Namnet på den regel som körs.
Tillägget som innehåller händelsetypen som utlöste regeln kan eventuellt lägga till annan användbar information till det här event
-objektet.