Ce document sert de référence à l'objet _satellite
côté client (également appelé objet Adobe Experience Platform Launch) et aux différentes fonctions que vous pouvez exécuter avec lui.
track
Code
_satellite.track(identifier: string [, detail: *] )
Exemple
_satellite.track('contact_submit', { name: 'John Doe' });
Déclenche toutes les règles à l’aide du type d’événement Direct Call (Appel direct) de l’extension Core qui a été configuré à l’aide de l’identifiant donné. L’exemple ci-dessus déclenche toutes les règles à l’aide d’un type d’événement Direct Call (Appel direct) dans lequel l’identifiant configuré est contact_submit
. Un objet facultatif contenant des informations connexes est également transmis. Vous pouvez accéder à l’objet de détail en saisissant %event.detail%
dans un champ de texte d’une condition ou d’une action ou event.detail
dans l’éditeur de code d’une condition ou d’une action Custom Code (Code personnalisé).
getVar
Code
_satellite.getVar(name: string) => *
Exemple
var product = _satellite.getVar('product');
S’il existe un élément de données avec un nom correspondant, la valeur de l’élément de données va être renvoyée. S’il n’existe aucun élément de données correspondant, il vérifie alors si une variable personnalisée avec un nom correspondant a été précédemment définie à l’aide de _satellite.setVar()
. Si une variable personnalisée correspondante est trouvée, sa valeur va être renvoyée.
Notez que dans de nombreux champs de formulaire de l’interface utilisateur de Platform Launch, vous pouvez utiliser la syntaxe %%
pour référencer des variables, ce qui réduit la nécessité d’invoquer _satellite.getVar()
. Par exemple, l’utilisation de %product% donne accès à la valeur de l’élément de données du produit ou de la variable personnalisée.
setVar
Code
_satellite.setVar(name: string, value: *)
Exemple
_satellite.setVar('product', 'Circuit Pro');
Définit une variable personnalisée avec un nom et une valeur donnés. Il est possible d’accéder ultérieurement à la valeur de la variable à l’aide de _satellite.getVar()
.
Vous pouvez éventuellement définir plusieurs variables à la fois en transmettant un objet où les clés sont des noms de variable et où les valeurs sont les valeurs de variable correspondantes.
_satellite.setVar({ 'product': 'Circuit Pro', 'category': 'hobby' });
getVisitorId
Code
_satellite.getVisitorId() => Object
Exemple
var visitorIdInstance = _satellite.getVisitorId();
Si l’extension Adobe Experience Cloud ID est installée sur la propriété, cette méthode renvoie l’instance d’identifiant visiteur. Pour plus d’informations, consultez la documentation du service Experience Cloud ID.
logger
Code
_satellite.logger.log(message: string)
_satellite.logger.info(message: string)
_satellite.logger.warn(message: string)
_satellite.logger.error(message: string)
Exemple
_satellite.logger.error('No product ID found.');
Enregistre un message sur la console du navigateur. Le message ne s’affiche que si le débogage de Platform Launch est activé par l’utilisateur (en appelant _satellite.setDebug(true)
ou en utilisant une extension de navigateur appropriée).
_satellite.logger.deprecation(message: string)
Exemple
_satellite.logger.deprecation('This method is no longer supported, plese use [new example] instead.');
Consigne un message d’avertissement dans la console du navigateur. Le message s’affiche et ce, que le débogage Platform Launch soit activé ou non par l’utilisateur.
cookie
Code
_satellite.cookie.set(name: string, value: string[, attributes: Object])
_satellite.cookie.get(name: string) => string
_satellite.cookie.remove(name: string)
Exemple
// 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');
Utilitaire permettant de lire et d’écrire des cookies. Il s’agit d’une copie exposée du cookie-js de bibliothèque tiers. Pour une utilisation plus poussée, consultez la documentation sur l’utilisation de js-cookie (lien externe).
buildInfo
Code
_satellite.buildInfo
Cet objet contient des informations sur la création de la bibliothèque Runtime Platform Launch actuelle. L’objet contient les propriétés suivantes :
turbineVersion
Version de Turbine utilisée dans la bibliothèque actuelle.
turbineBuildDate
Date ISO 8601 de création de la version de Turbine utilisée dans le conteneur.
buildDate
Date ISO 8601 de la création de la bibliothèque actuelle.
environment
Environnement pour lequel cette bibliothèque a été créée. Les valeurs possibles sont les suivantes :
Cet exemple illustre les valeurs d’objet :
{
turbineVersion: "14.0.0",
turbineBuildDate: "2016-07-01T18:10:34Z",
buildDate: "2016-03-30T16:27:10Z",
environment: "development"
}
notify
Cette méthode a été abandonnée. Veuillez plutôt utiliser _satellite.logger.log()
.
Code
_satellite.notify(message: string[, level: number])
Exemple
_satellite.notify('Hello world!');
Enregistre un message sur la console du navigateur. Le message ne s’affiche que si le débogage de Platform Launch est activé par l’utilisateur (en appelant _satellite.setDebug(true)
ou en utilisant une extension de navigateur appropriée).
Un niveau de journalisation facultatif peut être transmis, ce qui va affecter la stylisation et le filtrage du message enregistré. Les niveaux pris en charge sont les suivants :
3 - Messages d’information.
4 - Messages d’avertissement.
5 - Messages d’erreur.
Si vous ne fournissez pas de niveau de journalisation ou que vous transmettez une autre valeur de niveau, le message sera consigné en tant que message ordinaire.
setCookie
Cette méthode a été abandonnée. Veuillez plutôt utiliser _satellite.cookie.set()
.
Code
_satellite.setCookie(name: string, value: string, days: number)
Exemple
_satellite.setCookie('product', 'Circuit Pro', 3);
Configure un cookie dans le navigateur de l’utilisateur. Le cookie persistera pendant le nombre de jours spécifié.
readCookie
Cette méthode a été abandonnée. Veuillez plutôt utiliser _satellite.cookie.get()
.
Code
_satellite.readCookie(name: string) => string
Exemple
var product = _satellite.readCookie('product');
Lit un cookie à partir du navigateur de l’utilisateur.
removeCookie
Cette méthode a été abandonnée. Veuillez plutôt utiliser _satellite.cookie.remove()
.
Code
_satellite.removeCookie(name: string)
Exemple
_satellite.removeCookie('product');
Supprime un cookie du navigateur de l’utilisateur.
Les fonctions suivantes ne doivent pas être accessibles à partir du code de production. Elles sont uniquement destinées à des fins de débogage et changeront au fil du temps, selon les besoins.
container
Code
_satellite._container
Exemple
Cette fonction ne doit pas être accessible à partir du code de production. Elle est uniquement destinée à des fins de débogage et changera au fil du temps, selon les besoins.
monitor
Code
_satellite._monitors
Exemple
Cette fonction ne doit pas être accessible à partir du code de production. Elle est uniquement destinée à des fins de débogage et changera au fil du temps, selon les besoins.
Exemple
Sur votre page web exécutant une bibliothèque Platform Launch, ajoutez un fragment de code à votre code HTML. En règle générale, le code est placé dans la balise <head>
avant la balise <script>
qui charge la bibliothèque Platform Launch. Cela permet au moniteur de capturer les premiers événements système qui surviennent dans la bibliothèque Platform Launch. Par exemple :
<!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>
Dans la première balise de script, puisque la bibliothèque Platform Launch n’a pas encore été chargée, l’objet _satellite
initial est créé et un tableau sur _satellite._monitors
est initialisé. Le script ajoute ensuite un objet de moniteur à ce tableau. L’objet de moniteur peut spécifier les méthodes suivantes, qui seront ensuite appelées par la bibliothèque Platform Launch :
ruleTriggered
Appelé après qu’un événement déclenche une règle, mais avant que les conditions et actions de la règle ne soient traitées. L’objet d’événement transmis à ruleTriggered
contient des informations sur la règle déclenchée.
ruleCompleted
Appelé après le traitement complet d’une règle. En d’autres termes, l’événement est survenu, toutes les conditions ont été satisfaites et toutes les actions ont été exécutées. L’objet d’événement transmis à ruleCompleted
contient des informations sur la règle qui a abouti.
ruleConditionFailed
Appelé après le déclenchement d’une règle et l’échec de l’une de ses conditions. L’objet d’événement transmis à ruleConditionFailed
contient des informations sur la règle déclenchée et la condition qui a échoué.
Si ruleTriggered
est appelé, ruleCompleted
ou ruleConditionFailed
sera appelé peu de temps après.
Un moniteur n’a pas besoin de spécifier les trois méthodes (ruleTriggered
, ruleCompleted
et ruleConditionFailed
). Platform Launch fonctionne avec les méthodes prises en charge fournies par le moniteur.
L’exemple ci-dessus indique les trois méthodes du moniteur. Lorsqu’elles sont appelées, le moniteur déconnecte les informations pertinentes. Pour tester ce paramètre, configurez deux règles dans la bibliothèque Platform Launch :
Si vous ouvrez la page dans Chrome, ouvrez la console du navigateur et cliquez sur la page, afin que les éléments suivants apparaissent dans la console :
Il est possible d’ajouter des Hooks ou des informations supplémentaires à ces gestionnaires, si nécessaire.