consent.update

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

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

cact('consent.update', consentObject)

Le consent.update La 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 effectuera une fusion profonde (deep merge) des champs de statut du Consent Object actuel avec l'objet fourni et mettra automatiquement à jour toutes les propriétés méta et le 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 des vendors 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 objets de consentement.

Exemples

Mettre à jour les catégories et vendors

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

Vous pouvez voir ci-dessous 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 vendors

cact('consent.update', {
    categories: {
        '1': { // catégorie non-IAB
            status: 'on' 
        },
        'tcf2_1': { // TCF purpose 1
            status: 'on' // pas de legintStatus pour le 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 le statut global est spécifié
    }
});

Vous pouvez voir ci-dessous 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 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 le statut global est spécifié
    }
});

Vous pouvez voir ci-dessous 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 vos métriques dans le 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