Objet de consentement

Description du format de l'objet de consentement utilisé par l'API onsite pour recevoir et mettre à jour le consentement.

Le Consent Object est un moyen standardisé de représenter le consentement à travers toutes les méthodes de l'API JavaScript sur site (similaire au Consent String IAB TCF). L'objet contient un meta propriété qui inclut des métadonnées comme la validité du cookie et un consentement propriété qui contient les paramètres de consentement actuels stockés dans le navigateur. L'API sur site et le Consent Object sont la manière officielle d'accéder aux paramètres de consentement de Commanders Act CMP avec JavaScript. L'utilisation directe du Consent Cookie est obsolète.

Exemple de Consent Object

{
    meta: {
        version: "1.0",
        tcfPolicyVersion: "2",
        siteId: "1234",
        bannerId: "12",
        bannerVersion: "50",
        consentId: "183049723840253",
        dateCreated: 1614174067000,
        dateUpdated: 1614185078030,
        dateExpires: 1614236789942
    },
    consent: {
        status: "all-on|all-off|mixed|unset",
        categories: {
            "1": {
                status: "on",
                required: true
            },
            "2": {
                status: "on|off|unset"
            },
            "tcf2_1": {
                status: "on|off|unset"
            },
            "tcf2_2": {
                status: "on|off|unset",
                legIntStatus: "on|off|unset"
            },
            "tcf2_sf_1": {
                status: "on|off|unset"
            }
        },
        vendors: {
          "1": {
                status: "on|off|unset"
          },
          "tcf2_1": {
                status: "on|off|unset"
          },
          "tcf2_2": {
                status: "on|off|unset",
                legIntStatus: "on|off|unset"
          },
          "acm_1": {
                status: "on|off|unset"
          }
        }
    }
}

Propriétés Meta

Le meta la propriété inclut les métadonnées et le contexte du consentement qui a été fourni dans le navigateur.

Propriété	Description	Type
meta.version	Version du Consent Object.	Chaîne
meta.tcfPolicyVersion	Version du consentement IAB TCF.	Chaîne
meta.siteId	ID du site Commanders Act associé au consentement.	Chaîne
meta.bannerId	ID de la bannière associé au consentement.	Chaîne
meta.bannerVersion	Version de la bannière associée au consentement.	Chaîne
meta.consentId	ID du consentement stocké dans le TCPID cookie.	Chaîne
meta.dateCreated	Horodatage auquel le consentement a été fourni (époque UNIX en millisecondes).	Nombre
meta.dateUpdated	Horodatage auquel le consentement a été mis à jour pour la dernière fois (époque UNIX en millisecondes).	Nombre
meta.dateExpires	Horodatage auquel le consentement expirera (époque UNIX en millisecondes).	Nombre

Propriétés du consentement

La propriété de consentement inclut des informations détaillées sur le consentement fourni dans le navigateur.

Propriété	Description
consent.status	Statut global du consentement qui peut prendre l'une des valeurs suivantes : all-on: Toutes les catégories de consentement ont été acceptées.all-off: Toutes les catégories de consentement ont été refusées (sauf blocked on).mixed: Certaines catégories de consentement ont été refusées.unset: Aucun consentement n'a encore été fourni.
consent.categories[category_id].status	Statut d'une catégorie individuelle :on: Le consentement a été fourni.off: Le consentement a été refusé.unset: Aucun consentement n'a encore été fourni (si la position du bouton neutre est configurée, elle basculera sur la position du bouton neutre pour cette catégorie).​category_id est l'ID de catégorie configuré sous Gouvernance des données > Gestion du consentement > Paramètres > Catégories.
consent.categories[category_id].required	La propriété a été définie sur blocked on et le statut est toujours on.
consent.vendors[vendor_id].status	Statut d'un fournisseur individuel :on: Le consentement a été fourni.off: Le consentement a été refusé.unset: Aucun consentement n'a encore été fourni (si la position du bouton neutre est configurée, elle basculera sur la position du bouton neutre pour ce fournisseur).​vendor_id est l'ID du fournisseur configuré sous Gouvernance des données > Gestion du consentement > Paramètres > Fournisseurs.

Les ID de catégorie et de fournisseur sont précédés d'un identifiant s'ils sont gérés par un cadre de consentement.

Cadre	Préfixe
tcf2_	Cadre IAB TCF 2. Les fonctionnalités spéciales sont en outre précédées du préfixe sf_
acm_	les fournisseurs du Additional Consent Mode de Google.

​