Skip to content

Custom service init FR

Lucien edited this page Apr 27, 2021 · 2 revisions

Service personnalisé

Nous attaquons maintenant la partie la plus intéressante, la création du service personnalisé !

Attaquons directement le vif du sujet, pour ajouter un service personnalisé ajouter ce code (après le code d'initialisation de tarteaucitron) :

tarteaucitron.services.mycustomservice = {
  "key": "mycustomservice",
  "type": "ads|analytic|api|comment|other|social|support|video",
  "name": "MyCustomService",
  "needConsent": true,
  "cookies": ['cookie', 'cookie2'],
  "readmoreLink": "/custom_read_more", // If you want to change readmore link
  "js": function () {
    "use strict";
    // Quand l'utilisateur accepte les cookies
  },
  "fallback": function () {
    "use strict";
    // Quand l'utilisateur refuse les cookies ou qu'il ne les a pas encore accepté
  }
};

(tarteaucitron.job = tarteaucitron.job || []).push('mycustomservice');

Détaillons ce code ligne par ligne :

tarteaucitron.services.mycustomservice = {

-> Cette ligne permet de déclarer le nouveau service, remplacer "mycustomservice" par un nom qui représente votre service.

"key": "mycustomservice",

-> Cette ligne permet de définir la clé du nouveau service, la clé doit être identique au nom du service indiquer précédemment.

"type": "ads|analytic|api|comment|other|social|support|video",

-> Cette ligne permet de définir le type de service que vous voulez intégrer, ne garder que celui qui représente votre service (si vous ne trouvez rien correspondant à votre service alors gardé "other").

"name": "MyCustomService",

-> Cette ligne permet de définir le nom qui sera afficher dans l'interface utilisateur.

"needConsent": true,

-> Cette ligne permet de définir si l'autorisation de l'utilisateur est obligatoire avant de charger le script (true pour être conforme au RGPD)

"cookies": ['cookie', 'cookie2'],

-> Cette ligne permet de lister les cookies enregistrer par le service afin de mettre l'information à disposition de l'utilisateur

"readmoreLink": "/custom_read_more"

--> Cette ligne optionnelle permet de changer la redirection du lien "en savoir plus" (par défaut elle redirige vers l'URL indiquer dans "readmorelink" à l'initialisation de tarteaucitron).

"js": function () {
  "use strict";
  // Quand l'utilisateur accepte les cookies
},

-> Cette fonction est lancée lorsque l'utilisateur à accepter les cookies de ce service.

"fallback": function () {
  "use strict";
  // Quand l'utilisateur refuse ou n'à pas encore accepter les cookies
}

-> Cette fonction est lancée lorsque l'utilisateur refuse les cookies ou ne les a pas encore acceptés

(tarteaucitron.job = tarteaucitron.job || []).push('mycustomservice');

-> Cette ligne permet de définir le nouveau service comme actif.

Et maintenant ?

Actuellement le code est fonctionnel, on peut activer ou non les cookies via tarteaucitron cependant même si l'utilisateur accepte les cookies aucun changement ne sont visible car la fonction prévue à cet effet est vide.

Pour savoir quoi mettre dans cette fonction référé vous à la partie Fonction - cookies autorisé


Page Prècedente - Page suivante