Kameleoon.API.Personalizations - Kameleoon Documentation

Ce module fournit des méthodes pour accéder aux personnalisations en direct.

disable

La méthode disable() marque une personnalisation comme désactivée. Utilisez ceci pour les éléments interactifs comme les fenêtres contextuelles. Lorsqu’un utilisateur ferme l’élément, appelez disable() pour mettre à jour le statut de la personnalisation. Kameleoon implémente automatiquement cet appel pour les éléments d’interface natifs et non personnalisés.

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

Arguments

Name	Type	Description
id	Number	Id de la personnalisation. Ce champ est obligatoire.

getActive

La méthode getActive() retourne les personnalisations actives pour la visite et la page. Une personnalisation est active si son code de variation s’est exécuté et que l’action associée reste visible. Pour récupérer les personnalisations qui se sont déclenchées sur d’autres URL ou qui sont maintenant fermées, tel que les fenêtres contextuelles, utilisez getTriggeredInVisit().

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

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des objets Personalization.

getAll

La méthode getAll() retourne toutes les personnalisations actives (en cours, pas brouillon/pause/arrêtée).

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

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des objets Personalization.

getById

La méthode getById() retourne la personnalisation pour l’ID spécifié.

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

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

Arguments

Name	Type	Description
id	Number	Id de la personnalisation. Ce champ est obligatoire.

Valeur de retour

Name	Type	Description
personalization	Object	Objet Personalization.

getByName

La méthode getByName() retourne la personnalisation pour le nom spécifié.

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

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

Arguments

Name	Type	Description
name	String	Nom de la personnalisation. Ce champ est obligatoire.

Valeur de retour

Name	Type	Description
personalization	Object	Objet Personalization.

getTriggeredInVisit

La méthode getTriggeredInVisit() retourne toutes les personnalisations déclenchées durant la visite actuelle.

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

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des objets Personalization.

getActivatedInVisit

La méthode getActivatedInVisit() retourne toutes les personnalisations activées durant la visite actuelle.

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

Valeur de retour

Name	Type	Description
personalizations	Array	Liste des objets Personalization.

trigger

La méthode trigger() force une personnalisation à se déclencher, en contournant les conditions de segment de ciblage. Cette action lance la personnalisation mais pourrait ne pas l’activer.

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

Arguments

Name	Type	Description
personalizationID	Number	ID de la personnalisation. Ce champ est obligatoire.
trackingOnly	Boolean	Définir sur true pour les personnalisations externes (ciblage ou suivi géré par Kameleoon) pour effectuer uniquement des actions de suivi sans exécuter les actifs de variation (JS, CSS, redirections). Si omis, la méthode par défaut est false.

APIs

​disable

​getActive

​getAll

​getById

​getByName

​getTriggeredInVisit

​getActivatedInVisit

​trigger

disable

getActive

getAll

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger