Comment utiliser le SDK ?

Comment utiliser l'instance Appconsent ?

Voici la liste des méthodes les plus communément utilisées

Savoir si l'utilisateur a donné son consentement

appconsent.isConsentGiven()

Retourne true si le consentement a été donné, false sinon.

ATTENTION

Veuillez noter qu'il s'agit uniquement de savoir si l'utilisateur a confirmé un choix et non s'il a accepté ou refusé son consentement.

Les modes d'affichage de la CMP

Il existe 3 modes d'affichages:

1. Le premier qui s'exécute SEULEMENT si un consentement utilisateur est nécessaire.

2. Le second permet à vos utilisateurs de consulter / modifier leur consentement avec un accès direct au layer 1 (souvent utiliser depuis votre écran de paramétrage pour afficher la politique de vie privée de votre utilisateur) - le layer 1 correspond à l'affichage principale de votre notice. La fenêtre s'affichera TOUT LE TEMPS

3. Le dernier est en fait équivalent au second, à la différence que l'utilisateur à accès directement au layer 2. L'écran permettant de paramétrer au détail vos différentes purpose / stack ainsi que le détail des partenaires. La fenêtre s'affichera TOUT LE TEMPS

NOTE

Par défaut cette méthode "presentNotice" essaye d'afficher la CMP. Elle essaye car, selon la région de vos utilisateurs elle suivra ses contrôles et affichera la CMP que si nécessaire.

Elle s'affichera également si le consentement utilisateur n'a pas encore été donné ou si celui-ci doit être renouvelé.

appconsent.presentNotice() // Cas 1
appconsent.displayLayer1() // Cas 2
appconsent.displayLayer2() // Cas 3

GCM Status

INFO

Cette méthode indique l'état actuel de GCMv2 (Google Consent Mode V2).

Avant d'appeler cette méthode, il est préférable de s'assurer que l'utilisateur a déjà donné son consentement et qu'il est à jour, et que le CMP n'a pas besoin d'être réaffiché.

Dans le cas contraire :

• soit la valeur sauvegardée de l'ancien consentement sera retournée

• soit les valeurs par défaut de votre configuration FirebaseAnalytics AndroidManifest seront retournées.

Définir l'état de consentement par défaut à partir de la documentation de Google

appconsent.getGCMState()

Retourne ACGcmState

Modèle de données représentant l'état de GCMv2 (Google Consent Mode v2)

Cela vous permettra de définir le consentement à partir de votre instance Firebase Analytics.

isAnalyticsStorageGranted, indique si l'utilisateur a donné son consentement pour FirebaseAnalytics.ConsentType#ANALYTICS_STORAGE

isAdStorageGranted, indique si l'utilisateur a donné son accord pour FirebaseAnalytics.ConsentType#AD_STORAGE

isAdUserDataGranted, indique si l'utilisateur a donné son accord pour FirebaseAnalytics.ConsentType#AD_USER_DATA

isAdPersonalizationGranted, indique si l'utilisateur a donné son consentement pour FirebaseAnalytics.ConsentType#AD_PERSONALIZATION

FirebaseAnalytics.ConsentType

Vérifier la mise à jour

Cette méthode vous permet de vérifier sur nos serveurs si votre Notice a été mis à jour depuis son dernier affichage sur l'appareil de l'utilisateur.

INFO

La méthode appelera un callback avec true si vous avez modifié la Source et/ou la Notice depuis votre dashboard et, si et seulement si, vous avez configuré votre Notice pour qu'elle se mette à jour pour tous vos utilisateurs

ATTENTION

Cette méthode ne peux être utilisée qu'une seule fois dans un temps prédéfini. Cela vous permet de forcer un premier appel réseau pour être certains que vos utilisateurs soient à jours. Les prochains appels à cette méthode utilisera le cache de la réponse précédente ou tentera un appel réseau si la précédente était en erreur.

appconsent.checkForUpdate({ needToUpdate: Boolean ->
            // Votre Notice a été mise à jour, vous devez représenter la CMP à vos utilisateurs
            if (true == needToUpdate) {
                /*
                Permet de supprimer localement l'ancien consentement utilisateur.
                Cette étape n'est pas obligatoire, mais elle permet d'éviter de refaire un appel réseau
                pour vérifier plus tard si la Notice a été mise à jour
                car plus aucuns consentement ne sera présent sur le device de l'utilisateur.
                 */
                appConsent.clearConsent()
                appConsent.presentNotice(args)
            } else {
                /*
                La Notice est la même que lors de la dernière vérification
                (vous n'avez apporté aucunes modification depuis le board ou
                celle-ci n'a pas subit de mise à jour interne par nos soins;
                comme par exemple la mise à jour d'un vendor)
                 */
            }
        }) { _: Throwable? ->
            /*
             Une erreur s'est produite
             */
        }

Utilisation de méthodes plus spécifique de Appconsent

Voici la liste des méthodes qui pourrait éventuellement vous servir dans le cas où vous souhaiteriez allez plus loin dans le suivi du consentement de vos utilisateurs

IAB Purpose X accepté

appconsent.isIabPurposeAllowed(1)

Retourne true si le purpose avec id = 1 est autorisé, false sinon. Le id à passer est le iabId de votre purpose.

IAB Purposes Acceptées

appconsent.iabPurposeIdsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des purposes acceptées

IAB Feature X accepté

appconsent.isIabFeatureAllowed(1)

Retourne true si la feature avec id = 1 est autorisé, false sinon. Le id à passer est le featureId de votre feature.

IAB Features Acceptées

appconsent.iabFeatureIdsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des features acceptées

IAB Special Feature X accepté

appconsent.isIabSpecialFeatureAllowed(1)

Retourne true si la special feature avec id = 1 est autorisé, false sinon. Le id à passer est le specialFeatureId de votre special feature.

IAB Special Features Acceptées

appconsent.iabSpecialFeatureIdsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des special features acceptées

IAB Special Purpose X accepté

appconsent.isIabSpecialPurposeAllowed(1)

Retourne true si le special purpose avec id = 1 est autorisé, false sinon. Le id à passer est le iabId de votre special purpose.

IAB Special Purposes Acceptées

appconsent.iabSpecialPurposeIdsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des special purposes acceptées

Stack X accepté

appconsent.isIabStacksAllowed(1)

Retourne true si la stack avec id = 1 est autorisée, false sinon.

IAB Stacks Acceptées

appconsent.iabStacksIdsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des stacks acceptées

Vendor X accepté

appconsent.isIabVendorAllowed(1)

Retourne true si le vendor avec id = 1 est autorisé, false sinon.

IAB Vendors Acceptées

appconsent.iabVendorsAllowed() : List<Int>

Retourne une list d'entier représentant les ids des partenaires acceptées

Extra Vendor X accepté

appconsent.isExtraVendorAllowed("abc123")

Retourne true si le extra vendor avec id = "abc123" est autorisé, false sinon.

Extra Vendors Acceptées

appconsent.extraVendorsAllowed() : List<String>

Retourne une list de string représentant les ids des extra partenaires acceptées

Extra Purpose X accepté

appconsent.isExtraPurposeAllowed("abc123")

Retourne true si le extra purpose avec id = "abc123" est autorisé, false sinon.

Extra Purpose Acceptées

appconsent.extraPurposeIdsAllowed() : List<String>

Retourne une list de string représentant les ids des extra purpose acceptées

List des Purposes

appconsent.getPurposes() : List<ACConsentable>

Retourne la liste de toutes les purposes de votre source avec le status défini par l'utilisateur

List des Purposes par status

appconsent.getPurposesByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les purposes de votre source filtrées par le status que vous passez en paramètre

List des Features

appconsent.getFeatures() : List<ACConsentable>

Retourne la liste de toutes les features de votre source avec le status défini par l'utilisateur

List des Features par status

appconsent.getFeaturesByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les features de votre source filtrées par le status que vous passez en paramètre

List de Special Purpose

appconsent.getSpecialPurposes() : List<ACConsentable>

Retourne la liste de toutes les special purpose de votre source avec le status défini par l'utilisateur

List de Special Purpose par status

appconsent.getSpecialPurposesByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les special purpose de votre source filtrées par le status que vous passez en paramètre

List de Special Feature

appconsent.getSpecialFeatures() : List<ACConsentable>

Retourne la liste de toutes les special feature de votre source avec le status défini par l'utilisateur

List de Special Feature par status

appconsent.getSpecialFeaturesByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les special feature de votre source filtrées par le status que vous passez en paramètre

List de Extra Purpose

appconsent.getExtraPurposes() : List<ACConsentable>

Retourne la liste de toutes les extra purpose de votre source avec le status défini par l'utilisateur

List de Extra Purpose par status

appconsent.getExtraPurposesByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les extra purpose de votre source filtrées par le status que vous passez en paramètre

List de Stack

appconsent.getStacks() : List<ACConsentable>

Retourne la liste de toutes les stack de votre source avec le status défini par l'utilisateur

List de Stack par status

appconsent.getStacksByStatus(status: ACConsentableStatus) : List<ACConsentable>

Retourne la liste de toutes les stack de votre source filtrées par le status que vous passez en paramètre

List de Extra Vendors

appconsent.getExtraVendors() : List<ACExtraVendor>

Retourne la liste de tous les extra vendors de votre source avec le status défini par l'utilisateur

List de Extra Vendors par status

appconsent.getExtraVendorsByStatus(status: ACConsentableStatus) : List<ACExtraVendor>

Retourne la liste de toutes les extra vendors de votre source filtrées par le status que vous passez en paramètre

Est-ce que le consentement de l'utilisteur est mixte ?

appconsent.isConsentMixed()

Retourne true si tous le consentement utilisateur est mixte. c'est à dire, si il y'a des consentables qui ont été acceptés et d'autres refusés.

Est-ce que l'utilisateur a tout accepté ?

appConsent.isAllAllowed()

Retourne true si tous les consentables, les stacks et les vendors sont acceptés. false si au moins l'un d'entre eux n'est pas accepté.

Est-ce que l'utilisateur a tout refusé ?

appConsent.isAllDisallowed()

Retourne true si tous les consentables, les stacks et les vendors sont refusés. false si au moins l'un d'entre eux n'est pas refusé.

Définir le status des consentables

appconsent.setConsentableConsents(
    newConsentableConsents: ACConsentOverride,
    onSuccess: () -> Unit,
    onError: () -> Unit,
)

Définissez l’état des consentements, enregistrez-le et envoyez-le au serveur.

L'objet ACConsentOverride, permet de modifier n'importe quel consentable et autant que vous le souhaitez en une seule fois. Celui-ci propose une list de consentable à modifier, commes les purposes, les stacks, les vendors, etc.

Chaque status est construit de la forme suivante grâce à l'objet ACConsentStatus. Ce dernier prend en paramètre :

• id: L'id du consentable que vous souhaitez modifier (sous forme de string)

• status: le nouveau status que vous souhaitez "redéfinir" (sous forme de boolean)

  • true: ACCEPTER

  • false: REFUSER

• legintStatus: le nouveau status legitime que vous souhaitez "redéfinir" (sous forme de boolean)

  • true: ACCEPTER

  • false: REFUSER

onSuccess: est le callback qui sera appelé si le consentement a été modifié avec succès

onError: est le callback qui sera appelé si une erreur est survenue pendant la modification

Supprimer le consentement

Supprime localement le consentement utilisateur, mais pas sur le serveur (cela permettra un nouvelle affichage de la CMP lors du prochain appel a presentNotice() par exemple)

appConsent.clearConsent()

Définir vos ids externes

val ids = mapOf<String, String>("customPersonalId" to "abze23", "otherData" to "{\"name\": \"test\"}")
appConsent.askToSetExternalIds(
    externalIds = ids,
    onSuccess = { },
    onError = { errorMessage -> }
)

Permets de définir des Ids supplémentaires sur le serveur

Récupérer vos ids externes

Récupère vos external ids précédemment sauvegardés

appConsent.askToGetExternalIds(
    onSuccess = { externalIds -> },
    onError = { }
)

Définir vos ids externes localement

val ids = mapOf<String, String>("customPersonalId" to "abze23", "otherData" to "{\"name\": \"test\"}")
appConsent.setLocalExternalIds(
    externalIds = ids
)

Permets de sauvegarder localement vos identifiants externe, qui seront envoyé au serveur lors du consentement utilisateur.

Récupérer vos ids externes local

Récupère vos external ids sauvegardé localement

appConsent.getLocalExternalIds() : Map<String, String>

Récupération de l'ID Utilisateur

appconsent.getUserId() : String

Récupère l'ID utilisateur utilisé pour son consentement

Savoir si l'utilisateur a limité l'usage de son identifiant publicitaire

appconsent.isLimitedTrackingEnabled() : Boolean

true si l'identifiant utilisateur est limité, false sinon

Savoir si votre utilisateur est sujet au consentement

appconsent.isSubjectToGDPR() : Boolean?

Retourne true si votre utilisateur est sujet au consentement, false si l'utilisateur ne l'est pas, null si l'information n'est pas encore connu par notre SDK

Connaître le status global des purposes

appconsent.getPurposesStatus() : ACConsentableStatus

Permet de ce faire une idée rapide du status de toutes les purposes de votre source, suite au consentement utilisateur

enum class ACConsentableStatus{
    DISALLOWED,
    PENDING,
    ALLOWED,
    MIXED,
    UNKNOWN,
}

Connaître le status global des stacks

appconsent.getStacksStatus() : ACConsentableStatus

Permet de ce faire une idée rapide du status de toutes les stacks de votre source, suite au consentement utilisateur

Connaître le status global des partenaires

appconsent.getVendorsStatus() : ACConsentableStatus

Permet de ce faire une idée rapide du status de tous les partenaire de votre source, suite au consentement utilisateur

Connaître le status global du consentement utilisateur

appconsent.getConsentStatus() : ACConsentableStatus

Permet de ce faire une idée rapide du status du consentement utilisateur.

Définir le consentement utilisateur à TOUT REFUSER

appconsent.forceDenyAll(onSuccess: () -> Unit, onError: () -> Unit)

Permet de valider l'action de "TOUT REFUSER". Cette action a le même comportement que si la CMP s'affichait à vos utilisateur et que ceux-la appuyer sur le bouton "tout refuser".

Un nouveau consentement sera appliqué et sauvegardé.

Définir le consentement utilisateur à TOUT ACCEPTER

appconsent.forceAcceptAll(onSuccess: () -> Unit, onError: () -> Unit)

Permet de valider l'action de "TOUT ACCEPTER". Cette action a le même comportement que si la CMP s'affichait à vos utilisateur et que ceux-la appuyer sur le bouton "tout accepter".

Un nouveau consentement sera appliqué et sauvegardé.

Sauvegarder vos floating purpose

appconsent.saveFloatingPurpose(
    floatingPurposesStatus: Map<String, Boolean>,
    onSuccess: () -> Unit,
    onError: () -> Unit
)

Si vous avez définis des floating purpose dans votre source, définissez leurs identifiants et leurs status utilisateur en paramètre pour qu'ils soient pris en compte et sauvegardés

Savoir si l'un de vos floating purpose doit être mis à jour

appconsent.isFloatingNeedUpdate(
    floatingPurposeId: String,
    onSuccess: (isFloatingNeedToUpdate: Boolean) -> Unit,
    onError: () -> Unit
)

Si vous avez définis des floating purpose dans votre source, cette méthode vérifiera si celui passé en paramètre a été mis à jour depuis.

onSuccess: renverra true ou false selon

Force la sauvegarde de vos identifiants externe

appconsent.saveExternalIds(
    onSuccess: () -> Unit,
    onError: () -> Unit
)

Permet de sauvegarder vos identifiants externe sur le serveur.

(Bonus) Récupérez vos consentements

Vos consentements sont enregistrés dans SharedPreferences de votre application. Pour en savoir plus sur les clés utilisées pour sauvegarder vos consentements, veuillez vous référer à la documentation IAB.

Nous mettons également à dispositions une clé pour récupérer les Google Additional Consent IABTCF_AddtlConsent qui renvoie une String.