consentmanager API de SDK de Android
API
Constructor
Constructor para crear un objeto CmpManager
parámetros
| Nombre | Tipo |
Descripción |
| contexto | Contexto |
El contexto de la aplicación. |
| config | CMPConfig |
El objeto de configuración para el consent manager |
| cerrarOyente | OnCloseCallback |
La devolución de llamada que se invocará cuando se cierre la capa de consentimiento |
| Oyente abierto | OnOpenCallback |
La devolución de llamada que se invocará cuando se abra la capa de consentimiento |
| cmpNotOpenedCallback | OnCMPNotOpenedCallback |
La devolución de llamada que se invocará cuando no se pueda abrir la capa de consentimiento |
| onErrorCallback | OnErrorCallback |
La devolución de llamada que se invocará cuando se produzca un error. |
openCustomLayer
Abre la capa de consentimiento personalizada
parámetros
| Nombre | Tipo |
Descripción |
| actividad | FragmentoActividad |
La instancia de actividad donde se debe mostrar la capa de consentimiento |
| containerViewId | @IdRes Internacional |
El ID de la interfaz de usuario del contenedor en el que se debe mostrar la capa de consentimiento |
Retorno
Una función sin valor de retorno
Ejemplo
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
comprobar y abrir la capa de consentimiento
Verifique y abra la capa de consentimiento eventualmente.
parámetros
| Nombre | Tipo |
Descripción |
| contexto | Contexto |
El objeto de contexto de la aplicación. |
Ejemplo
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
abrirCmpLayer
Devuelve si el propósito (id) tiene los derechos para establecer cookies
parámetros
| Nombre | Tipo |
Descripción |
| contexto | Contexto |
El contexto de la aplicación. |
| id | Cordón |
La identificación del propósito Atención: la identificación del propósito es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
| comprobar el consentimiento | Boolean |
|
Retorno
| Tipo | Descripción |
| Boolean | Un valor booleano que indica si el proveedor tiene el consentimiento para establecer cookies. |
Ejemplo
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
tiene el consentimiento del proveedor
Devuelve si el proveedor (id) tiene los derechos para establecer cookies
parámetros
| Nombre | Tipo |
Descripción |
| id | Cuerda: |
La identificación del vendedor Atención: la identificación del proveedor es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
Retorno
| Tipo | Descripción |
| Boolean | Si la finalidad tiene el consentimiento para establecer cookies |
Ejemplo
val vendorId = "S123"
consentTool.hasVendor(vendorId)
tiene un propósito
Devuelve si el propósito (id) tiene los derechos para establecer cookies
parámetros
| Nombre | Tipo |
Descripción |
| id | Cuerda: |
La identificación del propósito Atención: la identificación del propósito es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
Retorno
| Tipo | Descripción |
| Boolean | Si la finalidad tiene el consentimiento para establecer cookies |
Ejemplo
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getVendorString
Devuelve si el propósito (id) tiene los derechos para establecer cookies
parámetros
| Nombre | Tipo |
Descripción |
| id | Cuerda: |
La identificación del propósito Atención: la identificación del propósito es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
Retorno
| Tipo | Descripción |
| Boolean | Si la finalidad tiene el consentimiento para establecer cookies |
Ejemplo
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Devuelve la cadena de propósitos establecida por consentmanager
parámetros
sin parámetros
Retorno
| Tipo | Descripción |
| Cordón |
La Cadena de propósitos que se estableció a través de consentmanager
|
Ejemplo
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
obtenerPropósitos
Devuelve la cadena de propósitos establecida por consentmanager en un objeto Lista
parámetros
| Nombre | Tipo |
Descripción |
| id | Cuerda: |
La identificación del propósito Atención: la identificación del propósito es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
Retorno
| Tipo | Descripción |
| Boolean | Si la finalidad tiene el consentimiento para establecer cookies |
Ejemplo
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Resumen anterior (tbd)
|
API |
parámetros | Retorno |
Descripción
|
|
openCmpConsentToolView( Contexto de contexto ) |
contexto: El contexto de la aplicación | vacío | Muestra una vista modal con la vista web de consentimiento. Si el Cumplimiento es aceptado o rechazado, se llamará a una función de cierre. Puede anular esta función de cierre con la suya propia. Por lo tanto, implemente OnCloseCallback y agréguelo como parámetro. Interfaz de usuario de @apiNote -> ejemplo: Abrir capa mediante acción de botón |
|
openCmpConsentToolView( contexto contexto, Devolución de llamada OnCloseCallback ) |
contexto: El contexto de la aplicación
llamar de vuelta: OnCloseCallback que debe llamarse cuando la vista web se cierra por acción
|
vacío | Muestra una vista modal con la vista web de consentimiento. Si el Cumplimiento es aceptado o rechazado, se llamará a una función de cierre. Puede anular esta función de cierre con la suya propia. Por lo tanto, implemente OnCloseCallback y déselo a esta función. Este método no volverá a enviar una solicitud al servidor consentTool. Utilizará el último estado. Si solo desea volver a abrir la Vista de herramienta de consentimiento, si el servidor da un estado de respuesta == 1, use el método checkAndProceedConsentUpdate Interfaz de usuario @apiNote -> ejemplo: Abrir capa por acción de botón |
|
setCloseCmpConsentToolViewListener( Devolución de llamada OnCloseCallback ) |
llamar de vuelta: OnCloseCallback que debe llamarse cuando la vista web se cierra por acción | vacío | Establece un oyente. Si el Cumplimiento es aceptado o rechazado, se llamará a esta función. Puede anular esta función de cierre con la suya propia. Por lo tanto, implemente OnCloseCallback y agréguelo como parámetro. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
acción personalizada: La acción personalizada que se debe llamar, además de mostrar la herramienta de consentimiento | vacío | Establece una acción personalizada para una respuesta del servidor. |
|
setErrorDialogCmpConsentToolViewListener( Devolución de llamada OnErrorDialogCallback ) |
llamar de vuelta: El OnOpenCallback, que debe llamarse, cuando se abrirá la Vista. | vacío | Establece un oyente. Si se abre la Vista de cumplimiento, se llamará a esta función. Puede anular esta función abierta con la suya propia. Por lo tanto, implemente OnOpenCallback y agréguelo como parámetro. |
|
setNetworkErrorExceptionListener( Devolución de llamada OnNetworkExceptionCallback ) |
llamar de vuelta: OnErrorNetworkCallback que debe llamarse. | vacío | Establece un agente de escucha al que se llama si se produce un error de red. |
|
setOnCMPNotOpenedCallback( OnCMPNotOpenedCallback devolución de llamada ) |
llamar de vuelta: La acción cmpNotOpenedCallback que será llamada | vacío | Establece una acción cuando el Consentlayer no se va a abrir |
|
setOpenCmpConsentToolViewListener( contexto contexto, Botón gdprBotón ) |
contexto: Entonces Contexto de la aplicación botón gdpr: El botón, el openCmpConsentToolViewListener debe agregarse a |
vacío | Establece un oyente en el botón dado. Si se hace clic en el botón, se mostrará una vista modal con la vista web de consentimiento. Si el Cumplimiento es aceptado o rechazado, se llamará a una función de cierre. Puede anular esta función de cierre con la suya propia. Por lo tanto, implemente OnCloseCallback y agréguelo como otro parámetro. Si el parámetro no está configurado, pero se usó setCloseCmpConsentToolViewListener para agregar un oyente al evento de cierre, se usará este. |
|
setOpenCmpConsentToolViewListener( contexto contexto, botón gdpr, Devolución de llamada OnCloseCallback ) |
contexto: El contexto de la aplicación botón gdpr: El botón, el openCmpConsentToolViewListener debe agregarse a
llamar de vuelta: OnCloseCallback que debe llamarse cuando la vista web se cierra por acción |
vacío | Establece un oyente en el botón dado. Si se hace clic en el botón, se mostrará una vista modal con la vista web de consentimiento. Si el Cumplimiento es aceptado o rechazado, se llamará a una función de cierre. Puede anular esta función de cierre con la suya propia. Por lo tanto, implemente OnCloseCallback y agréguelo como último parámetro. |
|
setOpenCmpConsentToolViewListener( Devolución de llamada OnCloseCallback ) |
llamar de vuelta: OnCloseCallback que debe llamarse cuando la vista web se cierra por acción |
vacío | Establece un oyente. Si se abre la Vista de cumplimiento, se llamará a esta función. Puede anular esta función abierta con la suya propia. Por lo tanto, implemente OnOpenCallback y agréguelo como parámetro. |
|
setOpenPlaceHolderViewListener( contexto contexto, botón botón, vendedor de cuerdas ) |
contexto: El contexto de la aplicación .: Un botón de acción para crear la vista de marcador de posición vendedor: El proveedor que está asignado al marcador de posición |
vacío | Abre la vista de marcador de posición al hacer clic en el botón para el proveedor asignado |
|
|
|||
|
llamadoEsteDía( contexto contexto) |
contexto: El contexto de la aplicación |
booleano: si el servidor ya fue contactado este día | Devuelve si el servidor ya fue contactado ese día. |
|
clearAllValues(contexto contexto) |
contexto: El contexto de la aplicación |
vacío | Restablece los datos de consentimiento |
|
crear marcador de posición ( contexto contexto, CMPPlaceholderParams cmpPlaceholderParams, CmpPlaceholderEventListener cmpPlaceholderEventListener) |
contexto: El contexto de la aplicación cmpPlaceholderParams: asignar parámetros de marcador de posición requeridos cmpPlaceholderEventListener: Interfaz EventListener para funciones de proceso personalizadas |
CmpMarcador de posición: UIView del marcador de posición | Crea una vista de marcador de posición para el bloqueo de contenido dinámico |
|
exportCMPData(Contexto contexto) |
contexto: El contexto de la aplicación |
Cordón: La cadena de consentimiento | Una función de exportación a la que se puede llamar para exportar la cadena de consentimiento completa generada por ConsentWebView y guardada en las Preferencias compartidas de este dispositivo. |
|
getCalledLast (contexto contextual) |
contexto: El contexto de la aplicación |
Fecha: fecha en que se llamó al servidor por última vez | Proporciona información sobre la última fecha en que se contactó con el servidor. |
|
getConfig() |
|
CMPConfig: Objeto CMPConfig |
Devuelve el CMPConfig que está configurado actualmente |
|
getGoogleACString() |
contexto: El contexto de la aplicación |
Cordón: cadena de proveedores de privacidad de EE. UU. que se estableció a través de consentmanager |
Devuelve la cadena de privacidad de EE. UU., establecida por consentmanager |
|
obtener Instancia() |
|
CMPConsentTool: El instante singleton inicializado del consentmanager |
Devuelve el CMPConsentTool. Si no ha inicializado el CMPConsentTool antes, se lanzará la excepción CMPConsentToolInitialisation Exception. |
|
getInstanceUnsafe() |
|
CMPConsentTool: el instante singleton inicializado del consent Manager, o nulo. |
Devuelve el CMPConsentTool, o nulo si no se inicializó. Este método no es seguro porque puede dar lugar a excepciones de puntero nulo, pero si está seguro de que ConsentTool se inicializó antes, puede utilizar este método sin necesidad de detectar el error. Recomendamos guardar el Objeto devuelto desde el Método createInstant, para usar los Métodos del consentManager. |
|
getLastConsentString( contexto contexto) |
contexto: El contexto de la aplicación |
Cordón: La última cadena de consentimiento establecida |
Devuelve el último Consentimiento dado, presentado en base64 por consentManager |
|
getPurposes (contexto contextual) |
contexto: El contexto de la aplicación |
Cordón: La Cadena de propósitos que se fijó a través de consentmanager |
Devuelve la cadena de propósitos establecida por consentmanager |
|
getUSPrivacyString (contexto contextual) |
contexto: El contexto de la aplicación |
Cordón: La cadena de proveedores de privacidad de EE. UU. que se estableció a través de consentmanager |
Devuelve la cadena de privacidad de EE. UU., establecida por consentmanager |
|
getVendorsString (contexto contextual) |
contexto: El contexto de la aplicación |
Cordón: La cadena de proveedores que se estableció a través de consentmanager |
Devuelve la Cadena de proveedor, que fue establecida por consentmanager |
|
hasPurposeConsent(contexto contexto, ID de cadena, booleano isIABPurpose) |
contexto: el contexto de la aplicación id: El id del propósito esIABPropósito: Si el propósito está establecido por el estándar IAB (V1/V2) |
booleano: Si la finalidad tiene el consentimiento para establecer cookies |
Devoluciones, si el propósito (id) tiene los derechos para establecer cookies. Atención: La identificación del propósito es la misma que se muestra en la lista de propósitos y puede tener un prefijo como C |
|
tieneConsentimientoDeVendedor( contexto contexto, ID de cadena, booleano isIABVendor) |
contexto: El contexto de la aplicación id: La identificación del vendedor esIABVendor: si el proveedor está establecido por el estándar IAB (V1/V2) |
booleano: Si el Vendedor tiene el Consentimiento para establecer cookies. |
Devoluciones, si el Proveedor (id) tiene los derechos para establecer cookies
Atención: La identificación del proveedor es la misma que se muestra en la lista de proveedores y puede tener un prefijo como C, S |
|
importarCMPData( contexto contexto, Cadena cmpData ) |
contexto: El contexto de la aplicación cmpData: la cadena que se establecerá. La cadena de consentimiento debe pasarse como base64 codificada |
booleano: Si la importación se realizó correctamente o si se producen errores en la cadena |
Un método de importación al que se puede llamar para importar la cadena de consentimiento completa generada por ConsentWebView en las Preferencias compartidas de este dispositivo. |
|
necesidadesAceptación(Contexto contexto) |
contexto: El contexto de la aplicación |
booleano: si el usuario necesita dar su consentimiento |
Devuelve si el usuario necesita dar un consentimiento, porque no lo hizo en el pasado, o porque el servidor de consentimiento devolvió, que se requiere un nuevo consentimiento |
|
necesita Actualización del servidor (contexto contextual) |
contexto: El contexto de la aplicación |
booleano: Si el consentmanager necesita ser actualizado |
Si los CMPSettings necesitan ser actualizados desde el servidor, porque no lo estaban en este día. |
|
|
|
|
|
