Información
Contenido

[iOS] 3. Documentación de la API

inicializar


La función de inicialización inicializará la capa de consentimiento y verificará automáticamente si el usuario necesita un consentimiento o no. Esta función eventualmente abrirá la capa de consentimiento e interactuará con la API de transparencia de seguimiento de Apple para solicitar el consentimiento del usuario.

Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
let cmpConfig : CmpConfig = CmpConfig.shared.setup(withId: config.appId, domain: config.domain, appName: config.appName, language: config.language);
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig).initialize()

 

conCloseListener


Agrega un oyente cercano para recibir notificaciones cuando se cierra la capa de consentimiento.

parámetros
Nombre Tipo Descripción
cerrarOyente función Devolución de llamada que se llamará cuando se cierre la capa de consentimiento.
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
func onClose() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onClose)

conOpenListener


Agrega un oyente abierto para recibir notificaciones cuando se abre la capa de consentimiento.

parámetros
Nombre Tipo Descripción
Oyente abierto función Devolución de llamada a la que se llamará cuando se abra la capa de consentimiento
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
func onOpen() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onOpen)

 

 

conErrorListener


Agrega un detector de errores para recibir notificaciones cuando ocurre un error

parámetros
Nombre Tipo Descripción
errorListener función Devolución de llamada para agregar acción si se produjo un error.
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
func onCMPError(type: CmpErrorType, message: String?) -> Void {
    switch type {
    case .networkError:
        print(message)
        print("error network")
        break
    case .timeoutError:
        print(message)
        print("error timeout")
        break
    case .consentDataReadWriteError:
        print(message)
        print("error consent read/write")
        break
    case .unknownError:
        print(message)
        print("error unknown")
        break
    @unknown default:
        print(message)
        print("error network")
        break
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withErrorListener(onCMPError)

 

conOnCMPNotOpenedListener


Agrega una devolución de llamada de Cmp no abierto para recibir una notificación cuando la capa de consentimiento no se abre

parámetros
Nombre Tipo Descripción
Oyente abierto función Devolución de llamada que se llamará cuando la capa de consentimiento `no esté abierta`. La razón más común es que el usuario ya dio su consentimiento.
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
func onCMPNotOpened() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCMPNotOpenedListener(onCMPNotOpened)

 

conOnCmpButtonClickedCallback


Establece una devolución de llamada para recibir notificaciones cuando el usuario hace clic en un botón para cerrar la capa de consentimiento.

parámetros
Nombre Tipo Descripción
Oyente abierto función Devolución de llamada que se invocará con ``CmpButtonEvent`` que indica qué botón se presionó
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
func onButtonClickedEvent(event: CmpButtonEvent) -> Void {
    switch event {
    case .acceptAll:
        print("user accepted all")
        break
    case .rejectAll:
        print("user accepted all")
        break
    case .save:
        print("user saved custom settings")
        break
    case .close:
        print("user closed consent layer without giving consent")
        break
    @unknown default:
        print("unknown button event")
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCmpButtonClickedCallback(onButtonClickedEvent)

 

conCmpViewControllerConfigurationBlock


Personaliza la capa de consentimiento UIViewController

parámetros
Nombre Tipo Descripción

bloque de configuración

Bloque de configuración CmpViewController

Personaliza la capa de consentimiento

Controlador UIView

Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
            .withCmpViewControllerConfigurationBlock({ viewController in
                viewController?.modalPresentationStyle = .formSheet
            })

 

conCmpViewConfigurationBlock


Personaliza la UiView de la capa de consentimiento

parámetros
Nombre Tipo Descripción

bloque de configuración

Bloque de configuración CmpUIView

Personaliza la capa de consentimiento

Vista de interfaz de usuario

Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
let cmpLayout = CmpLayout.default()
        cmpLayout?.cornerRadius = 10.0
        cmpLayout?.customLayout = CGRect(x: 0, y: 0, width: 200, height: 300)
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
                        .withCmpViewConfigurationBlock({ uiView in
                cmpLayout?.apply(to: uiView)
            })

 

conActualizaciónGoogleConsentimiento


Recuperar el estado del modo de consentimiento de Google 

parámetros
Nombre Tipo Descripción

consentimientoMapa

[Cordón: Cordón]?

Estado de consentimiento
Ida y vuelta

Herramienta de consentimiento CMP

Ejemplo
       cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
            .withUpdateGoogleConsent(onCmpUpdateGoogleConsent)
    }

    func onCmpUpdateGoogleConsent(consentMap: [String: String]?) -> Void {
        guard let consentMap = consentMap else { return }

        var firebaseConsentMap: [ConsentType: ConsentStatus] = [:]

        consentMap.forEach { key, value in
            if let consentType = convertToFirebaseConsentType(from: key),
               let consentStatus = convertToFirebaseConsentStatus(from: value) {
                firebaseConsentMap[consentType] = consentStatus
            }
        }

        Analytics.setConsent(firebaseConsentMap)
    }

    func convertToFirebaseConsentType(from key: String) -> ConsentType? {
        switch key {
        case "analytics_storage":
            return .analyticsStorage
        case "ad_storage":
            return .adStorage
        case "ad_user_data":
            return .adUserData
        case "ad_personalization":
            return .adPersonalization
        default:
            return nil
        }
    }

    func convertToFirebaseConsentStatus(from value: String) -> ConsentStatus? {
        switch value {
        case "granted":
            return .granted
        case "denied":
            return .denied
        default:
            return nil
        }
    }

 

comprobar y abrir la capa de consentimiento


Comprobar y abrir la capa de consentimiento

Ida y vuelta

Sin valor de retorno

Ejemplo
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView


Abre la vista de la capa de consentimiento de CMP

Ida y vuelta

Sin valor de retorno

Ejemplo
cmpConsentTool.openView()

 

comprobar


cheque

parámetros
Nombre Tipo Descripción
enCmpLayerOpen función Devolución de llamada cuando la capa de consentimiento necesita estar abierta.
está en caché Boolean Indicador BOOL cuando es VERDADERO, la solicitud se almacenará en caché y la respuesta se guardará
Ida y vuelta

Sin valor de retorno

Ejemplo
cmpConsentTool?.check(
  	{
		print("Layer wants to open")
    	// self.cmpConsentTool?.openView()
    }, 
    isCached: true, 
    onCmpLayerNotOpen: {
     	print("Layer does not want to open")
    }
)

tiene consentimiento


Comprueba si el usuario dio su consentimiento. La capa de consentimiento puede tener la opción de simplemente cerrar la capa. En este caso el usuario no da su consentimiento.

Ida y vuelta
Ejemplo
cmpConsentTool.hasConsent()

 

obtenertodoslospropósitos


Obtiene una cadena separada por comas de los ID de 'propósito' deshabilitados

Ida y vuelta

Cadena de todos los ID de `propósito`

Ejemplo
cmpConsentTool.getAllPurposes()

 

obtener lista multipropósito


Recupera una lista de todos los ID de `propósito` para el Cmp dado.

Ida y vuelta

Una `Lista` que contiene todos los ID de `propósito`.

Ejemplo
cmpConsentTool.getAllPurposeList()

 

getEnabledPurposes


Obtiene una cadena separada por comas de los ID de `propósito` habilitados

Ida y vuelta

`Cadena` de ID de `propósito` habilitados

Ejemplo
cmpConsentTool.getEnabledPurposes()

 

getEnabledPurposeList


Obtener lista de propósitos acordados

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getEnabledPurposeList()

 

getDisabledPurposes


Obtener propósitos deshabilitados

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getDisabledPurposes()

 

obtener todos los proveedores


Obtener todos los proveedores

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getAllVendors()

 

obtener lista de todos los proveedores


Obtener la lista de todos los proveedores

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getAllVendorsList()

 

getEnabledVendors


Obtener proveedores habilitados

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getEnabledVendors()

 

getEnabledVendorList


Obtener lista de proveedores habilitada

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getEnabledVendorList()

 

getDisabledVendors


Obtener proveedores deshabilitados

Ida y vuelta

 

Ejemplo
cmpConsentTool?.getDisabledVendors()

 

habilitarLista de proveedores


Habilita una lista de proveedores y actualiza el consentimiento dado

parámetros
Nombre Tipo Descripción
vendedores Formación Lista de ID de proveedores para habilitar.
al Finalizar función Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enableVendorList(vendors, onFinish: onFinish)

 

desactivar la lista de proveedores


Deshabilita una lista de proveedores y actualiza el consentimiento dado

parámetros
Nombre Tipo Descripción
vendedores Formación Lista de identificadores de proveedores para deshabilitar.
al Finalizar función Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disableVendorList(vendors, onFinish: onFinish)

 

enablePurposeList


Habilita una lista de propósitos y actualiza el consentimiento dado

parámetros
Nombre Tipo Descripción
fines Formación Lista de ID de propósito para habilitar.
al Finalizar función (Opcional) Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.enablePurposeList(vendors)

 

deshabilitarPurposeList


Deshabilita una lista de propósitos y actualiza el consentimiento dado

parámetros
Nombre Tipo Descripción
fines Formación Lista de identificadores de propósito para deshabilitar.
al Finalizar función (Opcional) Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.disablePurposeList(vendors)

 

rechazar todo


Rechaza la capa de consentimiento y se comporta igual cuando el usuario `no acepta` el consentimiento

parámetros
Nombre Tipo Descripción
al Finalizar función Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.rejectAll(onFinish)

 

aceptar todo


Acepta la capa de consentimiento y se comporta igual cuando el usuario `sí acepta` el consentimiento

parámetros
Nombre Tipo Descripción
al Finalizar función Devolución de llamada para gestionar el evento de consentimiento recibido. se llamará cuando se reciba y procese el consentimiento.
Ida y vuelta

Sin valor de retorno

Ejemplo
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.acceptAll(onFinish)

 

getUSPrivacyString


Obtener cadena de privacidad de EE. UU.

Ida y vuelta

`String` La cadena de privacidad de EE. UU., establecida por consentmanager

Ejemplo
cmpConsentTool.getUSPrivacyString()

 

tiene el consentimiento del proveedor


Tiene el consentimiento del proveedor

parámetros
Nombre Tipo Descripción
proveedorId Cordón identificación del proveedor
proveedorIsV1orV2 BOOL si la identificación del proveedor es un proveedor de IAB. (Obsoleto: la bandera ya no es necesaria)
Ida y vuelta
Ejemplo
cmpConsentTool.hasVendorConsent("vendorID")

 

tiene PropósitoConsentimiento


Comprueba si la identificación del propósito está habilitada según el consentimiento del usuario.

parámetros
Nombre Tipo Descripción
ID de propósito Cordón identificación de propósito
proveedorIsV1orV2 BOOL si la identificación del proveedor es un proveedor de IAB. (Obsoleto: la bandera ya no es necesaria)
Ida y vuelta

 

Ejemplo
cmpConsentTool.hasPurposeConsent("purposeID")

 

obtenerGoogleACString


Recupera la cadena de ID de adición de Google (`addtlConsent`) establecida por el consent manager.

Ida y vuelta

Cadena AC de Google

Ejemplo
cmpConsentTool.getGoogleACString()

 

obtener cadena de consentimiento


Obtener última cadena de consentimiento

Ida y vuelta
Ejemplo
getConsentstring()

 

exportarCmpString


Exporta la cadena CmpData

Ida y vuelta

La cadena CmpData codificada en base64

Ejemplo
CMPConsentTool.exportCmpString()

 

consentimientoSolicitadoHoy


Comprueba si la capa de consentimiento se solicitó hoy

Ida y vuelta

VERDADERO si el CMPConsent Manager El servidor fue solicitado hoy, de lo contrario FALSO

Ejemplo
cmpConsentTool.consentRequestedToday()

 

se requiere consentimiento


Comprueba si el usuario necesita aceptación

Ida y vuelta

TRUE si el usuario necesita dar su consentimiento.

Ejemplo
cmpConsentTool.isConsentRequired()

 

reajustar


Restablece todos los datos establecidos por ``CMPConsentTool``

Ida y vuelta

Sin valor de retorno

Ejemplo
CMPConsentTool.reset()

 

Volver