Objet Consent

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

L'objet Consent est une manière standardisée de représenter le consentement à travers toutes les méthodes de l'API JavaScript onsite (similaire au Consent String IAB TCF). L'objet contient une 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 onsite et l'objet Consent sont la manière officielle d'accéder aux paramètres de consentement du Commanders Act CMP avec JavaScript. L'utilisation directe du Consent Cookie est obsolète.

{
    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

The meta la propriété inclut des métadonnées et le contexte pour le consentement qui a été fourni dans un navigateur.

Propriété
Description
Type

meta.version

Version de l'objet Consent.

Chaîne

meta.tcfPolicyVersion

Version du Consent String IAB TCF.

Chaîne

meta.siteId

ID du site Commanders Act associé au consentement.

Chaîne

meta.bannerId

ID de la bannière associée 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 lorsque le consentement a été fourni (UNIX Epoch en millisecondes).

Nombre

meta.dateUpdated

Horodatage de la dernière mise à jour du consentement (UNIX Epoch en millisecondes).

Nombre

meta.dateExpires

Horodatage de l'expiration du consentement (UNIX Epoch en millisecondes).

Nombre

La propriété consent inclut des informations détaillées sur le consentement donné 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 bloqué sur).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é donné.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 vers la position neutre pour cette catégorie).​category_id est l'ID de la catégorie configurée sous Data Governance > Consent Management > Settings > Categories.

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 vendor individuel :on: Le consentement a été donné.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 vers la position neutre pour ce vendor).​vendor_id est l'ID du vendor configuré sous Data Governance > Consent Management > Settings > Vendors.

Les ID de Category et de Vendor sont préfixés avec un identifiant au cas où ils sont gérés par un framework de consentement.

Framework
Préfixe

tcf2_

Framework IAB TCF 2. Les fonctionnalités spéciales sont en outre préfixées par sf_

acm_

Vendors de Google Additional Consent Mode.

Mis à jour

Ce contenu vous a-t-il été utile ?