Villkorstyper för webbtillägg
I en regel utvärderas ett villkor efter att en händelse har inträffat. Alla villkor måste returnera true för att regeln ska kunna fortsätta bearbetningen. Undantaget är när användare uttryckligen placerar villkor i en"undantagsbucket", vilket innebär att alla villkor i bucket måste returnera false för att regeln ska fortsätta bearbetningen.
Ett tillägg kan till exempel innehålla villkorstypen "viewport contains", där användaren kan ange en CSS-väljare. När villkoret utvärderas på klientens webbplats kan tillägget hitta element som matchar CSS-väljaren och returnera om något av dem finns i användarens visningsruta.
I det här dokumentet beskrivs hur du definierar villkorstyper för ett webbtillägg i Adobe Experience Platform.
Villkorstyperna 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 villkoret.
- En biblioteksmodul som skickas inom taggens körningsbibliotek för att tolka inställningarna och utvärdera ett villkor.
En biblioteksmodul av typen condition har ett mål: utvärdera om något är sant eller falskt. Det som utvärderas är upp till dig.
Om du till exempel vill utvärdera om användaren finns på värden example.com
kan din modul se ut så här:
module.exports = function(settings) {
return document.location.hostname === 'example.com';
};
Tänk dig en situation där du vill göra värdnamnet konfigurerbart av Adobe Experience Platform-användaren. Du kan tillåta användaren att ange ett värdnamn och sedan spara värdnamnet till inställningsobjektet. Objektet kan se ut ungefär så här:
{
"hostname": "example.com"
}
Om du vill använda det användardefinierade värdnamnet måste modulen ändras till följande:
module.exports = function(settings) {
return document.location.hostname === settings.hostname;
};
Sammanhangsberoende händelsedata
Ett andra argument skickas 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.