API

Connexion à l'API Kixell Tag

Pour interagir avec l’API Kixell Tag, utilisez le code suivant :

window.kixelltagOnReady = window.kixelltagOnReady || [];
window.kixelltagOnReady.push(function (KixellTag) {
    // Votre logique ici
});

L’API Kixell Tag permet d’écouter les événements suivants :

  • popupVisible : Indique si une popup est actuellement affichée.
  • kixelltag_consent_ready : Déclenché lorsque la CMP (Consent Management Platform) est prête.
  • kixelltag_consent_updated : Déclenché lorsque l’utilisateur modifie ses préférences de consentement.
  • kixelltag_consent_chose : Déclenché lorsque l’utilisateur a exprimé son choix de consentement.

Événement lié à la visibilité de la popup de consentement

popupVisible

L’événement popupVisible permet de gérer la visibilité des popups sur votre site. Cela inclut :

  • Obligations légales nécessitant la majorité.
  • Inscriptions à la newsletter.
  • Codes promotionnels ou engagements marketing.
  • Autres cas spécifiques.

Pour éviter le chevauchement des popups et garantir que le consentement des utilisateurs est obtenu avant d’effectuer certaines actions, il est possible d’intégrer les popups à l’API. Cela permet de vérifier à quel moment l’utilisateur a exprimé son choix de consentement.

Voici un exemple de code permettant de déterminer si la bannière de consentement est visible ou non :

Exemple :

Le code suivant permet de déterminer si la bannière de consentement est visible ou non :

window.kixelltagOnReady = window.kixelltagOnReady || [];
window.kixelltagOnReady.push(function (KixellTag) {
    KixellTag.on('popupVisible', function(isVisible) {
        console.log("PopupState: ", (isVisible ? 'visible' : 'not visible'));
        if (!isVisible) {
            // Actions à déclencher lorsque la popup n’est plus visible
        }
    });
});

Dans cet exemple, le script écoute l’événement popupVisible et exécute les actions appropriées selon l’état de visibilité de la bannière.

Événements liés au consentement

L’événement kixelltag_consent_ready est déclenché lorsque le consentement est prêt et que la CMP (bannière de consentement) est totalement initialisée. L'utilisateur a enregistré ses préférences et les états de consentement ont été assignés (Consent Mode, Chaine TC String)

Exemple :

window.kixelltagOnReady = window.kixelltagOnReady || [];
window.kixelltagOnReady.push(function (KixellTag) {
    KixellTag.on('kixelltag_consent_ready', function() {
        // Actions à effectuer une fois que le consentement est prêt
    });
});

L’événement kixelltag_consent_updated est déclenché lorsque l’utilisateur a modifié ses préférences de consentement via la CMP.

Exemple :

window.kixelltagOnReady = window.kixelltagOnReady || [];
window.kixelltagOnReady.push(function (KixellTag) {
    KixellTag.on('kixelltag_consent_updated', function() {
        // Actions à effectuer lorsque les préférences sont mises à jour
    });
});

L’événement kixelltag_consent_chose est déclenché dès que l’utilisateur a fait un choix concernant ses préférences de consentement via la CMP.

Exemple :

window.kixelltagOnReady = window.kixelltagOnReady || [];
window.kixelltagOnReady.push(function (KixellTag) {
    KixellTag.on('kixelltag_consent_chose', function() {
        // Actions à effectuer après le choix de consentement
    });
});

Pour aller plus loin avec la gestion de l'API de Kixell Tag :