ConsentManager SDK GDPR / CCPA pour Android

La solution ConsentManager Le SDK pour les applications Android implémente et fournit des fonctionnalités pour informer l'utilisateur sur la protection des données et demander et recueillir le consentement de l'utilisateur. Il permet aux développeurs d'applications d'intégrer facilement le ConsentManager service dans leur application.

Normes prises en charge

La solution ConsentManager Le SDK GDPR / CCPA pour Android prend en charge les normes industrielles suivantes:

• TCF de l'IAB v1
• TCF de l'IAB v2
• IAB USPrivacy v1
• ConsentManager fournisseurs / objectifs personnalisés
• Mode de consentement supplémentaire Google (chaîne Google AC)

Comment ça marche

1. Intégrez le SDK dans l'application et configurez les paramètres du SDK
2. Une fois le SDK intégré dans une application, le SDK fournira des fonctions au développeur de l'application afin de récupérer les données de consentement
3. Dès que l'application démarre, le SDK récupère automatiquement les informations du ConsentManager serveurs afin de préparer le SDK à son utilisation.
4. Il est recommandé qu'au démarrage de l'application, l'application crée une instance de classe CMPConsentTool. Une fois le fichier créé, le SDK affichera automatiquement l'écran de consentement si nécessaire.
5. Lorsque l'application souhaite traiter des données personnelles, elle doit «demander» au SDK si le consentement a été donné pour l'objectif et le fournisseur spécifiques.

L’installation

Dépôt sur Bitbucket: https://bitbucket.org/consentmanager/android-consentmanager/src/master/

gradle

Étape 1. Ajoutez le référentiel jitpack à votre build.gradle racine à la fin des référentiels:

allprojects {  
  repositories {    
    ...    
    maven { url 'https://jitpack.io' }  
  }
}

Étape 2. Ajoutez la dépendance à vos applications build.gradle. (Pour toujours obtenir la dernière version, utilisez le symbole + pour obtenir les dernières mises à jour. Vous pouvez par exemple toujours obtenir les dernières versions pour les mises à jour mineures via 1.x.+)

dependencies {
  implementation 'org.bitbucket.consentmanager:android-consentmanager:1.5.+'
}

Maven

Étape 1. Ajoutez le référentiel jitpack à votre build.gradle à la fin des référentiels:

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

Étape 2. Ajoutez la dépendance à vos applications build.gradle. (Pour toujours obtenir la dernière version dans maven, vous pouvez utiliser différentes méthodes pour décliner la plage de versions. Vous pouvez les rechercher ici )

    <dependency>
        <groupId>org.bitbucket.consentmanager</groupId>
        <artifactId>android-consentmanager</artifactId>
        <version>1.5.7</version>
    </dependency>

Utilisation de la bibliothèque

Permissions

Ce SDK nécessite les autorisations suivantes, veuillez vous assurer de les ajouter à votre AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

Lancer l'outil ConsentTool

Avec l'app-start (généralement votre fonction viewDidAppear), vous devez créer une instance de la classe CMPConsentTool. Cela récupérera automatiquement les données nécessaires de notre serveur et déterminera si l'écran de consentement doit être affiché ou non. Si tel est le cas, le SDK affichera automatiquement l'écran de consentement à ce stade, collectera les données et fournira les données à l'application. L'instance peut ensuite être utilisée pour obtenir les détails du consentement du SDK afin de l'utiliser dans l'application.

Pour lancer le ConsentTool, accédez à votre classe ciblée et créez une instance de CMPConsentTool comme indiqué ci-dessous:

//...
import net.consentmanager.sdk.CMPConsentTool;
//...
public class MainActivity extends AppCompatActivity {
    private CMPConsentTool consentTool;
    //...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
      //..
      consentTool = CMPConsentTool.createInstance(this, 123456, "consentmanager.mgr.consensu.org", "MyFavouriteApp", "");
    }
//...
}

Pour créer l'instance de CMPConsentTool, vous devez configurer l'instance. Vous devrez fournir l'ID CMP, le domaine du serveur, un nom d'application et une langue. Le CMP-ID et le domaine du serveur se trouvent dans votre ConsentManager compte sous Menu> Obtenir le code. Le nom de l'application peut être utilisé pour distinguer différentes applications dans le ConsentManager rapports. Pour la langue, vous pouvez utiliser une chaîne vide ("") pour la détection automatique ou un code de langue à 2 lettres ("EN", "DE", "FR" et ainsi de suite).

Les valeurs de configuration peuvent être insérées de différentes manières:

a) Configuration du SDK via CMPConfig

Ajoutez les lignes suivantes à votre code:

val config = CMPConfig.apply { 
            serverDomain = CMP_DOMAIN
            appName = CMP_APP_NAME
            language = LANG
            id = APP_ID
        }
val consentTool = CMPConsentTool.createInstance(this, config);

b) Configuration du SDK via createInstance()

Ajoutez la ligne suivante à votre code:

consentTool = CMPConsentTool.createInstance(this, 1234567, "consentmanager.mgr.consensu.org", "MyFavouriteApp", "EN");

Utilisation du SDK

Vérifier le consentement

Afin de vérifier si un fournisseur ou un objectif a son consentement, vous pouvez utiliser les deux méthodes:

if(consentTool.hasPurposeConsent(this,"52",false))
{
    if(consentTool.hasVendorConsent(this,"s26", false))
    {
        //do something with data
    }
}

Les deux méthodes hasPurposeConsent et hasVendorConsent nécessitent deux paramètres:

• id - Chaîne du fournisseur ou de l'ID de fonction. Veuillez noter que les identifiants de fournisseur peuvent avoir différents formats ("123", "s123" et "c123"), veuillez vérifier avec Menu> Fournisseurs et Menu> Objectifs dans votre ConsentManager compte.
• isIABVendor / isIABPurpose - Si le fournisseur ou l'objet est un fournisseur / objectif qui suit la norme IAB TCF, vous devrez définir un vrai, sinon un faux.

N'oubliez pas: tous les fournisseurs qui n'appartiennent pas à l'IAB ont des ID commençant par un "s" ou "c" (par exemple, "s123"); les fournisseurs qui appartiennent à l'IAB ont des ID ne commençant pas par un «s» ou «c».

Réouverture de l'écran de consentement

Afin de permettre à l'utilisateur de modifier les choix, vous pouvez simplement appeler openCmpConsentToolView():

consentTool.openCmpConsentToolView(this);

Transmission d'informations sur le consentement à d'autres sources

Dans certains cas, une application native peut contenir des vues Web afin d'afficher certaines choses comme du contenu publicitaire ou publicitaire. Afin de transmettre les informations de consentement du SDK à la vue Web, veuillez utiliser la fonction:

String consentData = CMPConsentTool.exportCMPData(this);

Cela exportera les informations de consentement et toutes les autres données nécessaires au CMP. Vous pouvez ensuite transmettre ces informations au CMP qui se trouve dans votre vue Web en l'ajoutant à l'URL appelée dans la vue Web:

myWebView.loadURL("https://mywebsite.com/....#cmpimport=" + consentData);

Écouteurs d'événements personnalisés

Pour ajouter une logique de processus supplémentaire, vous pouvez utiliser des écouteurs d'événement. Les écouteurs d'événement suivants sont disponibles :

Autorisation d'importation/exportation

Pour importer ou exporter le consentement, vous pouvez utiliser la fonction exportCMPData(Contexte contextuel) et importCMPData (contexte contextuel, chaîne cmpData). Vérifiez l'exemple ci-dessous : 

// Importing consent data if you like
CMPConsentTool.importCMPData(this, "${your consentString}");

// Instantiate CMPConsentTool()
consentTool = CMPConsentTool.createInstance(...)


// ... Your code here ...


// Exporting Consent data 
String consentString = CMPConsentTool.exportCMPData(this);

La chaîne de consentement que vous devez transmettre doit être encodée en base64.

Diagramme de séquence du SDK CMP

Présentation de l'API : 

hasConsent() : booléen

Description: Vérifie si l'utilisateur a déjà donné son consentement.

Valeur de retour: Renvoie true si l'utilisateur a donné son consentement, false sinon.

getAllPurposes(context: Context): Chaîne

Description: renvoie tous les objectifs sous forme de chaîne.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer les finalités.

Retour: Une chaîne contenant tous les objectifs.

getAllPurposeList(context: Context): Liste

Description: renvoie tous les objectifs sous la forme d'une liste de chaînes.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer les finalités.

Retour: une liste de chaînes, où chaque chaîne représente un objectif.

getAgreedPurposes(context: Context): Chaîne

Description: renvoie les objectifs que l'utilisateur a acceptés sous forme de chaîne.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer les finalités convenues.

Retour: Une chaîne contenant les objectifs que l'utilisateur a acceptés.

getAgreedPurposeList(context: Context): Liste

Description: renvoie une liste d'objectifs que l'utilisateur a acceptés.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste des objectifs convenus.

Retour: une liste de valeurs de chaîne représentant les objectifs que l'utilisateur a acceptés.

getDisabledPurposes(context: Context): Liste

Description: renvoie une liste des finalités actuellement désactivées.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste des objectifs désactivés.

Retour: une liste de valeurs de chaîne représentant les objectifs actuellement désactivés.

getAllVendors(context: Context): Chaîne

Description: renvoie une chaîne contenant une liste de tous les fournisseurs disponibles.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste de tous les fournisseurs.

Retour: une chaîne contenant une liste de tous les fournisseurs disponibles.

getAllVendorsList(context: Context): Liste

Description : Renvoie une liste de tous les fournisseurs disponibles.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste de tous les fournisseurs.

Retour: une liste de valeurs de chaîne représentant tous les fournisseurs disponibles.

getAgreedVendors(context: Context): Chaîne

Description: renvoie une chaîne contenant une liste de fournisseurs que l'utilisateur a acceptés.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste des fournisseurs convenus.

Retour: une chaîne contenant une liste de fournisseurs que l'utilisateur a acceptés.

getAgreedVendorList(context: Context): Liste

Description: renvoie une liste de fournisseurs que l'utilisateur a acceptés.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste des fournisseurs convenus.

Retour: une liste de valeurs de chaîne représentant les fournisseurs que l'utilisateur a acceptés.

getDisabledVendors(context: Context): Liste

Description: renvoie une liste des fournisseurs actuellement désactivés.

Paramètres:

• context (type : Context) : contexte dans lequel récupérer la liste des fournisseurs désactivés.

Retour: une liste de valeurs de chaîne représentant les fournisseurs actuellement désactivés.

enableVendorList(context : Contexte, fournisseurs : Liste )

Description: active la liste de fournisseurs donnée.

Paramètres:

• context (type : Context) : contexte dans lequel activer les fournisseurs.
• fournisseurs (type : liste ) : une liste de valeurs de chaîne représentant les fournisseurs à activer.

Retour: Aucun.

disableVendorList(context : Contexte, fournisseurs : Liste )

Description: désactive la liste de fournisseurs donnée.

Paramètres:

• context (type : Context) : contexte dans lequel désactiver les fournisseurs.
• fournisseurs (type : liste ) : une liste de valeurs de chaîne représentant les fournisseurs à désactiver.

Retour: Aucun.

rejeter tout(contexte : Contexte, onConsentReceivedCallback : OnConsentReceivedCallback)

Description : Rejette tout consentement à la candidature.

Paramètres:

• contexte (type : Context) : Le contexte dans lequel le consentement est rejeté.
• onConsentReceivedCallback (type : OnConsentReceivedCallback) : fonction de rappel exécutée après le rejet du consentement.

Retour Valeur : Aucune

acceptAll(context : Contexte, onConsentReceivedCallback : OnConsentReceivedCallback)

Description : Accepte tout consentement pour l'application.

Paramètres:

• contexte (type : Context) : Le contexte dans lequel le consentement est accepté.
• onConsentReceivedCallback (type : OnConsentReceivedCallback) : la fonction de rappel qui est exécutée après l'acceptation du consentement.

Retour Valeur : Aucune

getUSPrivacyString(context : Contexte) : chaîne

Description : Renvoie la chaîne de confidentialité américaine.

Paramètres:

• context (type : Context) : contexte dans lequel la chaîne de confidentialité américaine est renvoyée.

Retour Valeur:

• Chaîne représentant la chaîne de confidentialité américaine.

hasVendorConsent(context: Context, id: String, checkConsent: Boolean = true): Boolean

Description : Vérifie si l'utilisateur a donné son consentement à un fournisseur spécifique.

Paramètres:

• context (type : Context) : le contexte dans lequel le consentement du fournisseur est vérifié.
• id (type : chaîne) : ID du fournisseur.
• checkConsent (type : booléen, facultatif) : spécifie si le consentement doit être vérifié. La valeur par défaut est true.

Retour Valeur:

• true si l'utilisateur a donné son accord au vendeur, false sinon.

hasPurposeConsent(context: Context, id: String, isIABPurpose: Boolean, checkConsent: Boolean = true): Boolean

Description : Vérifie si l'utilisateur a donné son consentement à un objectif spécifique.

Paramètres:

• contexte (type : Contexte) : le contexte dans lequel le consentement à la finalité est vérifié.
• id (type : chaîne) : ID de l'objectif.
• isIABPurpose (type : booléen) : spécifie si l'objectif est un objectif IAB.
• checkConsent (type : booléen, facultatif) : spécifie si le consentement doit être vérifié. La valeur par défaut est true.

Retour Valeur:

• true si l'utilisateur a donné son consentement à la finalité, false sinon.

getGoogleACString(context: Context): Chaîne

Description : Renvoie l'identifiant publicitaire Google.

Paramètres:

• context (type : Context) : contexte dans lequel l'identifiant publicitaire Google est renvoyé.

Retour Valeur:

• Chaîne représentant l'identifiant publicitaire Google.

getLastConsentString(context: Context): Chaîne

Description : Renvoie la dernière chaîne de consentement.

Paramètres:

• context (type : Context) : contexte dans lequel la dernière chaîne de consentement est renvoyée.

Retour Valeur:

• Une chaîne représentant la dernière chaîne de consentement.

exportConsentString() : chaîne

Description : Exporte la chaîne de consentement.

Paramètres: Aucun

Retour Valeur:

• Une chaîne représentant la chaîne de consentement.

getCalledLast(context: Context): Date ?

Description : Renvoie la date à laquelle le consentement a été appelé pour la dernière fois.

Paramètres:

• context (type : Context) : contexte dans lequel la date du dernier appel est renvoyée.

Retour Valeur:

• Une Date représentant la date du dernier appel ou nulle si aucune date n'a été trouvée.

appeléCeJour(contexte : Contexte) : booléen

Description : Vérifie si le consentement a été appelé le jour même.

Paramètres:

• context (type : Context) : le contexte dans lequel la vérification est exécutée.

Retour Valeur:

• vrai si le consentement a été appelé le jour même, faux sinon.

Préférences partagées

Le SDK définira les valeurs de préférences partagées pour IAB TCF v1, IAB TCF v2, IAB USPrivacy et Google AC String. Ces valeurs peuvent être lues à l'aide du code suivant:

Context mContext = getApplicationContext();

SharedPreferences mPreferences = PreferenceManager.getDefaultSharedPreferences(mContext);

SharedPreferences.OnSharedPreferenceChangeListener mListener;

mListener = new SharedPreferences.OnSharedPreferenceChangeListener() {

            public void onSharedPreferenceChanged(SharedPreferences preferences, String key) {
                        if (key.equals([Specific Consent Key])) {
                                   // Update Consent settings
                                   }
                        }
            };
mPreferences.registerOnSharedPreferenceChangeListener(mListener);

Les clés suivantes sont définies:

(Obsolète) Blocage de contenu dynamique avec espace réservé webView

Cette fonction est obsolète et sera supprimée à l'avenir. La raison de l'obsolescence est qu'avec les API d'activation et de désactivation du fournisseur et de l'objectif, il n'est plus nécessaire de créer un espace réservé. Vous pouvez ajouter votre propre interface utilisateur et votre propre logique métier et activer et désactiver dynamiquement les fournisseurs. Au lieu d'utiliser cette fonction, vous devez utiliser le enableVendorList() et désactiverVendorList() pour gérer les fournisseurs activés ou désactivés, et créez votre propre interface utilisateur pour afficher ces informations à l'utilisateur.

L'espace réservé viewObject peut être implémenté pour obtenir la fonctionnalité de blocage de contenu dynamique ici.Vous pouvez créer la vue avec la méthode suivante : 

CMPPlaceholder placeholderView = CMPConsentTool.createPlaceholder(getApplicationContext(),CMPPlaceholderParams
                        .ofVendor("${vendorId}"), new CMPPlaceholderEventListener() {
                        
                    @Override
                    public void vendorAccepted(WebView view) {
                    	//... Actions to trigger if Consent is accepted
                        // Like showing Youtube Video View
                    	}
                    });

Avec l'objet Wrapper CMPPlaceholderParams vous pouvez également transmettre des paramètres facultatifs tels que des textes personnalisés ou une image d'aperçu facultative. Les fonctions du constructeur sont appelées setCustomplaceholder(String headline, String mainText, String checkboxText, String buttonText) et  setOptionalImageUrl(String imageUrl).

La logique métier requise, lorsque vous souhaitez afficher la vue et lorsqu'elle n'a pas besoin d'être appliquée par le développeur. Vous pouvez transmettre la condition et les actions requises en utilisant les rappels EvenListener du CMPPlaceholderEventlistener. L'événement requis suivant doit être mis en œuvre :

Obligatoire: vendorAccepted(CMPPlaceholderView view) { // Your logic }

En option: errorOccurred(String message) { // Error handling }

Présentation de l'API (anciennes versions)