Este documento sirve como referencia para el objeto _satellite
del lado del cliente (también llamado objeto Adobe Experience Platform Launch) y las diversas funciones que puede realizar con él.
track
Código
_satellite.track(identifier: string [, detail: *] )
Ejemplo
_satellite.track('contact_submit', { name: 'John Doe' });
Activa todas las reglas utilizando el tipo de evento Direct Call desde la extensión principal que se ha configurado con el identificador dado. El ejemplo anterior activa todas las reglas utilizando un tipo de evento Direct Call en el que el identificador configurado es contact_submit
. También se transmite un objeto opcional que contiene información relacionada. Se puede acceder al objeto de detalle introduciendo %event.detail%
en un campo de texto en una condición o acción o event.detail
dentro del editor de código en una condición o acción Custom Code.
getVar
Código
_satellite.getVar(name: string) => *
Ejemplo
var product = _satellite.getVar('product');
Si existe un elemento de datos con un nombre que coincida, se devuelve el valor del elemento de datos. Si no existe ningún elemento de datos que coincida, se verifica si se ha establecido previamente una variable personalizada con un nombre que coincida usando _satellite.setVar()
. Si se encuentra una variable personalizada que coincida, se devuelve su valor.
Tenga en cuenta que puede utilizar la sintaxis %%
para las variables en muchos campos de formulario de la interfaz de usuario de Platform Launch, lo que reduce la necesidad de llamar a _satellite.getVar()
. Por ejemplo, al usar %product% se accede al valor del elemento de datos del producto o de la variable personalizada.
setVar
Código
_satellite.setVar(name: string, value: *)
Ejemplo
_satellite.setVar('product', 'Circuit Pro');
Establece una variable personalizada con un nombre y un valor determinados. Más adelante se puede acceder al valor de la variable mediante _satellite.getVar()
.
Si lo desea, puede configurar varias variables a la vez transmitiendo un objeto donde las claves sean nombres de variable y los valores sean los valores de variable correspondientes.
_satellite.setVar({ 'product': 'Circuit Pro', 'category': 'hobby' });
getVisitorId
Código
_satellite.getVisitorId() => Object
Ejemplo
var visitorIdInstance = _satellite.getVisitorId();
Si la extensión Adobe Experience Cloud ID está instalada en la propiedad, este método devuelve la instancia de ID de visitante. Consulte la documentación del servicio de Experience Cloud ID para obtener más información.
logger
Código
_satellite.logger.log(message: string)
_satellite.logger.info(message: string)
_satellite.logger.warn(message: string)
_satellite.logger.error(message: string)
Ejemplo
_satellite.logger.error('No product ID found.');
Registra un mensaje en la consola del explorador. El mensaje se muestra únicamente si el usuario habilita la depuración de Platform Launch (llamando a _satellite.setDebug(true)
o utilizando una extensión adecuada del explorador).
_satellite.logger.deprecation(message: string)
Ejemplo
_satellite.logger.deprecation('This method is no longer supported, plese use [new example] instead.');
Registra una advertencia en la consola del explorador. El mensaje aparece independientemente de si el usuario ha habilitado o no la depuración de Platform Launch.
cookie
Código
_satellite.cookie.set(name: string, value: string[, attributes: Object])
_satellite.cookie.get(name: string) => string
_satellite.cookie.remove(name: string)
Ejemplo
// Writing a cookie that expires in one week.
_satellite.cookie.set('product', 'Circuit Pro', { expires: 7 });
// Reading a previously set cookie.
var product = _satellite.cookie.get('product');
// Removing a previously set cookie.
_satellite.cookie.remove('product');
Utilidad para leer y escribir cookies. Es una copia expuesta de la biblioteca de terceros js-cookie. Para un uso más avanzado, consulte la documentación de uso de js-cookie (vínculo externo).
buildInfo
Código
_satellite.buildInfo
Este objeto contiene información sobre la compilación de la biblioteca de tiempo de ejecución de Platform Launch actual. El objeto contiene las siguientes propiedades:
turbineVersion
La versión de Turbine utilizada dentro de la biblioteca actual.
turbineBuildDate
La fecha ISO 8601 en que se creó la versión de Turbine utilizada dentro del contenedor.
buildDate
La fecha ISO 8601 en que se creó la biblioteca actual.
environment
El entorno para el que se creó esta biblioteca. Los valores posibles son:
Este ejemplo muestra los valores de los objetos:
{
turbineVersion: "14.0.0",
turbineBuildDate: "2016-07-01T18:10:34Z",
buildDate: "2016-03-30T16:27:10Z",
environment: "development"
}
notify
Este método se ha desaprobado. Utilice _satellite.logger.log()
en su lugar.
Código
_satellite.notify(message: string[, level: number])
Ejemplo
_satellite.notify('Hello world!');
Registra un mensaje en la consola del explorador. El mensaje se muestra únicamente si el usuario habilita la depuración de Platform Launch (llamando a _satellite.setDebug(true)
o utilizando una extensión adecuada del explorador).
Se puede transmitir un nivel de registro opcional que afecte al diseño y al filtrado del mensaje que se está registrando. Estos son los niveles compatibles:
3 - Mensajes informativos.
4 - Mensajes de advertencia.
5 - Mensajes de error.
Si no proporciona un nivel de registro ni transmite ningún otro valor de nivel, el mensaje se registra como mensaje normal.
setCookie
Este método se ha desaprobado. Utilice _satellite.cookie.set()
en su lugar.
Código
_satellite.setCookie(name: string, value: string, days: number)
Ejemplo
_satellite.setCookie('product', 'Circuit Pro', 3);
Establece una cookie en el explorador del usuario. La cookie persistirá durante el número de días especificado.
readCookie
Este método se ha desaprobado. Utilice _satellite.cookie.get()
en su lugar.
Código
_satellite.readCookie(name: string) => string
Ejemplo
var product = _satellite.readCookie('product');
Lee una cookie desde el explorador del usuario.
removeCookie
Este método se ha desaprobado. Utilice _satellite.cookie.remove()
en su lugar.
Código
_satellite.removeCookie(name: string)
Ejemplo
_satellite.removeCookie('product');
Quita una cookie del explorador del usuario.
No se debe acceder a las siguientes funciones desde el código de producción. Se han diseñado únicamente con fines de depuración y cambian con el tiempo según sea necesario.
container
Código
_satellite._container
Ejemplo
No se debe acceder a esta función desde el código de producción. Se ha diseñado únicamente con fines de depuración y cambia con el tiempo según sea necesario.
monitor
Código
_satellite._monitors
Ejemplo
No se debe acceder a esta función desde el código de producción. Se ha diseñado únicamente con fines de depuración y cambia con el tiempo según sea necesario.
Muestra
En la página web que ejecuta una biblioteca de Platform Launch, añada un fragmento de código al HTML. Normalmente, el código se coloca en la etiqueta <head>
antes de la etiqueta <script>
que carga la biblioteca de Platform Launch. Esto permite al monitor capturar los primeros eventos del sistema que se producen en la biblioteca de Platform Launch. Por ejemplo:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script>
window._satellite = window._satellite || {};
window._satellite._monitors = window._satellite._monitors || [];
window._satellite._monitors.push({
ruleTriggered: function (event) {
console.log(
'rule triggered',
event.rule
);
},
ruleCompleted: function (event) {
console.log(
'rule completed',
event.rule
);
},
ruleConditionFailed: function (event) {
console.log(
'rule condition failed',
event.rule,
event.condition
);
}
});
</script>
<script src="//assets.adobedtm.com/launch-EN5bfa516febde4b22b3e7c6f96f6b439f.min.js"
async></script>
</head>
<body>
<h1>Click me!</h1>
</body>
</html>
En la primera etiqueta de script, ya que la biblioteca Platform Launch aún no se ha cargado, se crea el objeto _satellite
inicial y se inicia una matriz _satellite._monitors
. A continuación, el script añade un objeto de monitor a esa matriz. El objeto de monitor puede especificar los siguientes métodos a los que la biblioteca de Platform Launch llama posteriormente:
ruleTriggered
Se lo llama después de que un evento desencadene una regla antes de que se hayan procesado las condiciones y acciones de la regla. El objeto de evento transmitido a ruleTriggered
contiene información sobre la regla activada.
ruleCompleted
Se lo llama después de que se haya procesado completamente una regla. En otras palabras, el evento se ha producido, todas las condiciones han transmitido y todas las acciones se han ejecutado. El objeto de evento enviado a ruleCompleted
contiene información sobre la regla que se ha completado.
ruleConditionFailed
Se lo llama después de activar una regla y de que haya fallado una de sus condiciones. El objeto de evento transmitido a ruleConditionFailed
contiene información sobre la regla activada y la condición que ha fallado.
Si se llama a ruleTriggered
, se llama a ruleCompleted
o ruleConditionFailed
poco después.
Un monitor no tiene que especificar los tres métodos (ruleTriggered
, ruleCompleted
y ruleConditionFailed
). Platform Launch funciona con los métodos compatibles con el monitor.
El ejemplo anterior especifica los tres métodos del monitor. Cuando se los llama, el monitor cierra la información relevante. Para probar esto, configure dos reglas en la biblioteca de Platform Launch:
Si abre la página en Chrome, abre la consola del explorador y selecciona la página, aparecerá lo siguiente en la consola:
Se pueden añadir nuevos enlaces o información adicional a estos controladores según sea necesario.