> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/consent-management/knowledge-base/consent-object.md).

# Consent Object

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

Le Consent Object est une manière standardisée de représenter le consentement dans toutes les méthodes de l'API JavaScript onsite (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 onsite et le Consent Object sont le moyen officiel d'accéder aux paramètres de consentement de Commanders Act CMP avec JavaScript. L'utilisation directe du [Le cookie de consentement](/fr/fonctionnalites/consent-management/knowledge-base/consent-cookie.md) est obsolète.

### Exemple de Consent Object <a href="#example-consent-object" id="example-consent-object"></a>

```
{
    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 <a href="#meta-properties" id="meta-properties"></a>

Le `meta` la propriété inclut des 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 du moment où le consentement a été fourni (epoch UNIX en millisecondes).  | Nombre |
| `meta.dateUpdated`      | Horodatage de la dernière mise à jour du consentement (epoch UNIX en millisecondes). | Nombre |
| `meta.dateExpires`      | Horodatage d'expiration du consentement (epoch UNIX en millisecondes).               | Nombre |

### Propriétés du consentement <a href="#consent-properties" id="consent-properties"></a>

La propriété consent 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 une position de bouton neutre est configurée, il passera à la position de bouton neutre pour cette catégorie).​`category_id` est l'ID de catégorie configuré sous `Data Governance > 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 une position de bouton neutre est configurée, il passera à la position de bouton neutre pour ce fournisseur).​`vendor_id` est l'ID du fournisseur configuré sous `Data Governance > Gestion du consentement > Paramètres > Fournisseurs`. |

Les ID des catégories et des fournisseurs sont précédés d'un identifiant s'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_`    | Les fournisseurs du mode de consentement supplémentaire de Google.                   |

​


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/fr/fonctionnalites/consent-management/knowledge-base/consent-object.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
