Kameleoon.API.Personalizations - Kameleoon Documentation

Este módulo proporciona métodos para acceder a las personalizaciones en directo.

disable

El método disable() marca una personalización como desactivada. Úselo para elementos interactivos como pop-ins. Cuando un usuario cierre el elemento, llame a disable() para actualizar el estado de la personalización. Kameleoon implementa automáticamente esta llamada para elementos nativos de la interfaz no personalizados.

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

Argumentos

Nombre	Tipo	Descripción
id	Number	Id de la personalización. Este campo es obligatorio.

getActive

El método getActive() devuelve las personalizaciones activas para la visita y página actuales. Una personalización está activa si su código de variación se ha ejecutado y la acción asociada sigue visible. Para recuperar personalizaciones disparadas en otras URL o que ahora están cerradas, como los pop-ins, use getTriggeredInVisit().

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

Valor de retorno

Nombre	Tipo	Descripción
personalizations	Array	Lista de objetos Personalization.

getAll

El método getAll() devuelve todas las personalizaciones en directo (en ejecución; no en borrador/pausadas/detenidas).

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

Valor de retorno

Nombre	Tipo	Descripción
personalizations	Array	Lista de objetos Personalization.

getById

El método getById() devuelve la personalización con el ID especificado.

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

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

Argumentos

Nombre	Tipo	Descripción
id	Number	Id de la personalización. Este campo es obligatorio.

Valor de retorno

Nombre	Tipo	Descripción
personalization	Object	Objeto Personalization.

getByName

El método getByName() devuelve la personalización con el nombre especificado.

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

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

Argumentos

Nombre	Tipo	Descripción
name	String	Nombre de la personalización. Este campo es obligatorio.

Valor de retorno

Nombre	Tipo	Descripción
personalization	Object	Objeto Personalization.

getTriggeredInVisit

El método getTriggeredInVisit() devuelve todas las personalizaciones disparadas durante la visita actual.

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

Valor de retorno

Nombre	Tipo	Descripción
personalizations	Array	Lista de objetos Personalization.

getActivatedInVisit

El método getActivatedInVisit() devuelve todas las personalizaciones activadas durante la visita actual.

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

Valor de retorno

Nombre	Tipo	Descripción
personalizations	Array	Lista de objetos Personalization.

trigger

El método trigger() fuerza el disparo de una personalización, omitiendo las condiciones de segmentación. Esta acción inicia la personalización pero puede no activarla.

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

Argumentos

Nombre	Tipo	Descripción
personalizationID	Number	ID de la personalización. Este campo es obligatorio.
trackingOnly	Boolean	Establezca en true para personalizaciones externas (segmentación o seguimiento gestionados por Kameleoon) para realizar solo acciones de tracking sin ejecutar los assets de la variación (JS, CSS, redirecciones). Si se omite, el método utiliza false por defecto.

APIs

​disable

​getActive

​getAll

​getById

​getByName

​getTriggeredInVisit

​getActivatedInVisit

​trigger

disable

getActive

getAll

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger