Kameleoon.API.Personalizations - Kameleoon Documentation

Dieses Modul stellt Methoden für den Zugriff auf Live-Personalisierungen bereit.

disable

Die Methode disable() markiert eine Personalisierung als deaktiviert. Verwenden Sie dies für interaktive Elemente wie Pop-Ins. Wenn ein Benutzer das Element schließt, rufen Sie disable() auf, um den Personalisierungsstatus zu aktualisieren. Kameleoon implementiert diesen Aufruf automatisch für native, nicht benutzerdefinierte Oberflächenelemente.

let personalizationID = 12345;
Kameleoon.API.Personalizations.disable(personalizationID);

Arguments

Name	Type	Description
id	Number	ID der Personalisierung. Dieses Feld ist erforderlich.

getActive

Die Methode getActive() gibt aktive Personalisierungen für den Besuch und die Seite zurück. Eine Personalisierung ist aktiv, wenn ihr Variationscode ausgeführt wurde und die zugeordnete Aktion weiterhin sichtbar ist. Um Personalisierungen abzurufen, die auf anderen URLs ausgelöst wurden oder die jetzt geschlossen sind, wie etwa Pop-Ins, verwenden Sie getTriggeredInVisit().

if (Kameleoon.API.Personalizations.getActive().length == 0) {
  Kameleoon.API.Events.trigger("No Personalizations Events");
}

Rückgabewert

Name	Type	Description
personalizations	Array	Liste der Personalization-Objekte.

getAll

Die getAll() Methode gibt alle Live-Personalisierungen zurück (laufend, nicht Entwurf/pausiert/gestoppt).

Kameleoon.API.Personalizations.getAll().forEach(function (personalization) {
  if (personalization.id == 123456 && personalization.active) {
    console.log(personalization.name);
  }
});

Rückgabewert

Name	Type	Description
personalizations	Array	Liste der Personalization-Objekte.

getById

Die getById() Methode gibt die Personalisierung für die angegebene ID zurück.

var personalization = Kameleoon.API.Personalizations.getById(123456);

if (personalization && personalization.active) {
  console.log(personalization.name);
}

Arguments

Name	Type	Description
id	Number	ID der Personalisierung. Dieses Feld ist erforderlich.

Rückgabewert

Name	Type	Description
personalization	Object	Personalization-Objekt.

getByName

Die getByName() Methode gibt die Personalisierung für den angegebenen Namen zurück.

var personalization = Kameleoon.API.Personalizations.getByName("MyPersonalizationName");

if (personalization && personalization.active) {
  console.log(personalization.id);
}

Arguments

Name	Type	Description
name	String	Name der Personalisierung. Dieses Feld ist erforderlich.

Rückgabewert

Name	Type	Description
personalization	Object	Personalization-Objekt.

getTriggeredInVisit

Die getTriggeredInVisit() Methode gibt alle Personalisierungen zurück, die während des aktuellen Besuchs ausgelöst wurden.

Kameleoon.API.Personalizations.getTriggeredInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

Rückgabewert

Name	Type	Description
personalizations	Array	Liste der Personalization-Objekte.

getActivatedInVisit

Die getActivatedInVisit() Methode gibt alle Personalisierungen zurück, die während des aktuellen Besuchs aktiviert wurden.

Kameleoon.API.Personalizations.getActivatedInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

Rückgabewert

Name	Type	Description
personalizations	Array	Liste der Personalization-Objekte.

trigger

Die trigger() Methode erzwingt eine Personalisierung zu triggern, indem Zielgruppen-Bedingungen umgangen werden. Diese Aktion initiiert die Personalisierung, aktiviert sie aber möglicherweise nicht.

let personalizationID = 123456;
Kameleoon.API.Personalizations.trigger(personalizationID, true);

Arguments

Name	Type	Description
personalizationID	Number	ID der Personalisierung. Dieses Feld ist erforderlich.
trackingOnly	Boolean	Setzen Sie auf true für externe Personalisierungen (Zielgruppenfestlegung oder Tracking durch Kameleoon verwaltet), um nur Tracking-Aktionen durchzuführen, ohne Variations-Assets (JS, CSS, Umleitung) auszuführen. Wenn weggelassen, wird die Methode standardmäßig auf false gesetzt.

APIs

​disable

​getActive

​getAll

​getById

​getByName

​getTriggeredInVisit

​getActivatedInVisit

​trigger

disable

getActive

getAll

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger