[iOS] 3. Documentación de la API
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
CMPConsentTool
Ejemplo
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.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
CMPConsentTool
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
CMPConsentTool
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
CMPConsentTool
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)
withOnCMPNotOpenedListener
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
CMPConsentTool
Ejemplo
func onCMPNotOpened() -> Void {
NSLog("APP:CLOSED");
// add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.withOnCMPNotOpenedListener(onCMPNotOpened)
withOnCmpButtonClickedCallback
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
CMPConsentTool
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)
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
Revise
parámetros
| Nombre | Tipo | Descripción |
| onCmpLayerOpen | 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({() -> Void in
print("Notification, that consent layer needs to be open")
}, isCached: false)
openCustomLayer
abre la capa de consentimiento personalizada
parámetros
| Nombre | Tipo | 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()
createCustomLayerFragment
Crear fragmento de capa personalizado
Ida y vuelta
CmpLayerFragment
Ejemplo
createCustomLayerFragment()
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
verdadero si el usuario dio su consentimiento.
Ejemplo
cmpConsentTool.hasConsent()
getAllPurposes
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()
getAllPurposeList
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
getEnabledPurposes()
getEnabledPurposeList
Obtener lista de propósitos acordados
Ida y vuelta
Ejemplo
getEnabledPurposeList()
getDisabledPurposes
Obtener propósitos deshabilitados
Ida y vuelta
Ejemplo
getDisabledPurposes()
getAllVendors
Obtener todos los proveedores
Ida y vuelta
Ejemplo
getAllVendors()
getAllVendorsList
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()
enableVendorList
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
VERDADERO si el usuario ha dado su consentimiento al proveedor especificado, FALSO en caso contrario.
Ejemplo
cmpConsentTool.hasVendorConsent("vendorID", FALSE)
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", FALSE)
getGoogleACString
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()
getConsentstring
Obtener última cadena de consentimiento
Ida y vuelta
Cadena de consentimiento guardada
Ejemplo
getConsentstring()
exportCmpString
Exporta la cadena CmpData
Ida y vuelta
La cadena CmpData codificada en base64
Ejemplo
CMPConsentTool.exportCmpString()
llamado este día
Comprueba si la capa de consentimiento se llamó hoy
Ida y vuelta
VERDADERO si el CMPConsent Manager El servidor fue solicitado hoy, de lo contrario FALSO
Ejemplo
cmpConsentTool.calledThisDay()
necesidadesAceptación
Comprueba si el usuario necesita aceptación
Ida y vuelta
TRUE si el usuario necesita dar su consentimiento.
Ejemplo
cmpConsentTool.needsAcceptance()
reajustar
Restablece todos los datos establecidos por ``CMPConsentTool``
Ida y vuelta
Sin valor de retorno
Ejemplo
CMPConsentTool.reset()
