[Android] 2. Documentación de la API
Constructor
Constructor para crear un objeto CmpManager
parámetros
Nombre | Tipo de Propiedad |
Descripción |
contexto | Contexto |
El contexto de la aplicación debe ser FragmentActivity cuando se utiliza un diseño personalizado. |
config | cmpconfig |
El objeto de configuración para el consent manager |
Oyente abierto | Al abrir devolución de llamada |
La devolución de llamada que se invocará cuando se abra la capa de consentimiento |
cerrarOyente | Devolución de llamada al cerrar |
La devolución de llamada que se invocará cuando se cierre la capa de consentimiento |
cmpNotOpenedDevolución de llamada | OnCMPNotOpenedDevolución de llamada |
La devolución de llamada que se invocará cuando no se pueda abrir la capa de consentimiento |
onErrorCallback | Devolución de llamada en error |
La devolución de llamada que se invocará cuando se produzca un error. |
en el botón hecho clic en devolución de llamada |
En botón hecho clic en devolución de llamada |
La devolución de llamada que se invocará para obtener información sobre qué botón se presionó para cerrar la capa de consentimiento. |
Ejemplo
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
)
inicializar
La initialize
La función está diseñada para configurar el SDK de CMP dentro del contexto de su aplicación y verificar y abrir automáticamente la capa de consentimiento si es necesario. El initialize
se puede encadenar a la creación de la instancia
parámetros
Nombre | Tipo de Propiedad | Descripción |
contexto | Contexto | |
interfaz de la aplicación | CmpLayerAppEventListenerInterface? = nulo |
Ida y vuelta
Ejemplo
initialize(context = ...,appInterface = ...)
establecer devoluciones de llamada
Establecer devoluciones de llamada
parámetros
Nombre | Tipo de Propiedad | Descripción |
Oyente abierto | Al abrir devolución de llamada |
La devolución de llamada que se invocará cuando se abra la capa de consentimiento |
cerrarOyente | Devolución de llamada al cerrar |
La devolución de llamada que se invocará cuando se cierre la capa de consentimiento |
cmpNotOpenedDevolución de llamada | OnCMPNotOpenedDevolución de llamada |
La devolución de llamada que se invocará cuando no se pueda abrir la capa de consentimiento |
onErrorCallback | Devolución de llamada en error |
La devolución de llamada que se invocará cuando se produzca un error. |
en el botón hecho clic en devolución de llamada |
En botón hecho clic en devolución de llamada |
La devolución de llamada que se invocará para obtener información sobre qué botón se presionó para cerrar la capa de consentimiento. |
Ida y vuelta
Sin valor de retorno
Ejemplo
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)
setGoogleAnalyticsDevolución de llamada
Establecer devolución de llamada para recuperar los valores del modo de consentimiento de Google
parámetros
Nombre | Tipo de Propiedad | Descripción |
análisis de escucha | CmpGoogleAnalyticsInterfaz |
Ida y vuelta
Sin valor de retorno
Ejemplo
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 = ...)
comprobar y abrir la capa de consentimiento
Comprobar y abrir la capa de consentimiento
parámetros
Nombre | Tipo de Propiedad | Descripción |
contexto | Contexto | Contexto de la aplicación |
interfaz de la aplicación | CmpLayerAppEventListenerInterface? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
checkAndOpenConsentLayer(context = ...,appInterface = ...)
openCustomLayer
abre la capa de consentimiento personalizada
parámetros
Nombre | Tipo de Propiedad | Descripción |
actividad | FragmentoActividad | ejemplo |
contenedorViewId | Int. |
Ida y vuelta
Sin valor de retorno
Ejemplo
openCustomLayer(activity = ...,containerViewId = ...)
comprobar
cheque
parámetros
Nombre | Tipo de Propiedad | Descripción |
onCheckIsConsentRequiredDevolución de llamada | OnCheckIsConsentRequired | divertido esConsentRequired(isConsentRequired: booleano) devolución de llamada para determinar si se requiere un consentimiento o no |
está en caché | Booleano = falso | Si es verdadero, el resultado se almacena en caché durante un día. |
Ida y vuelta
Sin valor de retorno
Ejemplo
check(onCheckIsConsentRequiredCallback = ...,isCached = ...)
openCustomLayer
abre la capa de consentimiento personalizada
parámetros
Nombre | Tipo de Propiedad | Descripción |
contexto | Contexto | Contexto de la aplicación |
interfaz de la aplicación | CmpLayerAppEventListenerInterfaz |
Ida y vuelta
Sin valor de retorno
Ejemplo
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
abre la capa de consentimiento
Ida y vuelta
Sin valor de retorno
Ejemplo
openConsentLayer(context)
tiene consentimiento
verificar si el usuario dio su consentimiento
Ida y vuelta
la aplicación tiene consentimiento o no
Ejemplo
hasConsent()
habilitarLista de proveedores
Habilitar lista de proveedores
parámetros
Nombre | Tipo de Propiedad | Descripción |
vendedores | Lista | |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
enableVendorList(vendors = ...,onConsentReceivedCallback = ...)
desactivar la lista de proveedores
Deshabilitar lista de proveedores
parámetros
Nombre | Tipo de Propiedad | Descripción |
vendedores | Lista | Lista de ID de proveedores para habilitar. |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
disableVendorList(vendors = ...,onConsentReceivedCallback = ...)
enablePurposeList
Habilitar lista de propósitos
parámetros
Nombre | Tipo de Propiedad | Descripción |
fines | Lista | Lista de ID de propósito para habilitar. |
actualizarVendor | Booleano = verdadero | marcar si es verdadero también habilitar los proveedores correspondientes |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
enablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
deshabilitarPurposeList
Deshabilitar una lista de propósitos
parámetros
Nombre | Tipo de Propiedad | Descripción |
fines | Lista | Lista de identificadores de propósitos para deshabilitar |
actualizarVendor | Booleano = verdadero | marcar si es verdadero también deshabilitar los proveedores correspondientes |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
disablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
rechazar todo
Rechazar todo
parámetros
Nombre | Tipo de Propiedad | Descripción |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo | Devolución de llamada para manejar el evento de consentimiento recibido. |
Ida y vuelta
Sin valor de retorno
Ejemplo
cmpManager.rejectAll {
// consent request done
}
aceptar todo
Aceptar todo
parámetros
Nombre | Tipo de Propiedad | Descripción |
onConsentReceivedCallback | OnConsentReceivedCallback? = nulo | Devolución de llamada para manejar el evento de consentimiento recibido. |
Ida y vuelta
Sin valor de retorno
Ejemplo
cmpManager.acceptAll {
// consent request done
}
getUSPrivacyString
Consíguenos una cadena de privacidad
Ida y vuelta
Cadena de privacidad de EE. UU.
Ejemplo
getUSPrivacyString()
tiene el consentimiento del proveedor
Tiene el consentimiento del proveedor
parámetros
Nombre | Tipo de Propiedad | Descripción |
id | Cordón | identificación del proveedor |
Ida y vuelta
Booleano si el proveedor ha dado consentimiento
Ejemplo
hasVendorConsent(id = ...)
tiene PropósitoConsentimiento
Tiene consentimiento de propósito
parámetros
Nombre | Tipo de Propiedad | Descripción |
id | Cordón | identificación de propósito |
Ida y vuelta
Ejemplo
hasPurposeConsent(id = ...)
obtenerGoogleACString
Obtener cadena de CA de Google
Ida y vuelta
Cadena AC de Google
Ejemplo
getGoogleACString()
obtener cadena de consentimiento
Obtener última cadena de consentimiento
Ida y vuelta
Cadena de consentimiento guardada
Ejemplo
getConsentstring()
exportarCmpString
Exportar cadena de consentimiento
Ida y vuelta
Cadena Cmp guardada
Ejemplo
exportCmpString()
importarCmpString
cheque
parámetros
Nombre | Tipo de Propiedad | Descripción |
cmpCadena | Cordón | cmpString para importar |
importarDevolución de llamada | CmpImportar devolución de llamada | divertido onImportResult (éxito: booleano, mensaje: cadena) |
Ida y vuelta
Sin valor de retorno
Ejemplo
cmpManager?.importCmpString(
"..."
) { _, message ->
coroutineScope.launch {
snackbarHostState.showSnackbar(
message = message,
actionLabel = "Action",
duration = SnackbarDuration.Short
)
}
}
recibir la última llamada
Recibe la última llamada
Ida y vuelta
Última llamada Fecha de la capa Cmp
Ejemplo
getCalledLast()
llamado este día
Llamado este día
Ida y vuelta
si la capa se llamara hoy
Ejemplo
calledThisDay()
obtenertodoslospropósitos
devuelve todos los propósitos como una cadena
Ida y vuelta
Propósito Cadena
Ejemplo
getAllPurposes()
obtener lista multipropósito
devuelve todos los propósitos como una lista de cadenas
Ida y vuelta
Lista de propósitos
Ejemplo
getAllPurposeList()
getEnabledPurposes
Obtener propósitos acordados
Ida y vuelta
Ejemplo
getEnabledPurposes()
getEnabledPurposeList
Obtener lista de propósitos acordados
Ida y vuelta
Ejemplo
getEnabledPurposeList()
getDisabledPurposes
Obtener propósitos deshabilitados
Ida y vuelta
Ejemplo
getDisabledPurposes()
obtener todos los proveedores
Obtener todos los proveedores
Ida y vuelta
Ejemplo
getAllVendors()
obtener lista de todos los proveedores
Obtener la lista de todos los proveedores
Ida y vuelta
Ejemplo
getAllVendorsList()
getEnabledVendors
Obtener proveedores acordados
Ida y vuelta
Ejemplo
getEnabledVendors()
getEnabledVendorList
Obtener la lista de proveedores acordados
Ida y vuelta
Ejemplo
getEnabledVendorList()
getDisabledVendors
Obtener proveedores deshabilitados
Ida y vuelta
Ejemplo
getDisabledVendors()
necesidadesAceptación
Necesita aceptación
Ida y vuelta
si el usuario necesita aceptación
Ejemplo
needsAcceptance()