LogoLogo
Analytics HelperSirdata APISemantic APIA propos de Sirdata
Français
Français
  • Sirdata CMP
  • INSTALLATION
    • Web & Web Mobile
    • AMP
    • Via un Tag Manager
      • Chargement via Google Tag Manager
    • Dans un CMS
      • Chargement dans Shopify
      • Chargement dans Shopify avec l'application
      • Chargement dans Wordpress
      • Chargement dans Joomla
      • Chargement dans Prestashop
      • Chargement dans Magento
      • Chargement dans Drupal
      • Chargement dans Wix
    • Exclusion des systèmes de cache
      • Plugin Autoptimize plour WordPress
      • Plugin Cloudflare pour WordPress
      • Plugin LiteSpeed pour WordPress
      • Plugin NitroPack pour WordPress
      • Plugin SG Optimizer pour WordPress
      • Plugin WP Super Cache pour WordPress
      • Plugin W3 Total Cache pour WordPress
      • Plugin WP Meteor pour Wordpress
      • Plugin WP Rocket pour WordPress
  • STANDARDS DE TRANSMISSION DU CONSENTEMENT
    • Introduction
    • Google Consent Mode
      • Préalable Obligatoire
      • Activation du Google Consent Mode Avancé
        • Via la CMP Sirdata
        • Via Google Tag Manager
      • Activation du Google Consent Mode Basique
        • Via la CMP Sirdata
        • Via Google Tag Manager
      • Vérification du Google Consent Mode V2 sur un site
    • Microsoft UET Consent Mode
    • Microsoft Clarity Consent
  • CMP API
    • Fonctionnement
    • Exemples
    • Support pour les iframes
  • Fonctionnalités avancées
    • Mode passif
    • Définir la langue pour un utilisateur
    • Affichage manuel de la CMP
  • Gestion des scripts
    • Conditionnement d'un script distant hors Tag Manager
    • Conditionnement d'un script distant via un Tag Manager
    • Conditionnement d'un script via Google Tag Manager
    • Conditionnement d'un script local
    • Configuration avancée
    • Exemples
    • Transmission de la TC String
    • Prestations de conditionnement
  • Analytics
    • Exemption
    • AT Internet
    • Google Analytics
  • F.A.Q. CMP
    • Google Consent Mode V2
      • Utilité Google Consent Mode V2
      • Nouveautés Google Consent Mode V2
      • Mode avancé ou mode basique
    • Conditionnement
      • Conditionnement des tags
      • Gestion des cookies
      • Conditionnement des partenaires non membres du TCF
      • Gestion des scripts
      • Sous traiter les conditionnements
      • Identification des cookies
      • Cookies exemptés
      • Consentement pour Captcha
    • Fonctionnement
      • Navigation privée
      • "Refus" et publicités ciblées
      • Mozilla et blocage des pubs
      • Vérification du chargement de la CMP
      • Gestion du consentement selon les pays
      • Taille du script
    • Gestion des partenaires
      • Recherche des partenaires
      • Ajout d'un partenaire
      • Trouver mes partenaires
    • Google
      • Erreurs Google
      • Publicités Google
      • Google PageSpeed
      • Conditionnement de Google Analytics
      • Modules complémentaires Google
      • Perte de statistiques
      • Alerte Google Ads
      • Problème gclid google
    • Intégration
      • ABConsent est-il compatible avec Stape ?
      • Multi-sites
      • Shopify
      • Intégration via GTM
      • Installation de la CMP
      • Intégration du lien « Paramètres cookies »
      • Comment vérifier l’intégration de ma CMP
      • Intégration Utiq
    • Légal
      • Audit de conformité
      • Mécanique de refus
      • TCF V2.2
      • Cookie-wall
      • Site étranger
      • Une CMP, et après ?
      • Contrôle
      • Conformité juridique mondiale
    • Mobile
      • Mobiles, tablettes ...
      • Affichage mobile
    • Paramétrage
      • Fonctionnement des boutons
      • Paramètres cookies
      • Couleur bouton
      • Tests A/B
      • Optimisation du taux de consentement
      • Personnalisation de la CMP
    • Statistiques
      • Accès aux statistiques
      • Volume de hits
    • Stockage
      • Récupérer les preuves de consentement
    • Tarifs
      • Les deux types de licences
      • Que se passe-t-il lorsque j'atteins le palier de mon forfait mensuel ?
      • Proposez-vous une période d'essai ?
      • Quels sont les modes de paiement acceptés
      • Proposez-vous des forfaits pour des volumes de hits très élevés ?
      • Les hits non utilisés sont-ils reportés au mois suivant ?
      • Qu'est-ce qui est considéré comme un hit
      • Puis-je passer d’une licence payante à une licence financée par la collecte de données ?
      • Où puis-je consulter les statistiques de consentement et le volume de Hits de ma CMP ?
    • AMP
      • Consentement sur AMP
      • Bouton CMP sur AMP
    • Gestion du compte
      • Gestion des accès
      • Informations de facturation
      • Ajouter un moyen de paiement
    • Content Security Policy (CSP)
    • Comment identifier les cookies présents sur mon site ?
    • ABConsent est-il compatible avec Addingwell ?
    • ABConsent est-il compatible avec Taggr ?
  • Prestations CMP
    • Configuration CMP
    • Intégration CMP
    • Conditionnement des tags
    • Audit de conformité
    • Extra-Vendorlist
    • Vidéo-Wall
    • Inventaire Partenaires
    • Consulting
  • Liens
    • Configurez votre CMP
    • Analytics Helper
    • Sirdata API
    • Semantic API
    • A propos de Sirdata
Propulsé par GitBook
Sur cette page
  • PingReturn
  • TCData
  • GlobalVendorList
  • Evènements

Cet article vous a-t-il été utile ?

  1. CMP API

Fonctionnement

Dans cette section, vous trouverez les commandes JavaScript vous permettant d'interagir avec la CMP sur votre site.

PrécédentMicrosoft Clarity ConsentSuivantExemples

Dernière mise à jour il y a 4 mois

Cet article vous a-t-il été utile ?

Toutes les commandes sont exécutables à travers la fonction API __sdcmpapi et Sirdata CMP fournit une liste de commandes standards décrites dans l'

Si vous utilisez une version compatible avec le Transparency and Consent Framework/TCF (c'est le cas par défaut), les commandes sont alors également exécutables à travers la fonction API __tcfapi.

window.__sdcmpapi(command, version, callback, parameter);
window.__tcfapi(command, version, callback, parameter);

Le paramètre version correspond à la version de la spécification TCF (= 2).

COMMANDE

CALLBACK

PARAMETRE

DESCRIPTION

ping

function(PingReturn, success)

-

Renvoie des informations sur le statut de chargement de la CMP et le mode d'application du RGPD configuré.

revokeUtiq

function(success)

-

Retire le consentement existant pour le partenaire Utiq et la finalité associée. Le signal associée et l'UI de la CMP (en cas de réaffichage) sont mis à jour. Renvoie true si Utiq et la finalité associée font partie du paramétrage de la CMP, et false sinon.

getVendorList

function(GlobalVendorList, success)

vendorListVersion (int) - optionnel Version de la Global Vendor List à récupérer. Si elle n'est pas renseignée, la version utilisée par Sirdata CMP sera renvoyée. Si la valeur est LATEST, la dernière version disponible sera renvoyée. Si la valeur est invalide, GlobalVendorList sera nul et success sera false.

Renvoie la Global Vendor List contenant les finalités et les partenaires participant au Transparency & Consent Framework.

addEventListener

function(TCData, success)

-

removeEventListener

function(success)

listenerId (int) ID du listener à supprimer.

Supprime un listener précédemment ajouté avec la commande addEventListener.

PingReturn

{
    gdprApplies: *Boolean*,
    cmpLoaded: *Boolean*,
    cmpStatus: *String*,
    displayStatus: *String*,
    apiVersion: '2.0',
    cmpVersion: *Integer*,
    cmpId: *Integer*,
    gvlVersion: *Integer*,
    tcfPolicyVersion: *Integer*
}

TCData

{
    tcString: [base64url-encoded] *String*,
    addtlConsent: *String*,
    tcfPolicyVersion: *Integer*,
    cmpId: *Integer*,
    cmpVersion: *Integer*,
    gdprApplies: *Boolean*,
    eventStatus: *String*,
    cmpStatus: *String*,
    isServiceSpecific: *Boolean*,
    useNonStandardStacks: *Boolean*,
    publisherCC: *String*,
    purposeOneTreatment: *Boolean*,
    outOfBand: {
        allowedVendors: {
            *vendorId*: *Boolean*,
            ?
        },
        disclosedVendors: {
            *vendorId*: *Boolean*,
            ?
        }
    },
    purpose: {
        consents: {
            *purposeId*: *Boolean*,
            ?
        },
        legitimateInterests: {
            *purposeId*: *Boolean*,
            ?
        }
    },
    vendor: {
        consents: {
            *vendorId* : *Boolean*,
            ?
        },
        legitimateInterests: {
            *vendorId* : *Boolean*,
            ?
        }
    },
    specialFeatureOptins: {
        *specialFeatureId*: *Boolean*,
        ?
    },
    publisher: {
        consents: {
            *purposeId*: *Boolean*,
            ?
        },
        legitimateInterests: {
            *purposeId*: *Boolean*,
            ?
        },
        customPurpose: {
            consents: {
                *customPurposeId*: *Boolean*,
                ?
            },
            legitimateInterests: {
                *customPurposeId*: *Boolean*,
                ?
            }
        },
        restrictions: {
            *purposeId*: {
                *vendorId* : *Integer*,
                ?
            },
            ?
        }
    }
}

GlobalVendorList

{
    gvlSpecificationVersion: *Integer*,
    vendorListVersion: *Integer*,
    tcfPolicyVersion: *Integer*,
    lastUpdated: *String*,
    purposes: {
        *purposeId*: {
            id: *Integer*,
            name: *String*,
            description: *String*,
            descriptionLegal: *String*,
        },
        ?
    },
    specialPurposes: {
        *specialPurposeId*: {
            id: *Integer*,
            name: *String*,
            description: *String*,
            descriptionLegal: *String*,
        },
        ?
    },
    features: {
        *featureId*: {
            id: *Integer*,
            name: *String*,
            description: *String*,
            descriptionLegal: *String*,
        },
        ?
    },
    specialFeatures: {
        *specialFeatureId*: {
            id: *Integer*,
            name: *String*,
            description: *String*,
            descriptionLegal: *String*,
        },
        ?
    },
    stacks: {
        *stackId*: {
            id: *Integer*,
            name: *String*,
            description: *String*,
            purposes: [
                *Integer*,
                ?
            ],
            specialFeatures: [
                *Integer*,
                ?
            ],
        },
        ?
    },
    vendors: {
        *vendorId*: {
        {
            id: *Integer*,
            name: *String*,
            purposes: [
                *Integer*,
                ?
            ],
            legIntPurposes: [
                *Integer*,
                ?
            ],
            flexiblePurposes: [
                *Integer*,
                ?
            ],
            specialPurposes: [
                *Integer*,
                ?
            ],
            features: [
                *Integer*,
                ?
            ],
            specialFeatures: [
                *Integer*,
                ?
            ],
            policyUrl: *String*,
            usesCookies: *Boolean*,
            cookieMaxAgeSeconds: *Integer*,            
            usesNonCookieAccess: *Boolean*,
            deviceStorageDisclosureUrl: *String*
        },
        ?
    }
}

Evènements

Vous trouverez dans le tableau ci-dessous la liste des évènements qui peuvent être déclenchés par la CMP :

EVENEMENT

DESCRIPTION

tcloaded

Cet évènement se déclenche lorsque la CMP est chargée, qu'une TC String valide est disponible et que l'UI n'est pas affichée.

cmpuishown

Cet évènement se déclenche lorsque l'UI est affichée ou ré-affichée. S'il n'y a pas de TC String existante pour l'utilisateur, la CMP crée une TC String avec tous les signaux d'intérêt légitime définis à true et tous les signaux de consentement définis à false.

useractioncomplete

Cet évènement se déclenche lorsqu'un utilisateur valide ou re-valide ses choix et que la TC String mise à jour est prête à être exposée.

cmpuiclosed

Cet évènement se déclenche lorsqu'un utilisateur ferme l'UI affichée en cliquant sur le bouton fermer (si activé) et donc que la TC String courante est inchangée par la CMP.

Ajoute une fonction JavaScript à appeler avec les TC Data lorsqu'un évènement CMP se produit.

IAB Tech Lab CMP JavaScript API
Voir la liste des évènements