[Android] 2. Documentation de l'API

accepter tout

Accepte la couche de consentement et se comporte de la même manière lorsque l'utilisateur accepte le consentement.

Paramètres

Retour

Aucune valeur de retour

Nombre de pages vues

1

Exemple

func acceptAll(onFinish: @escaping () -> Void) {
  cmpManager?.acceptAll(onFinish: onFinish)
}

vérifier

Vérifie si le consentement est requis de la part de l'utilisateur, renvoyant éventuellement les résultats mis en cache.

Paramètres

Retour

Aucun.

Nombre de pages vues

1 si le paramètre isCached() est VRAI et que le consentement mis en cache a expiré

1 si les paramètres isCached() sont FAUX

0 si isCached() est VRAI et que le consentement mis en cache n'a PAS expiré

Exemple

cmpManager.acceptAll {
  coroutineScope.launch {
    snackbarHostState.showSnackbar(
      message = "All consents accepted",
      duration = SnackbarDuration.Short
    )
    consentStatus.value = showConsentStatus(cmpManager)
  }
}

checkAndOpenConsentLayer

Vérifie si le consentement de l'utilisateur est requis et, si tel est le cas, ouvre l'interface utilisateur de la couche de consentement.

Paramètres

Retour

Aucune valeur de retour

Nombre de pages vues

1

Exemple

context.getActivity()?.let { activity ->
                cmpManager.checkAndOpenConsentLayer(activity)
            }

appeléCeJour

Vérifie si la couche de consentement a été demandée aujourd'hui.

Paramètres

Retour

VRAI si le consentement de l'utilisateur a déjà été demandé aujourd'hui.

FAUX sinon.

Nombre de pages vues

0

Exemple

fun consentRequestedTodayAction() {
    val calledToday = cmpManager?.calledThisDay()
    if (calledToday != null) {
        println("Consent requested today: $calledToday")
    } else {
        println("Failed to retrieve consent request status for today.")
    }
}

désactiverPurposeList

Désactive une liste de finalités et met à jour le consentement donné.

Paramètres

Retour

Aucune valeur de retour

Nombre de pages vues

1

Exemple

fun onFinish() {
    println("Notification: New consent received")
}

val purposes = listOf("1", "2")

// Option with callback
cmpManager?.disablePurposeList(purposes, ::onFinish)

// Option without callback
cmpManager?.disablePurposeList(purposes)

désactiverVendorList

Désactive une liste de fournisseurs et met à jour le consentement donné.

Paramètres

Retour

Aucune valeur de retour.

Nombre de pages vues

1

Exemple

fun onFinish() {
    println("Notification: New consent received")
}

val vendors = listOf("1", "2")

// Option with callback
cmpManager?.disableVendorList(vendors, ::onFinish)

// Option without callback
cmpManager?.disableVendorList(vendors)

activerVendorList

Permet une liste de finalités et met à jour le consentement donné.

Paramètres

Retour

Aucune valeur de retour.

Nombre de pages vues

1

Exemple

fun onFinish() {
    println("Notification: New consent received")
}

val vendors = listOf("1", "2")

// Option with callback
cmpManager?.enableVendorList(vendors, ::onFinish)

// Option without callback
cmpManager?.enableVendorList(vendors)

activerListeObjectifs

Active une liste de fournisseurs et met à jour le consentement donné.

Paramètres

Retour

Aucune valeur de retour.

Nombre de pages vues

1

Exemple

fun onFinish() {
    println("Notification: New consent received")
}

val purposes = listOf("1", "2")

// Option with callback
cmpManager?.enablePurposeList(purposes, ::onFinish)

// Option without callback
cmpManager?.enablePurposeList(purposes)

exportCmpString

Exporte la chaîne CMP actuelle représentant les préférences de consentement de l'utilisateur.  

Paramètres

Retour

Chaîne codée en base64 CMP.

Nombre de pages vues

0

Exemple

fun exportConsentStringAction() {
    val exportString = cmpManager?.exportCmpString()
    println(exportString ?: "No string to export.")
}

getAllPurposes

Renvoie les identifiants de tous les objectifs.

Paramètres

Retour

Une chaîne séparée par des virgules contenant tous les ID utiles.

Nombre de pages vues

0

Exemple

fun getAllPurposesAction() {
    val allPurposes = cmpManager?.getAllPurposes()
    if (allPurposes != null) {
        println("All purposes: $allPurposes")
        // Additional actions for getAllPurposes function can be added here
    } else {
        println("Failed to retrieve all purposes.")
    }
}

getAllPurposeList

Renvoie une liste d’ID tous usages pour une CMP donnée.

Paramètres

Retour

Lister

Nombre de pages vues

0

Exemple

fun getAllPurposeListAction() {
  // Action for getAllPurposeList function
  val allPurposes = cmpManager?.getAllPurposesList()
  if (allPurposes != null) {
    println("All purposes list: ${allPurposes.joinToString(", ")}")
  } else {
    println("Failed to retrieve all purposes list.")
  }
}

getAllVendors

Renvoie les identifiants de tous les fournisseurs pour un CMP donné.

Paramètres

Retour

Une chaîne séparée par des virgules contenant tous les ID de fournisseurs.

Nombre de pages vues

0

Exemple

fun getAllVendorsAction() {
  // Action for getAllVendors function
  val allVendors = cmpManager?.getAllVendors()
  if (allVendors != null) {
    println("Printing all Vendors: $allVendors")
  } else {
    println("Failed to retrieve all vendors.")
  }
}

getAllVendorsList

Renvoie une liste de tous les ID de fournisseurs pour un CMP donné.

Paramètres

Retour

Une liste contenant tous les identifiants des fournisseurs.

Nombre de pages vues

0

Exemple

fun getAllVendorsListAction() {
    val allVendors = cmpManager?.getAllVendorsList()
    if (allVendors != null) {
        println("All vendors list: ${allVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve all vendors list.")
    }
}

getConsentstring

Renvoie une chaîne avec le dernier consentement donné.

Paramètres

Retour

Une chaîne avec le dernier consentement reconnu par l'utilisateur.

Nombre de pages vues

0

Exemple

fun getAllVendorsListAction() {
    val allVendors = cmpManager?.getAllVendorsList()
    if (allVendors != null) {
        println("All vendors list: ${allVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve all vendors list.")
    }
}

getDisabledPurposes

Renvoie les ID de tous les objectifs désactivés pour une CMP donnée.

Paramètres

Retour

Une chaîne séparée par des virgules contenant les ID de tous les objectifs désactivés.

Nombre de pages vues

0

Exemple

fun getDisabledPurposesAction() {
    val disabledPurposes = cmpManager?.getDisabledPurposes()
    if (disabledPurposes != null) {
        println("Disabled purposes: $disabledPurposes")
    } else {
        println("Failed to retrieve disabled purposes.")
    }
}

getDisabledVendors

Renvoie tous les ID de fournisseurs désactivés pour un CMP donné.

Paramètres

Retour

Une chaîne séparée par des virgules contenant tous les ID de fournisseurs désactivés.

Nombre de pages vues

0

Exemple

fun getDisabledVendorsAction() {
    val disabledVendors = cmpManager?.getDisabledVendors()
    if (disabledVendors != null) {
        println("Disabled vendors: $disabledVendors")
    } else {
        println("Failed to retrieve disabled vendors.")
    }
}

getEnabledPurposes

Renvoie tous les ID de fournisseurs activés pour un CMP donné.

Paramètres

Retour

Une chaîne séparée par des virgules contenant tous les ID de fournisseurs activés.

Nombre de pages vues

0

Exemple

fun getEnabledPurposesAction() {
    val enabledPurposes = cmpManager?.getEnabledPurposes()
    if (enabledPurposes != null) {
        println("Disabled purposes: $enabledPurposes")
    } else {
        println("Failed to retrieve enabled purposes.")
    }
}

getEnabledPurposeList

Renvoie une liste de tous les ID d’objectifs activés pour une CMP donnée.

Paramètres

Retour

Une liste contenant les identifiants de tous les objectifs activés.

Nombre de pages vues

0

Exemple

fun getEnabledPurposesAction() {
    val enabledPurposes = cmpManager?.getEnabledPurposes()
    if (enabledPurposes != null) {
        println("Enabled purposes: ${enabledPurposes.joinToString(", ")}")
    } else {
        println("Failed to retrieve enabled purposes list.")
    }
}

getEnabledVendorsgetEnabledVendors

Renvoie tous les ID de fournisseurs activés pour un CMP donné.

Paramètres

Retour

Une chaîne séparée par des virgules contenant tous les ID de fournisseurs activés.

Nombre de pages vues

0

Exemple

fun getEnabledVendorsAction() {
    val enabledVendors = cmpManager?.getEnabledVendors()
    if (enabledVendors != null) {
        println("Enabled vendors: $enabledVendors")
    } else {
        println("Failed to retrieve enabled vendors.")
    }
}

getEnabledVendorListgetEnabledVendorList

Renvoie une liste avec tous les ID de fournisseurs activés pour un CMP donné.

Paramètres

Retour

Une liste contenant tous les identifiants des fournisseurs activés.

Nombre de pages vues

0

Exemple

fun getEnabledVendorsAction() {
    val enabledVendors = cmpManager?.getEnabledVendors()
    if (enabledVendors != null) {
        println("Enabled vendors: ${enabledVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve enabled vendors.")
    }
}

getGoogleACString

Récupère la chaîne d'ID de consentement supplémentaire de Google (`addtlConsent`) définie par le consent manager.

Pour plus d'informations, consultez le Spécifications techniques du consentement supplémentaire de Google.  

Paramètres

Retour

Une liste contenant tous les identifiants des fournisseurs activés.

Nombre de pages vues

0

Exemple

fun getGoogleConsentStringAction() {
    val googleACString = cmpManager?.getGoogleACString()
    if (googleACString != null) {
        println("Google Additional Consent String: $googleACString")
    } else {
        println("Failed to retrieve Google Additional Consent String.")
    }
}

getUSPrivacyString

Récupère la chaîne de confidentialité américaine. Cette chaîne de confidentialité américaine est un cookie qui stocke des informations sur les divulgations effectuées et les choix sélectionnés par le visiteur du site Web concernant ses droits de consommateur.

Paramètres

Retour

Une chaîne avec les données de confidentialité américaines définies par consentmanager.

Nombre de pages vues

0

Exemple

fun getUSPrivacyStringAction() {
    val usPrivacyString = cmpManager?.getUSPrivacyString()
    if (usPrivacyString != null) {
        println("US Privacy string contents: $usPrivacyString")
    } else {
        println("Failed to retrieve US Privacy string.")
    }
}

a le consentement

Vérifie si l'utilisateur a déjà donné son consentement. La couche de consentement peut avoir la possibilité de simplement fermer la couche. Dans ce cas, l’utilisateur n’a pas donné son consentement.

Paramètres

Retour

Une chaîne avec les données de confidentialité américaines définies par consentmanager.

Nombre de pages vues

0

Exemple

fun getHasConsentAction() {
    val hasConsent = cmpManager?.hasConsent()
    if (hasConsent != null) {
        val consentStatus = if (hasConsent) "Yes" else "No"
        println("Consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user consent.")
    }
}

aPurposeConsent

Vérifie si l'ID d'objectif est activé en fonction du consentement de l'utilisateur.

Paramètres

Retour

VRAI si

• l'utilisateur a donné son consentement à la finalité spécifiée OU
• pour une raison quelconque liée à une connexion Internet faible ou inexistante sur l'appareil, le consentement à cette fin n'a pas pu être récupéré. Veuillez vous référer à withErrorListener pour gérer ces conditions lors du lancement de l'application, en particulier pour les nouveaux utilisateurs qui n'ont pas encore donné leur consentement.

FAUX sinon.

Nombre de pages vues

0

Exemple

fun getHasPurposeConsentAction() {
    val purposeId = "purposeID" // Replace with actual purpose ID
    val hasPurposeConsent = cmpManager?.hasPurposeConsent(purposeId)
    if (hasPurposeConsent != null) {
        val consentStatus = if (hasPurposeConsent) "Yes" else "No"
        println("Purpose has consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user purpose consent.")
    }
}

hasVendorConsent

Vérifie si l'ID du fournisseur est activé en fonction du consentement de l'utilisateur.

Paramètres

Retour

VRAI si

• l'utilisateur a donné son consentement au fournisseur spécifié OU
• pour une raison quelconque liée à une connexion Internet faible ou inexistante sur l'appareil, le consentement du vendeur n'a pas pu être récupéré. Veuillez vous référer à withErrorListener pour gérer ces conditions lors du lancement de l'application, en particulier pour les nouveaux utilisateurs qui n'ont pas encore donné leur consentement.

FAUX sinon.

Nombre de pages vues

0

Exemple

fun getHasVendorConsentAction() {
    val vendorId = "vendorID" // Replace with actual vendor ID
    val hasVendorConsent = cmpManager?.hasVendorConsent(vendorId)
    if (hasVendorConsent != null) {
        val consentStatus = if (hasVendorConsent) "Yes" else "No"
        println("Vendor has consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user vendor consent.")
    }
}

importCmpString

Importe une chaîne CMP représentant les préférences de consentement de l'utilisateur. La chaîne doit être encodée en base64. 

Paramètres

Retour

Aucun.

Nombre de pages vues

0

Exemple

val cmpString = "YourBase64EncodedConsentStringHere"

  typealias CmpImportCompletionHandler = (Error?) -> Unit

// Define the completion handler function
val completionHandler: CmpImportCompletionHandler = { error ->
    if (error != null) {
        println("Failed to import CMP string: ${error.message}")
    } else {
        println("CMP string imported successfully")
    }
}

cmpManager?.importCmpString(cmpString, completion = completionHandler)

initialiser

La fonction d'initialisation initialisera la couche de consentement et vérifiera automatiquement si l'utilisateur a besoin d'un consentement ou non. Cette fonction ouvrira éventuellement la couche de consentement et interagira avec l'API Apple Tracking Transparency pour demander à l'utilisateur son consentement

Paramètres

Retour

L'objet CMPManager.

Nombre de pages vues

1

Exemple

private fun initializeCmpManager() {
    CmpConfig.apply {
    id = cmpId
    domain = CMP_DOMAIN
    appName = cmpAppName
    language = cmpLanguage
    domainWhitelist = cmpDomainWhitelist
    timeout = 2000
    isDebugMode = true
  }
  CmpLog.setLogLevel(Log.VERBOSE)

  cmpManager = CmpManager.createInstance(this, CmpConfig)
}

ouvrirConsentLayer

Ouvre de force la vue Web de la couche de consentement CMP.

Paramètres

Retour

Aucune valeur de retour.

Nombre de pages vues

1

Exemple

ActionButtonsRow("Open", "Check", "Open?") { action ->
  when (action) {
  "Open" -> context.getActivity()?.let {
    	cmpManager.openConsentLayer(it.applicationContext)
    }
  	.
  	.
    .
}

BesoinsAcceptation

Vérifie si le consentement doit être fourni par l'utilisateur actuel de l'application. 

Paramètres

Retour

TRUE si l'utilisateur doit donner son consentement.

FAUX sinon.

Nombre de pages vues

0

fun showConsentStatus(cmpManager: CmpManager?): String {
    return buildString {
        append("Cmp ID: ${CmpConfig.id}\n")
        append("Need Acceptance: ${cmpManager?.needsAcceptance()}\n")  // <=========
        append("ConsentString: ${cmpManager?.getConsentString()}\n")
        append("Has Consent: ${cmpManager?.hasConsent()}\n")
    }
}

rejeter tout

Rejette la couche de consentement et se comporte de la même manière lorsque l'utilisateur n'a pas accepté le consentement.

Paramètres

Retour

Aucune valeur de retour.

Nombre de pages vues

1

Exemple

// Define the onFinish function
fun onFinish() {
    println("Notification: New consent has been received with a Reject All response.")
}

cmpManager?.rejectAll(::onFinish)

setCallbacks

Configure les rappels disponibles.

Paramètres

Retour

Aucune valeur de retour

Exemple

val existingInstance = instance?.get()
    existingInstance.setCallbacks(
      openListener = openListener,
      closeListener = closeListener,
      cmpNotOpenedCallback = cmpNotOpenedCallback,
      onErrorCallback = errorCallback,
      onButtonClickedCallback = cmpButtonClickedCallback
    )

avecGoogleAnalyticsCallback

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

Paramètres

Retour

Instance actuelle de CmpManagerInterface pour le chaînage.

Exemple

private fun initializeCmpManager() {
  cmpManager = CmpManager.createInstance(this, CmpConfig).apply {
    withOpenListener(this@ConsentActivity)
    withCloseListener(this@ConsentActivity)
    withNotOpenedCallback(this@ConsentActivity)
    withErrorCallback(this@ConsentActivity)
    withButtonClickedCallback(this@ConsentActivity)
    withOnClickLinkCallback(this@ConsentActivity)
    withGoogleAnalyticsCallback(this@ConsentActivity) // <=============
    initialize(this@ConsentActivity)
  }
}