info
Contenu

[Android] 2. Documentation de l'API

Constructeur


Constructeur pour créer un objet CmpManager

Paramètres
Nom, Prénom Type

Description

contexte Comportementale

Le contexte de l'application doit être FragmentActivity lors de l'utilisation d'une mise en page personnalisée

config CmpConfig

L'objet de configuration pour le consent manager

ouvertListener SurOpenCallback

Le rappel à invoquer lorsque la couche de consentement est ouverte

closeÉcouteur OnCloseCallback

Le rappel à invoquer lorsque la couche de consentement est fermée

cmpNotOpenedCallback SurCMPNotOpenedCallback

Le rappel à invoquer lorsque la couche de consentement n'a pas pu être ouverte

onErrorCallback SurErreurRappel

Le rappel à invoquer lorsqu'une erreur

onButtonClickedCallback
OnButtonClickedCallback

Le rappel à appeler pour obtenir des informations sur le bouton qui a été enfoncé pour fermer la couche de consentement

Exemple
            CmpManager.createInstance(
                context = this,
                codeId = config.id,
                serverDomain = config.domain,
                appName = config.appName,
                lang = config.language,
                closeListener = this,
                openListener = this,
                errorCallback = this,
                cmpButtonClickedCallback = this,
                cmpNotOpenedCallback = this
            )

 

initialiser


Le initialize La fonction est conçue pour configurer le SDK CMP dans le contexte de votre application et vérifier et ouvrir automatiquement la couche de consentement si nécessaire. Le initialize peut être chaîné à la création de l'instance

Paramètres
Nom, Prénom Type Description
contexte Comportementale  
interface d'application CmpLayerAppEventListenerInterface ? = nul  
Retour

 

Exemple
initialize(context = ...,appInterface = ...)

 

setCallbacks


Définir des rappels

Paramètres
Nom, Prénom Type Description
ouvertListener SurOpenCallback

Le rappel à invoquer lorsque la couche de consentement est ouverte

closeÉcouteur OnCloseCallback

Le rappel à invoquer lorsque la couche de consentement est fermée

cmpNotOpenedCallback SurCMPNotOpenedCallback

Le rappel à invoquer lorsque la couche de consentement n'a pas pu être ouverte

onErrorCallback SurErreurRappel

Le rappel à invoquer lorsqu'une erreur

onButtonClickedCallback
OnButtonClickedCallback

Le rappel à appeler pour obtenir des informations sur le bouton qui a été enfoncé pour fermer la couche de consentement

Retour

Aucune valeur de retour

Exemple
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)

setGoogleAnalyticsCallback


Définir un rappel pour récupérer les valeurs du mode consentement de Google

Paramètres
Nom, Prénom Type Description
analyseListener Interface CmpGoogleAnalytics  
Retour

Aucune valeur de retour

Exemple
 override fun updateGoogleConsent(consentMap: Map<ConsentType, ConsentStatus>) {
     val firebaseConsentMap = consentMap.entries.associate { entry ->
         val firebaseConsentType = when (entry.key) {
             ConsentType.ANALYTICS_STORAGE -> FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE
             ConsentType.AD_STORAGE -> FirebaseAnalytics.ConsentType.AD_STORAGE
             ConsentType.AD_USER_DATA -> FirebaseAnalytics.ConsentType.AD_USER_DATA
             ConsentType.AD_PERSONALIZATION -> FirebaseAnalytics.ConsentType.AD_PERSONALIZATION
       }
         val firebaseConsentStatus = when (entry.value) {
             ConsentStatus.GRANTED -> FirebaseAnalytics.ConsentStatus.GRANTED
             ConsentStatus.DENIED -> FirebaseAnalytics.ConsentStatus.DENIED
       }
         firebaseConsentType to firebaseConsentStatus
   }
     FirebaseAnalytics.getInstance(applicationContext).setConsent(firebaseConsentMap)
 }



setGoogleAnalyticsCallback(consentModeUpdate = ...)

checkAndOpenConsentLayer


Vérifier et ouvrir la couche de consentement

Paramètres
Nom, Prénom Type Description
contexte Comportementale Contexte de l'application
interface d'application CmpLayerAppEventListenerInterface ? = nul  
Retour

Aucune valeur de retour

Exemple
checkAndOpenConsentLayer(context = ...,appInterface = ...)

 

ouvrirCustomLayer


ouvre la couche de consentement personnalisée

Paramètres
Nom, Prénom Type Description
activité FragmentActivité instance
conteneurViewId Int  
Retour

Aucune valeur de retour

Exemple
openCustomLayer(activity = ...,containerViewId = ...)

 

vérifier


En cliquant

Paramètres
Nom, Prénom Type Description
onCheckIsConsentRequiredCallback OnCheckIsConsentRequired amusant isConsentRequired (isConsentRequired : booléen)
est en cache booléen = faux  
Retour

Aucune valeur de retour

Exemple
check(onCheckIsConsentRequiredCallback = ...,isCached = ...)

 

ouvrirCustomLayer


ouvre la couche de consentement personnalisée

Paramètres
Nom, Prénom Type Description
contexte Comportementale Contexte de l'application
interface d'application CmpLayerAppEventListenerInterfaceCmpLayerAppEventListenerInterface  
Retour

Aucune valeur de retour

Exemple
openCustomLayer(context = ...,appInterface = ...)

 

ouvrirConsentLayer


ouvre la couche de consentement

Retour

Aucune valeur de retour

Exemple
openConsentLayer(context)

 

createCustomLayerFragment


Créer un fragment de calque personnalisé

Paramètres
Nom, Prénom Type Description
activité FragmentActivité Contexte de l'activité
Retour

CmpConsentLayerFragment

Exemple
createCustomLayerFragment(activity = ...)

 

a le consentement


vérifier si l'utilisateur a donné son consentement

Retour
Exemple
hasConsent()

 

activerVendorList


Activer la liste des fournisseurs

Paramètres
Nom, Prénom Type Description
fournisseurs Liste  
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
enableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

désactiverVendorList


Désactiver la liste des fournisseurs

Paramètres
Nom, Prénom Type Description
fournisseurs Liste Liste des ID de fournisseur à activer.
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
disableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

activerListeObjectifs


Activer la liste d'objectifs

Paramètres
Nom, Prénom Type Description
des fins Liste Liste des identifiants d'objectif à activer.
mettre à jour le fournisseur booléen = vrai indicateur si vrai active également les fournisseurs correspondants
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
enablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

désactiverPurposeList


Désactiver une liste d'objectifs

Paramètres
Nom, Prénom Type Description
des fins Liste Liste des identifiants d'objectifs à désactiver
mettre à jour le fournisseur booléen = vrai indicateur si vrai désactiver également les fournisseurs correspondants
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
disablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

rejeter tout


Tout rejeter 

Retour

Aucune valeur de retour

Exemple
rejectAll()

 

accepter tout


Accepter tout

Retour

Aucune valeur de retour

Exemple
acceptAll()

 

getUSPrivacyString


Obtenez-nous la chaîne de confidentialité

Retour

Chaîne de confidentialité américaine

Exemple
getUSPrivacyString()

 

hasVendorConsent


A le consentement du vendeur

Paramètres
Nom, Prénom Type Description
id Chaîne fournisseur ID
Retour
Exemple
hasVendorConsent(id = ...)

 

aPurposeConsent


A le consentement du but

Paramètres
Nom, Prénom Type Description
id Chaîne ID d'objectif
Retour

 

Exemple
hasPurposeConsent(id = ...)

 

getGoogleACString


Obtenir la chaîne Google AC

Retour

Chaîne Google AC

Exemple
getGoogleACString()

 

getConsentstring


Obtenir la dernière chaîne de consentement

Retour
Exemple
getConsentstring()

 

exportCmpString


Exporter la chaîne de consentement

Retour

Chaîne Cmp enregistrée

Exemple
exportCmpString()

 

importCmpString


En cliquant

Paramètres
Nom, Prénom Type Description
cmpChaîne Chaîne cmpString à importer
importCallback CmpImportCallback fun onImportResult (succès : booléen, message : chaîne)
Retour

Aucune valeur de retour

Exemple
                    cmpManager?.importCmpString(
                        "..."
                    ) { _, message ->
                        coroutineScope.launch {
                            snackbarHostState.showSnackbar(
                                message = message,
                                actionLabel = "Action",
                                duration = SnackbarDuration.Short
                            )
                        }
                    }

 

getCalledLast


Être appelé en dernier

Retour

Date du dernier appel Cmp Layer

Exemple
getCalledLast()

 

appeléCeJour


Appelé ce jour

Retour

si la couche a été appelée aujourd'hui

Exemple
calledThisDay()

 

getAllPurposes


renvoie tous les objectifs sous forme de chaîne

Retour

chaîne de but

Exemple
getAllPurposes()

 

getAllPurposeList


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

Retour

Liste des objectifs

Exemple
getAllPurposeList()

 

getEnabledPurposes


Obtenir des objectifs convenus

Retour

 

Exemple
getEnabledPurposes()

 

getEnabledPurposeList


Obtenir une liste d'objectifs convenus

Retour

 

Exemple
getEnabledPurposeList()

 

getDisabledPurposes


Obtenir des objectifs désactivés

Retour

 

Exemple
getDisabledPurposes()

 

getAllVendors


Obtenir tous les fournisseurs

Retour

 

Exemple
getAllVendors()

 

getAllVendorsList


Obtenir la liste de tous les fournisseurs

Retour

 

Exemple
getAllVendorsList()

 

getEnabledVendorsgetEnabledVendors


Obtenir des fournisseurs agréés

Retour

 

Exemple
getEnabledVendors()

 

getEnabledVendorListgetEnabledVendorList


Obtenir une liste de fournisseurs convenue

Retour

 

Exemple
getEnabledVendorList()

 

getDisabledVendors


Obtenir des fournisseurs désactivés

Retour

 

Exemple
getDisabledVendors()

 

BesoinsAcceptation


Besoin d'acceptation

Retour

si l'utilisateur a besoin d'acceptation

Exemple
needsAcceptance()
Retour en haut de la page