consent.update

Méthode pour mettre à jour le statut de consentement Commanders Act OnSite via JavaScript.

The Commanders Act Stub OnSite API doit être installé avant d'utiliser l'une des fonctions OnSite API.

cact('consent.update', consentObject)

La consent.update méthode permettant de mettre à jour le consentement avec JavaScript. Elle doit être appelée avec un Consent Object qui inclut les paramètres mis à jour. Commanders Act va fusionner en profondeur les champs de statut de l'actuel Consent Object avec l'objet fourni et mettre automatiquement à jour toutes les propriétés meta et la consent.status propriété automatiquement. Dans le cas où un consent.status champ est fourni avec la valeur all-on, all-off ou unset toutes les autres mises à jour sont ignorées et toutes les catégories et paramètres de vendor seront réglés sur on, off ou unset en conséquence.

Toutes les catégories et vendors non configurés sont ignorés lors de la fusion profonde des consent objects.

Exemples

Mettre à jour les catégories et vendors

cact('consent.update', {
    categories: {
        '2': { status: 'on' }
    },
    vendors: {
        '1': { status: 'on' }
    }
});

Ci-dessous vous pouvez voir comment le Consent Object est affecté par cette mise à jour.

/* Consent Object Avant Mise à Jour
{
    meta: { ... },
    consent: {
        status: "mixed",
        categories: {
            "1": { status: "on" },
            "2": { status: "off" }
        },
        vendors: {
            "1": { status: "off" },
            "2": { status: "on"}
        }     
    }
}
*/

// Mise à jour
cact('consent.update', {
    categories: {
        '2': { status: 'on' }
    },
    vendors: {
        '1': { status: 'on' }
    }
});

/* Consent Object Après Mise à Jour
{
    meta: { ... }, // automatiquement mis à jour
    consent: {
        status: "all-on", // automatiquement mis à jour
        categories: {
            "1": { status: "on" },
            "2": { status: "on" } // mis à jour
        },
        vendors: {
            "1": { status: "on" }, // mis à jour
            "2": { status: "on"}
        }     
    }
}
*/

Mettre à jour IAB TCF/ACM catégories et vendors

cact('consent.update', {
    categories: {
        '1': { // catégorie non-IAB
            status: 'on' 
        },
        'tcf2_1': { // TCF purpose 1
            status: 'on' // pas de legintStatus pour la purpose 1
        },
        'tcf2_2': { // TCF purpose 2
            status: 'off',
            legIntStatus: 'on'
        },
        'tcf2_sf_1': { // TCF special feature 1
            status: 'on'
        }
    },
    vendors: {
        'tcf2_1': { // TCF vendor 1
            status: 'on',
            legIntStatus: 'off'
        },
        'tcf2_2': { // TCF vendor 2
            status: 'on',
            legIntStatus: 'on'
        },
        'acm_1': { // ACM vendor 1
            status: 'on'
        }
    }
});

Accepter toutes les catégories et vendors

cact('consent.update', { 
    status: 'all-on'
});

Spécifier une catégorie ou un vendor n'aura aucun effet.

cact('consent.update', { 
    status: 'all-on', 
    categories: {
        '2': { status: 'unset' } // ignoré car un statut global est spécifié
    }
});

Ci-dessous vous pouvez voir comment le Consent Object est affecté par cette mise à jour.

/* Consent Object Avant Mise à Jour
{
    meta: { ... },
    consent: {
        status: "unset",
        categories: {
            "1": { status: "unset" },
            "2": { status: "unset" }
        },
        vendors: {
            "1": { status: "unset" },
            "2": { status: "unset"}
        }     
    }
}
*/

// Méthode Update
cact('consent.update', { 
    status: 'all-on'
});

/* Consent Object Après Mise à Jour
{
    meta: { ... }, // automatiquement mis à jour
    consent: {
        status: "all-on",
        categories: {
            "1": { status: "on" }, // automatiquement mis à jour
            "2": { status: "on" } // automatiquement mis à jour
        },
        vendors: {
            "1": { status: "on" }, // automatiquement mis à jour
            "2": { status: "on"} // automatiquement mis à jour
        }     
    }
}
*/

Refuser toutes les catégories et vendors

cact('consent.update', { 
    status: 'all-off'
});

Spécifier une catégorie ou un vendor n'aura aucun effet.

cact('consent.update', { 
    status: 'all-off', 
    categories: {
        '2': { status: 'on' } // ignoré car un statut global est spécifié
    }
});

Ci-dessous vous pouvez voir comment le Consent Object est affecté par cette mise à jour. Remarque : les catégories requises ne sont pas affectées.

/* Consent Object Avant Mise à Jour
{
    meta: { ... },
    consent: {
        status: "mixed",
        categories: {
            "1": { status: "on" },
            "2": { status: "off" },
            "3": { status: "on", required: true }
        },
        vendors: {
            "1": { status: "on" },
            "2": { status: "on"}
        }     
    }
}
*/

// Méthode Update
cact('consent.update', { 
    status: 'all-off'
});

/* Consent Object Après Mise à Jour
{
    meta: { ... }, // automatiquement mis à jour
    consent: {
        status: "all-off",
        categories: {
            "1": { status: "off" }, // automatiquement mis à jour
            "2": { status: "off" }, // automatiquement mis à jour
            "3": { status: "on", required: true } // inchangé
        },
        vendors: {
            "1": { status: "off" }, // automatiquement mis à jour
            "2": { status: "off"} // automatiquement mis à jour
        }     
    }
}
*/

Spécifier l'action de mise à jour

Vous pouvez spécifier une action dans les paramètres de mise à jour :

cact('consent.update', {
    action: 'banner_button',
    categories: {
        '2': { status: 'on' }
    },
    vendors: {
        '1': { status: 'on' }
    }
});

Cette valeur d'action sera utilisée pour calculer vos métriques du Dashboard. Si elle est omise, la valeur par défaut est banner_button.

Les valeurs autorisées sont :

• banner_button

• pc_save

• page_click

• scroll

• browse

De plus, les valeurs suivantes sont autorisées uniquement pour optout (status: 'all-off' ):

• banner_cross