consent.update

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

Commanders Act stub OnSite API doit être installé avant d’utiliser l’une des fonctions API OnSite.

cact('consent.update', consentObject)

Le consent.update cette méthode permet 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 fusionnera en profondeur les champs status du Consent Object actuel avec l'objet fourni et mettra 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 tous les paramètres des vendeurs seront définis sur on, off ou unset en conséquence.

Toutes les catégories et tous les vendeurs non configurés sont ignorés lors de la fusion en profondeur des objets de consentement.

Exemples

Mettre à jour les catégories et les vendeurs

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 la 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 la mise à jour
{
    meta: { ... }, // mis à jour automatiquement
    consent: {
        status: "all-on", // mis à jour automatiquement
        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 vendeurs

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

Accepter toutes les catégories et tous les vendeurs

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

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

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

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

/* Consent Object avant la mise à jour
{
    meta: { ... },
    consent: {
        status: "unset",
        categories: {
            "1": { status: "unset" },
            "2": { status: "unset" }
        },
        vendors: {
            "1": { status: "unset" },
            "2": { status: "unset"}
        }     
    }
}
*/

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

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

Refuser toutes les catégories et tous les vendeurs

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

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

cact('consent.update', { 
    status: 'all-off', 
    categories: {
        '2': { status: 'on' } // ignoré car le 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 la 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 de mise à jour
cact('consent.update', { 
    status: 'all-off'
});

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

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 les métriques de votre Dashboard. S'il est omis, 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 ne sont autorisées que pour optout (status: 'all-off' ):

• banner_cross