[Android] 2. Documentation de l'API

SDK obsolète / Mise à niveau vers la version 3 : Cette documentation décrit la version 2.x de notre SDK. Le SDK 2.x est obsolète et sera supprimé d'ici la fin de l'année 2025. Veuillez effectuer une mise à niveau vers la version 3.x du SDK. Voir la section Aide sur SDK v3 ici.

accepter tout

Accepte la couche de consentement et se comporte de la même manière lorsque l'utilisateur accepte le consentement. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

Exemple

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

choisissez

Vérifie si le consentement de l'utilisateur est requis, en renvoyant éventuellement des résultats mis en cache. Cette méthode consomme une page vue si le paramètre isCached() est VRAI et que le consentement mis en cache a expiré, une page vue si le paramètre isCached() est FAUX et aucune page vue si le consentement mis en cache n'a pas expiré. Le consentement mis en cache est expiré et purgé toutes les 24 heures. 

Paramètres

Retour

Aucun.

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. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour

Exemple

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

appeléCeJour

Vérifie si la couche de consentement a été demandée aujourd'hui. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

FAUX sinon.

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 d'objectifs et met à jour le consentement donné. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour

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é. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

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

Active une liste d'objectifs et met à jour le consentement donné. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

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é. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

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. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

La chaîne de consentement CMP.

Exemple

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

getAllPurposes

Renvoie tous les identifiants des objectifs. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 de tous les identifiants d'utilisation pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

Lister

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 tous les identifiants des fournisseurs pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants de fournisseurs pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

Une liste contenant tous les identifiants des fournisseurs.

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 contenant le dernier consentement donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 tous les identifiants des objectifs désactivés pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants des fournisseurs désactivés pour une CMP donnée. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants des fournisseurs activés pour une CMP donnée. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants des objectifs activés pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants des fournisseurs activés pour une CMP donnée. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 identifiants des fournisseurs activés pour un CMP donné. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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.  

Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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 l'option de simplement fermer la couche. Dans ce cas, l'utilisateur n'a pas donné son consentement. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

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

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.")
    }
}

hasPurpose (à partir de la version 2.5.1)

hasPurposeConsent (obsolète)

Vérifie si l'ID d'objectif est activé en fonction du consentement de l'utilisateur. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

VRAI si l'utilisateur a donné son consentement à l'objectif spécifié.

FAUX sinon.

Veuillez noter que si, pour une raison quelconque liée à une connexion Internet médiocre ou inexistante sur l'appareil ou en cas d'absence de consentement, la valeur qui a été définie via le defaultReturn le paramètre sera renvoyé.

Le defaultReturn paramètre n'existe pas dans les versions antérieures à 2.5.1.

Exemple

fun getHasPurposeConsentAction() {
    val purposeId = "purposeID" // Replace with actual purpose ID
    val hasPurposeConsent = cmpManager?.hasPurpose(purposeId, false)
    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.")
    }
}

hasVendor (à partir de la version 2.5.1)

hasVendorConsent (obsolète)

Vérifie si l'ID du fournisseur est activé en fonction du consentement de l'utilisateur. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

VRAI si l'utilisateur a donné son consentement au fournisseur spécifié.

FAUX sinon.

Notez que si, pour une raison quelconque liée à une connexion Internet médiocre ou inexistante sur l'appareil, le consentement à cette fin n'a pas pu être récupéré, la valeur qui a été définie via le defaultReturn le paramètre sera renvoyé.

Le defaultReturn paramètre n'existe pas dans les versions antérieures à 2.5.1.

Exemple

fun getHasVendorConsentAction() {
    val vendorId = "vendorID" // Replace with actual vendor ID
    val hasVendorConsent = cmpManager?.hasVendor(vendorId, false)
    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 informée TELLE QUELLE, lorsqu'elle est récupérée via la méthode exportCmpString(). Cette méthode consomme une page vue. 

Paramètres

Retour

Aucun.

Exemple

val cmpString = "YourConsentStringHere"

  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 Initialize initialise la couche de consentement et vérifie 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 le consentement de l'utilisateur. Cette méthode consomme une page vue. 

Paramètres

Retour

L'objet CMPManager.

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. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

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. Cette méthode ne consomme aucune page vue. 

Paramètres

Retour

TRUE si l'utilisateur doit donner son consentement.

FAUX sinon.

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. Cette méthode consomme une page vue. 

Paramètres

Retour

Aucune valeur de retour.

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)
  }
}