Developers » AS2 tagging » JavaScript » Bien commencer » Initialisation du tracker
Initialisation du tracker
Avant-propos
Avant de commencer, vous devez télécharger notre bibliothèque JavaScript, ou bien la pousser sur notre CDN, depuis l’interface Tag Composer.
Cette dernière permet de :
- Configurer le périmètre de marquage (site, domaine utilisé pour l’écriture de cookies, etc.).
- Sélectionner les fonctionnalités désirées par le biais de plugins configurables.
Une fois la bibliothèque configurée, vous devez y faire appel dans la balise <head>
de votre page.
<!-- Local file --> <script src="smarttag.js"></script> <!-- CDN file --> <!-- File must be published on the TDN for this site within Tag Composer --> <script src="//tag.aticdn.net/YOURSITEID/smarttag.js"></script>
Initialisation
L’initialisation du Tracker se fait par l’intermédiaire de méthodes JavaScript à insérer.
<html> <head> <meta charset="UTF-8"> <title>My Page</title> <script src="smarttag.js"></script> </head> <body> ... <script type="text/javascript"> var tag = new ATInternet.Tracker.Tag(); </script> </body> </html>
Le constructeur ATInternet.Tracker.Tag() peut prendre deux objets en paramètre, un premier destiné à la surcharge de la configuration du Tracker et un deuxième destiné à l’ajout de valeurs de contexte.
Configuration
Le fichier « smarttag.js » contient la configuration définie par défaut lors de la génération dans Tag Composer. Il est possible de surcharger une partie de celle-ci en précisant le nouveau paramétrage lors de l’initialisation.
Exemple :
var tag = new ATInternet.Tracker.Tag({secure: true});
Ici, la variable de configuration « secure » a été forcée à la valeur true.
Liste des variables de configuration de base pouvant être surchargées :
- La variable
secure
permet d’envoyer les informations de manière sécurisée ou non. Préciser true dans le cas d’un protocole HTTPS et false pour un protocole HTTP. - La variable
disableCookie
, si elle est à true, permet d’empêcher l’écriture de cookies du tracker (first et third). - La variable
cookieDomain
permet de préciser le domaine pour l’écriture des cookies. Dans le cas où ce paramètre est vide (cookieDomain: ''
), le domaine de la page courante sera utilisé.
- La variable
cookieSecure
, si elle est à true, permet d’ajouter l’option ‘secure’ lors de l’écriture des cookies du tracker (first). Les cookies ‘secure’ ne fonctionnent que sur les pages HTTPS. - La variable
ignoreEmptyChapterValue
, si elle est à true, permet d’ignorer les chapitres sans valeur.
>= 5.5.0
Il existe d’autres variables de configuration mais nécessitant une connaissance avancée du Tracker (voir Annexe).
Contexte
Il est aussi possible de forcer des valeurs de contexte qui seront ajoutées et partagées entre les différents marqueurs du Tracker en fonction du type.
Exemple :
var tag = new ATInternet.Tracker.Tag({}, {'forcedCampaign': 'campaignValue'});
Ici, la valeur de campagne définie dans « forcedCampaign » sera ajoutée aux marqueurs de page du Tracker.
Liste des variables de contexte pouvant être déclarées :
- La variable
forcedCampaign
permet de déclarer et de forcer une campagne. - La variable
forcedReferer
permet de déclarer et de forcer un referer.
Marqueur basique
Voici un exemple de marqueur basique, vous permettant de mesurer une page vue portant le libellé « Page Name » :
<script type="text/javascript"> var ATTag = new ATInternet.Tracker.Tag(); ATTag.page.send({name:'Page_Name'}); </script>
Annexe
Variables de configuration pouvant être surchargées :
Nom | Valeur par défaut | Description | Version |
---|---|---|---|
secure | false | Forcer le mode d’envoi sécurisé (HTTPS) | < 5.19.0 |
disableCookie | false | Empêcher l’écriture de cookies du tracker (first et third) | – |
cookieDomain | Valeur renseignée dans TagComposer | Domaine pour l’écriture des cookies. Si ce paramètre est vide (cookieDomain: '' ), le domaine de la page courante sera utilisé | – |
cookieSecure | false | Ajouter l’option ‘secure’ lors de l’écriture des cookies du tracker (first) | >= 5.5.0 |
ignoreEmptyChapterValue | true | Ignorer les chapitres sans valeur | >= 5.5.0 |
site | Valeur renseignée dans TagComposer | Numéro de site | – |
log | Valeur renseignée dans TagComposer | Sous-domaine du collecteur AT Internet. Déprécié depuis 5.13.0, voir collectDomain | < 5.13.0 |
logSSL | Valeur renseignée dans TagComposer | Sous-domaine du collecteur sécurisé (HTTPS) AT Internet. Déprécié depuis 5.13.0, voir collectDomainSSL | < 5.13.0 |
domain | Valeur renseignée dans TagComposer | Domaine de l’url des hits. Déprécié depuis 5.13.0, voir collectDomain | < 5.13.0 |
pixelPath | /hit.xiti | Chemin vers le fichier du pixel pour les hits | – |
preview | false | Forcer l’envoi des hits de page dans le cas d’un chargement en mode preview sur le navigateur Safari (true : mesure activée, false : mesure désactivée) | – |
collectDomain | Valeur renseignée dans TagComposer | Domaine de collecte des données | >= 5.13.0 |
collectDomainSSL | Valeur renseignée dans TagComposer | Domaine de collecte sécurisé des données | >= 5.13.0 |
sendHitWhenOptOut | Valeur renseignée dans TagComposer | Permet l’envoi de hits anonymisés lorsque l’utilisateur est en « OPT-OUT » (first party) | >= 5.14.0 |
forceHttp | false | Forcer l’envoi des hits sur le protocole HTTP. Depuis la version 5.19.0, les hits sont automatiquement envoyés en HTTPS. Requiert l’utilisation d’un identifiant visiteur client-side (les cookies server-side ne sont déposés qu’en HTTPS). | >= 5.19.0 |
maxHitSize | 2000 | Nombre de caractères maximum d’un hit. Au-delà, le hit sera découpé (multi-hits) | >= 5.19.0 |
requestMethod | GET | Méthode HTTP utilisée pour l’envoi des hits. ‘GET’ ou ‘POST’ | >= 5.19.0 |
urlPropertyAuto | Valeur renseignée dans TagComposer | Si activée, ajout automatique d’une propriété contenant l’URL de la page | >= 5.27.0 |
urlPropertyQueryString | Valeur renseignée dans TagComposer | Si activée et urlPropertyAuto activée, ajout de la Querystring à la propriété contenant l’URL de la page | >= 5.27.0 |
sameSiteStrict | false | Si activé, ajoute le flag SameSite=Strict aux cookies client-side | >= 5.28.2 |