Logo Logo
Cookiebot

Vous trouverez ci-dessous des informations techniques avancées, principalement destinées aux développeurs. Si vous cherchez notre guide d'implémentation par défaut sur la façon de démarrer avec Cookiebot, vous pouvez le trouver ici.

Sur cette page, vous trouverez notre documentation sur le kit de développement logiciel (SDK) permettant de créer des implémentations personnalisées des bannières et du contrôle des cookies. Ainsi que les options pour la substitution manuelle des mécanismes automatisés de notre bannière de consentement aux cookies.

Pour que le SDK ci-dessous fonctionne, le script Cookiebot doit être implémenté sur votre site web. 

Chargez le script de consentement du cookie via:

https://consent.cookiebot.com/uc.js?cbid=00000000-0000-0000-0000-000000000000

Ou:

https://consent.cookiebot.com/uc.js

(avec l’attribut data-cbid='00000000-0000-0000-0000-000000000000')

N'oubliez pas de remplacer 00000000-0000-0000-0000-00000000000000 par votre propre ID de groupe de domaines se trouvant sous « Vos scripts » sur votre compte Cookiebot. 

Le script Cookiebot charge et construit un objet JavaScript côté client nommé « Cookiebot » qui expose les propriétés publiques, méthodes, événements et fonctions de rappel suivants. 

Propriétés


Nom Type Par défaut Description
consent.necessary bool true Vrai si l'utilisateur actuel a accepté les cookies nécessaires. Propriété en lecture seule.
consent.preferences bool false Vrai si l'utilisateur actuel a accepté les cookies de préférences. Propriété en lecture seule.
consent.statistics bool false Vrai si l'utilisateur actuel a accepté les cookies statistiques. Propriété en lecture seule.
consent.marketing bool false Vrai si l'utilisateur actuel a accepté les cookies marketing. Propriété en lecture seule.
consented bool false Vrai si l'utilisateur a accepté les cookies. Propriété en lecture seule.
declined bool false Vrai si l'utilisateur a refusé l'utilisation des cookies. Propriété en lecture seule.
hasResponse bool false Vrai si l'utilisateur a répondu "J'accepte" ou "Je n'accepte pas" dans la boîte de dialogue. Propriété en lecture seule.
doNotTrack bool false Vrai si l'utilisateur a activé le paramètre "Do not track" (DNT) dans le navigateur. Si DNT est activé, le cookie tiers CookieConsentBulkTicket utilisé pour le consentement en bloc ne sera pas installé par Cookiebot. Propriété en lecture seule.

Méthodes


Nom Paramètres Description
show Aucun Force l'affichage de la boîte de dialogue de consentement aux cookies.
hide Aucun Affiche la boîte de dialogue de consentement aux cookies sur le site Web utilisateur pour renouveler ou modifier l'état du consentement de l'utilisateur.
getScript string URL,
bool async,
func callback
Charge un fichier Javascript. URL : chemin d'accès absolu vers le fichier Javascript.
async (Optionnel): Détermine si le script devrait se charger de manière asynchrone.
callback (Optionnel): Fonction JavaScript à exécuter lorsque le script a fini de se charger.
runScripts Aucun Évalue toutes les balises de scripts chargés de type "text/plain" avec l'attribut "data-cookieconsent" et exécute les scripts conformément à l'état de consentement de l'utilisateur. À utiliser pour les sites Web dont le contenu est chargé de façon dynamique, p. ex. les applications de page unique. Les scripts n'étant exécutés qu'une seule fois, cette fonction peut être appelée plusieurs fois en toute sécurité, notamment chaque fois qu'un nouveau contenu est chargé.
withdraw Aucun Supprimer mon accord pour ce site.
submitCustomConsent bool optinPreferences,
bool optinStatistics,
bool optinMarketing
Soumettez votre consentement via javascript. Cela peut être utile si vous souhaitez utiliser une bannière personnalisée.

Exemple de valeur: Créer un lien permettant à l'utilisateur de modifier ou de renouveler le consentement aux cookies

<a href="javascript: Cookiebot.renew()">Renouveler ou modifier votre consentement aux cookies</a>

Gestion d'événement


Nom Description
CookiebotOnLoad L'événement est déclenché lorsque la bannière du cookie a été chargée pour obtenir le consentement de l'utilisateur.
CookiebotOnAccept L'événement se déclenche si l'utilisateur accepte l'usage des cookies. Il se déclenche également si l'utilisateur a donné son consentement lors d'une visite précédente.
CookiebotOnDecline L'événement se déclenche si l'utilisateur refuse l'usage des cookies en cliquant sur le bouton de refus dans la boîte de dialogue de consentement. L'événement se déclenche également si l'utilisateur a déjà refusé cet usage lors d'une visite précédente.
CookiebotOnDialogInit Se déclenche lorsque la bannière de consentement des cookies est initialisée, avant de compiler le contenu de la bannière.
CookiebotOnDialogDisplay Se déclenche lorsque la bannière de consentement des cookies est affichée pour l'utilisateur final.
CookiebotOnTagsExecuted Se déclenche lorsque des balises marquées pour un consentement préalable (par exemple, l'attribut "data-cookieconsent") ont été déclenchées.

Exemple de valeur: Charger des cookies marketing si l'utilisateur a accepté

<script type="text/javascript">

      window.addEventListener('CookiebotOnAccept', function (e) {
      if (Cookiebot.consent.marketing)
          {
          //Execute code that sets marketing cookies
          }
      }, false);
</script>

Rappels


Nom Description
CookiebotCallback_OnLoad Le rappel asynchrone est déclenché lorsque la bannière du cookie a été chargée pour obtenir le consentement de l'utilisateur.
CookiebotCallback_OnAccept Le rappel asynchrone se déclenche lorsque l'utilisateur clique sur le bouton d'acceptation dans la boîte de dialogue de consentement aux cookies et chaque fois qu'un utilisateur ayant donné son consentement charge une page.
CookiebotCallback_OnDecline Le rappel asynchrone se déclenche lorsque l'utilisateur refuse l'utilisation des cookies en cliquant sur le bouton de refus dans la boîte de dialogue de consentement aux cookies. Le rappel se déclenche également chaque fois qu'un utilisateur ayant refusé l'utilisation des cookies charge une page.
CookiebotCallback_OnDialogInit Se déclenche lorsque la bannière de consentement des cookies est initialisée, avant de compiler le contenu de la bannière.
CookiebotCallback_OnDialogDisplay Se déclenche lorsque la bannière de consentement des cookies est affichée pour l'utilisateur final.
CookiebotCallback_OnTagsExecuted Se déclenche lorsque des balises marquées pour un consentement préalable (par exemple, l'attribut "data-cookieconsent") ont été déclenchées.

Exemple de valeur: Charger les cookies de statistiques si l'utilisateur les a choisis


Veuillez noter que cet exemple est pertinent uniquement si vous n’avez pas défini le data-blockingmode sur "auto" et si vous n’avez pas balisé votre script pour le contrôle avec data-cookieconsent.

<script type="text/javascript">

     function CookiebotCallback_OnAccept() {

           if (Cookiebot.consent.statistics)            

{      

enableStatisticsCookies();              

}

}

function enableStatisticsCookies() {  

          //Exécuter le code qui installe des cookies de statistiques 

        }  

</script>

Attributs des données de balise du script


Nom Type Obligatoire Description
data-cbid string oui L'identifient unique de votre groupe de domaines Cookiebot.
data-type string non Remplace le type de boîte de dialogue par défaut par l'une des valeurs suivantes :
"optin", "optout", "optinout", "leveloptin", "inlineoptin"
data-level string non Remplace la méthode de consentement par défaut par l'une des valeurs suivantes : "implicite", "explicite"
data-culture string non Pour forcer une variante de langue spécifique dans la boîte de dialogue, définissez la valeur de cet attribut selon un code de langue neutre ISO 639-1, par exemple "EN" pour l'anglais. La définition de cet attribut avec une langue valide remplace le paramètre "Détection automatique de la langue de l'utilisateur" dans le gestionnaire Cookiebot.
data-framework string non Permet à Cookiebot de signifier le consentement à d'autres cadres de consentement mis en œuvre sur un site Web - en plus du cadre de consentement standard contenu dans Cookiebot. La valeur de l'attribut doit correspondre à l'abréviation du cadre externe. Actuellement, les cadres de consentement de tierces parties suivants sont pris en charge : Abréviation "IAB" : IAB Europe Transparent & Consent Framework
data-blockingmode string non Définit si Cookiebot doit automatiquement bloquer tous les cookies jusqu'à ce qu'un utilisateur y consente, valeur : "auto". Si ce n'est pas le cas (valeur : "none"), les scripts de configuration des cookies doivent être manuellement balisés comme décrit dans notre guide d'implémentation manuelle. Si vous omettez cet attribut, le comportement sera égal à la valeur : "none".

Exemple de valeur: Forcer l'affichage en anglais de la boîte de dialogue de consentement

<script id="Cookiebot" data-culture="EN" src="https://consent.cookiebot.com/uc.js" data-cbid="00000000-0000-0000-0000-000000000000" type="text/javascript"></script>

Utilisation côté serveur


Si des cookies sont paramétrés côté serveur par votre site Web, vous pouvez déterminer le type de cookies que vous êtes autorisé à installer en vérifiant le statut de consentement actuel des utilisateurs via la gestion standard des cookies.

using System.Web.Script.Serialization;
...
HttpCookie CurrentUserConsent = Request.Cookies["CookieConsent"];
if (CurrentUserConsent != null)
{
       switch (CurrentUserConsent.Value)
       {
              case "-1":
                    //L'utilisateur ne se trouve pas dans une région qui requiert un accord - tous les cookies sont acceptés
                    break;
              default: //L'utilisateur a donné son consentement
                    //Lire le consentement de l'utilisateur actuel encodé au format JavaScript
                     JavaScriptSerializer CookieConsentSerializer = new JavaScriptSerializer();
                     dynamic CookieConsent = CookieConsentSerializer.Deserialize<object>(HttpUtility.UrlDecode(CurrentUserConsent.Value));
if (!CookieConsent["preferences"] && !CookieConsent["statistics"] && !CookieConsent["marketing"])
                     {
                         //l'utilisateur a désactivé les cookies; installer seulement les cookies strictement nécessaires
                     }
                     else
                     {
                     if (CookieConsent["preferences"])
                     {
                            //L'utilisateur actuel accepte les cookies de préférences
                     }
                     else
                     {
                          //L'utilisateur actuel N'ACCEPTE PAS les cookies de préférences
                     }
                     if (CookieConsent["statistics"]) 
                     {
                          //L'utilisateur actuel accepte les cookies statistiques
                     }
                     else
                     {
                          //L'utilisateur actuel N'ACCEPTE PAS les cookies statistiques
                     }
                     if (CookieConsent["marketing"])
                     {
                          //L'utilisateur actuel accepte les cookies marketing
                     }
                     else
                     {
                          //L'utilisateur N'ACCEPTE PAS les cookies marketing
                     }
             }
       }
}
else
{
      //L'utilisateur n'a pas accepté les cookies - n'installer que les cookies strictement nécessaires
}
if (isset($_COOKIE["CookieConsent"])) 
{
      switch ($_COOKIE["CookieConsent"])
      {
            case "-1":
                  //L'utilisateur ne se trouve pas dans une région qui requiert un accord - tous les cookies sont acceptés
                  break;
            default: //L'utilisateur a donné son consentement
                  //Lire le consentement de l'utilisateur actuel encodé au format JavaScript
                  $valid_php_json = preg_replace('/\s*:\s*([a-zA-Z0-9_]+?)([}\[,])/', ':"$1"$2', preg_replace('/([{\[,])\s*([a-zA-Z0-9_]+?):/', '$1"$2":', str_replace("'", '"',stripslashes($_COOKIE["CookieConsent"]))));
                  $CookieConsent = json_decode($valid_php_json);
if (!filter_var($CookieConsent->preferences, FILTER_VALIDATE_BOOLEAN)
&& !filter_var($CookieConsent->statistics, FILTER_VALIDATE_BOOLEAN) && !
filter_var($CookieConsent->marketing, FILTER_VALIDATE_BOOLEAN))
                  {
                         //l'utilisateur a désactivé les cookies; installer seulement les cookies strictement nécessaires
                  }
                  else
                  {
                  if (filter_var($CookieConsent->preferences, FILTER_VALIDATE_BOOLEAN))
                  {
                        //L'utilisateur actuel accepte les cookies de préférences
                  }
                  else
                  {
                        //L'utilisateur actuel N'ACCEPTE PAS les cookies de préférences
                  }
                  if (filter_var($CookieConsent->statistics, FILTER_VALIDATE_BOOLEAN))
                  {
                        //L'utilisateur actuel accepte les cookies statistiques
                  }
                  else
                  {
                        //L'utilisateur actuel N'ACCEPTE PAS les cookies statistiques
                  }
                  if (filter_var($CookieConsent->marketing, FILTER_VALIDATE_BOOLEAN))
                  {
                        //L'utilisateur actuel accepte les cookies marketing
                  }
                  else
                  {
                        //L'utilisateur N'ACCEPTE PAS les cookies marketing
                  }
             }
       }
}
else
{
      //L'utilisateur n'a pas accepté les cookies - n'installer que les cookies strictement nécessaires
}
Imports System.Web.Script.Serialization
 ...
Dim CurrentUserConsent As HttpCookie = Request.Cookies("CookieConsent")
If CurrentUserConsent IsNot Nothing Then
      Select Case CurrentUserConsent.Value
            Case "-1"
                  REM L'utilisateur ne se trouve pas dans une région qui requiert un accord - tous les cookies sont acceptés
                  Exit Select
            Case Else REM L'utilisateur a donné son consentement
                  REM Lire le consentement de l'utilisateur actuel encodé au format JavaScript
                  Dim CookieConsentSerializer As New JavaScriptSerializer()
                  Dim CookieConsent As dynamic = CookieConsentSerializer.Deserialize(Of Object)(HttpUtility.UrlDecode(CurrentUserConsent.Value))
                  If Not CookieConsent("preferences") And Not
CookieConsent("statistics") And Not CookieConsent("marketing") Then
                  REM L'utilisateur a désactivé les cookies; installer seulement les cookies strictement nécessaires
                  Else
                  If CookieConsent("preferences") Then
                      REM L'utilisateur actuel accepte les cookies de préférences
                  Else
                      REM L'utilisateur actuel N'ACCEPTE PAS les cookies de préférences
                  End If
                  If CookieConsent("statistics") Then
                      REM L'utilisateur actuel accepte les cookies statistiques
                  Else
                      REM L'utilisateur actuel N'ACCEPTE PAS les cookies statistiques
                  End If
                  If CookieConsent("marketing") Then
                      REM L'utilisateur actuel accepte les cookies marketing
                  Else
                      REM L'utilisateur N'ACCEPTE PAS les cookies marketing
                  End If
               End If
      End Select
Else
      REM L'utilisateur n'a pas accepté les cookies - n'installer que les cookies strictement nécessaires
End If

Rendez l'usage des cookies et du pistage en ligne sur votre site conforme au RGPD/ePR dès aujourd'hui

Faites un essai gratuit