Developers » AS2 tagging » Android » Fonctionnalités avancées » Privacy 2.20.1
Privacy
Avant-propos
La fonctionnalité Privacy permet de contrôler le type d’informations collectées en fonction des contraintes légales propres à chaque éditeur selon les régions. Il vous offre ainsi la possibilité d’adapter votre marquage grâce à une gestion précise des différents paramètres de mesure en fonction de leur sensibilité, dans le respect de la réglementation en vigueur.
Mode privacy visiteur
Pour son fonctionnement, la fonctionnalité Privacy s’appuie sur une liste de différents modes de consentement de l’utilisateur
OptIn
: pour une mesure exhaustive après consentement.OptOut
: pour une mesure restreinte avec idclient valant « opt-out ».NoConsent
: pour une mesure restreinte avec idclient valant « Consent-No ».Exempt
: pour une mesure hybride avec exclusion des données jugées sensibles (soumis au process d’exemption CNIL).- Personnalisé : Depuis la version 2.21.0, vous pouvez utiliser des modes privacy personnalisés. Les restrictions par défaut de ces modes sont clonées depuis : exempt pour le stockage, optout pour les paramètres.
Chaque mode visiteur liste une série de paramètres du Tracker à autoriser. Il est donc possible d’interagir à différents niveaux et de conserver la maîtrise complète des données à transmettre.
Lorsqu’un mode visiteur est activé, il est enregistré pour une durée de 397 jours configurable.
La plupart des modes ne stocke pas les lifecycle metrics par défaut, ce qui signifie que ces métriques peuvent être fausses dans vos analyses.
Méthodes de marquage
La fonctionnalité fournit une série de méthodes utiles dans la gestion du consentement :
setVisitorOptOut
setVisitorOptOut()
Activer le mode « optout »
Exemple
Privacy.setVisitorOptOut();
setVisitorOptIn
setVisitorOptIn()
Activer le mode « optin »
Exemple
Privacy.setVisitorOptIn();
setVisitorMode
setVisitorMode(visitorMode)
setVisitorMode(visitorMode, duration)
Activer un mode spécifique pour une durée déterminée (si non renseignée, 397 par défaut)
Param | Type | Description |
visitorMode | Privacy.VisitorMode | Nom du mode visiteur |
duration | int | Durée de la validité du nouveau mode (en jours) |
Depuis la 2.21.0:
setVisitorMode(visitorMode, visitorConsent, customUserIdValue)
setVisitorMode(visitorMode, visitorConsent, customUserIdValue, duration)
Param | Type | Description |
visitorMode | String | Nom du mode visiteur – sensible à la casse. Modes prédéfinis : OptIn , OptOut , Exempt , NoConsent |
visitorConsent | boolean | Est-ce que le visiteur a consenti a être suivi |
customUserIdValue | String | Surcharge de l’identifiant visiteur géré par le SDK. null pour conserver le comportement classique |
duration | int | Durée de la validité du nouveau mode (en jours) |
Exemple
Privacy.setVisitorMode(Privacy.VisitorMode.Exempt); Privacy.setVisitorMode(Privacy.VisitorMode.Exempt, 397); Privacy.setVisitorMode("CustomMode", true, null); Privacy.setVisitorMode("Restricted", false, "restricted-id", 7);
getVisitorMode
getVisitorMode() ⇒ Privacy.VisitorMode
Récupérer le mode visiteur courant.
Exemple
Privacy.VisitorMode visitorMode = Privacy.getVisitorMode();
extendIncludeBufferForVisitorMode
extendIncludeBufferForVisitorMode(visitorMode, keys)
Ajouter des paramètres de buffer à la liste d’inclusion du mode visiteur spécifié dans l’appel
Param | Type | Description |
visitorMode | String | Mode pour lequel le buffer sera étendu – sensible à la casse. Modes prédéfinis : OptIn , OptOut , Exempt , NoConsent |
keys | String... | Paramètres de buffer |
Les paramètres de buffer peuvent suivre 3 formats :
an
: le paramètre « an » de la querystringstc/my_parameter
: le paramètre « my_parameter » de l’objet « stc » de la querystring (« / » pour indiquer un niveau de sous-objet)events_data_prop
: la propriété « prop » de l’objet de données des events (« _ » pour indiquer un niveau de sous-objet)
Exemple
Privacy.extendIncludeBufferForVisitorMode("Exempt", "an", "ac"); // buffer parameters "an" and "ac" for Exempt mode Privacy.extendIncludeBufferForVisitorMode("OptOut", "stc/version"); // buffer parameter "version" of the "stc" object for OptOut mode Privacy.extendIncludeBufferForVisitorMode("Exempt", "events_data_version"); // buffer parameter "version" of the events data object for Exempt mode
extendIncludeStorageForVisitorMode
Depuis la 2.21.0
extendIncludeStorageForVisitorMode(visitorMode, storageFeatureKeys)
Ajouter des stockages à la liste d’inclusion du mode visiteur spécifié dans l’appel
Param | Type | Description |
visitorMode | String | Nom du mode visiteur – sensible à la casse. Modes prédéfinis : OptIn , OptOut , Exempt , NoConsent |
storageFeatureKeys | Privacy.StorageFeature... | Clés de stockage. Disponibles : Campaign , UserId , Privacy , IdentifiedVisitor , Crash , Lifecycle |
L’ordre d’appel à cette méthode est important:
extendIncludeStorageForVisitorMode
doit être appelée avantsetVisitorMode
afin d’être prise en compte.
Example
Privacy.extendIncludeStorageForVisitorMode("Exempt", Privacy.StorageFeature.Lifecycle); // Add Lifecycle storage to Exempt mode Privacy.setVisitorMode(Privacy.VisitorMode.Exempt);
Cas d’utilisation
Activation du mode hybride CNIL
L’activation du mode hybride exempt
permet une mesure très limitée par le Tracker. Seuls les paramètres jugés « strictement nécessaires » sont mesurés.
Paramètres autorisés par défaut : s
, vm
, vc
, mh
, idclient
, p
, olt
, vtag
, ptag
, ts
, click
, type
, cn
, dg
, apvr
, mfmd
, model
, manufacturer
, os
, stc/crash/*
Paramètre autorisé depuis la 2.21.0 : ref
Stockage autorisé par défaut : Privacy
, UserId
, Crash
Bien entendu, la liste d’inclusion des paramètres peut être étendue si nécessaire. Par exemple, il est possible d’ajouter une variable personnalisée de site à cette liste si l’on considère que les données sont strictement nécessaires, en utilisant la méthode extendIncludeBuffer()
.
Exemple
Privacy.extendIncludeBufferForVisitorMode("Exempt", "x1"); // The site indicator "x1" is added to the Exempt inclusion list Privacy.setVisitorMode(Privacy.VisitorMode.Exempt);
Activation du mode « Opt-out »
L’activation du mode optout
entraîne une mesure strictement limitée par le Tracker.
Paramètres autorisés par défaut : s
, vm
, vc
, mh
, idclient
, ts
, olt
, cn
, click
, type
Stockage autorisé par défaut : Privacy
L’ID client prend alors la valeur « opt-out » et le trafic généré se trouve dans la catégorie de trafic exclu au niveau de l’analyse.
Exemple
Privacy.setVisitorOptout();
Par défaut, les hits générés lorsque le mode Opt-out est activé sont envoyés. Vous pouvez si vous le souhaitez bloquer ces envois en surchargeant la variable de configuration du Tracker
sendHitWhenOptOut
.
Exemple
Tracker tracker = ATInternet.getInstance().getDefaultTracker(); tracker.setSendHitWhenOptOutEnabled(false, null, true); // true by default
Activation du mode « No-consent »
L’activation du mode no-consent
entraîne une mesure strictement limitée par le Tracker.
Paramètres autorisés par défaut : s
, vm
, vc
, mh
, idclient
, ts
, olt
, cn
, click
, type
Aucun stockage n’est autorisé par défaut.
L’identifiant client prend alors la valeur « Consent-NO » et le trafic généré peut être exclu au niveau des analyses.
Exemple
Privacy.setVisitorMode(Privacy.VisitorMode.NoConsent);
Activation du mode « Opt-in »
L’activation du mode optin
entraîne une mesure exhaustive par le Tracker. Tous les paramètres sont alors conservés et envoyés. Cette méthode doit être appelée après qu’un internaute ait donné son consentement.
Exemple
Privacy.setVisitorOptIn();
Activations d’un mode personnalisé
Privacy.extendIncludeStorageForVisitorMode("Custom", Privacy.StorageFeature.Lifecycle, Privacy.StorageFeature.Crash); Privacy.extendIncludeBufferForVisitorMode("Custom", "p", "vtag", "at", "ac", "events_*"); Privacy.setVisitorMode("Custom", false, null)
Certification ACPM (OJD)
Si votre site/app est certifié par l’ACPM (OJD), vous devez autoriser le paramètre stc/device
dans votre buffer :
Privacy.extendIncludeBufferForVisitorMode("Exempt", "stc/device");Dernière mise à jour : 24/03/2021