Info
Contenido

[Unidad] 2. Documentación API

Inicializar


Inicializa el Consent Manager con el dominio, el código de identificación, el nombre de la aplicación y el idioma proporcionados.

parámetros
Nombre Tipo de Propiedad Descripción
dominio Cordón El dominio de la Plataforma de Gestión del Consentimiento.
códigoId Cordón El ID del código de la aplicación.
nombre de la aplicación Cordón El nombre de la aplicación.
idioma Cordón El código de idioma (por ejemplo, "EN", "DE") para la localización.
Ejemplo
       private void Awake()
        {
            _cmpManager = CmpManager.Instance;
        }

        private void Start()
        {
            _mainThread = Thread.CurrentThread;
            Debug.Log("Consentmanager SampleScene started");

#if (UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR
            var config = new CmpConfig(CodeId, Domain, AppName, Language);
            // Example of using a custom layout 
            // var customRect = new Rect(0,0, 300, 600);
            // config.SetCustomLayout(customRect);

            // alternative create the instance directly with the required parameters
            // _cmpManager.Initialize(Domain, CodeId, AppName, Language); 

            _cmpManager.Initialize(config);
            _cmpManager.Launch();
#endif
        }

 

Agregar oyentes de eventos


Establece devoluciones de llamadas específicas de Android para eventos CMP.

Ejemplo
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);

Más información


 Inicia CmpManager y muestra la capa de consentimiento si es necesario

Ejemplo
_cmpManager.Launch();

 

Tiene consentimiento


Comprueba si el usuario ha dado su consentimiento.

Ida y vuelta

Verdadero si el usuario ha dado su consentimiento; falso en caso contrario.

Ejemplo
var hasConsent = _cmpManager.HasConsent();

 

Abrir capa de consentimiento


Abre la capa de consentimiento para administrar la configuración de consentimiento del usuario.

Ejemplo
_cmpManager.OpenConsentLayer();

 

AbrirConsentLayerOnCheck


Abre la capa de consentimiento si es necesario según las comprobaciones.

Ejemplo
_cmpManager.OpenConsentLayerOnCheck();

 

TieneVendedor


Comprueba si el usuario ha seleccionado un proveedor con el ID especificado.

parámetros
  • id: El ID del proveedor a verificar.
Tipo de retorno

bool: Verdadero si se selecciona el proveedor; falso en caso contrario.

Ejemplo
bool result = HasVendor("vendorId");

Tiene un propósito


Comprueba si el usuario ha seleccionado un propósito con el ID especificado.

parámetros
  • id: El ID del propósito a verificar.
Tipo de retorno

bool: Verdadero si se selecciona el propósito; falso en caso contrario.

Ejemplo
bool result = _cmpManager.HasPurpose(purposeId);

Comprobar consentimiento es necesario


Comprueba si el usuario necesita dar su consentimiento.

Tipo de retorno

bool: Verdadero si se requiere consentimiento

Ejemplo
var isRequired = await _cmpManager.CheckConsentIsRequired();

ExportarCmpString


Tipo de retorno

cadena: La configuración de CMP exportada como una cadena.

Ejemplo
string cmpSettings = ExportCmpString();

ImportarCmpString


parámetros

cadena: La cadena CMP

Tipo de retorno

CmpImportResultado: Resultado si la importación fue exitosa

Ejemplo
 result = await _cmpManager.ImportCmpString(cmpString);

Obtener todos los propósitos


Obtiene una lista de todos los propósitos disponibles.

Tipo de retorno

Lista: una lista de ID de propósito.

Ejemplo
List<string> purposes = GetAllPurposes();

GetEnabledPurposes


Obtiene una lista de propósitos habilitados.

Tipo de retorno

Lista: una lista de ID de propósito habilitados.

Ejemplo
List<string> enabledPurposes = GetEnabledPurposes();

GetDisabledPropósitos


Obtiene una lista de propósitos deshabilitados.

Tipo de retorno

Lista: una lista de ID de propósito deshabilitados.

Ejemplo
List<string> disabledPurposes = GetDisabledPurposes();

Obtener todos los proveedores


Obtiene una lista de todos los proveedores disponibles.

Tipo de retorno

Lista: una lista de ID de proveedores.

Ejemplo
List<string> allVendors = GetAllVendors();

Obtener proveedores habilitados


Obtiene una lista de proveedores habilitados.

Tipo de retorno

Lista: una lista de ID de proveedores habilitados.

Ejemplo
List<string> enabledVendors = GetEnabledVendors();

Obtener proveedores discapacitados


Obtiene una lista de proveedores deshabilitados.

Tipo de retorno

Lista: una lista de ID de proveedores deshabilitados.

Ejemplo
List<string> disabledVendors = GetDisabledVendors();

ObtenerGoogleAcString


Obtiene la cadena de consentimiento del anunciante de Google.

Tipo de retorno

cadena: la cadena de consentimiento del anunciante de Google.

Ejemplo
string googleAcString = GetGoogleAcString();

GetUsPrivacyString


Obtiene la cadena de privacidad de EE. UU.

Tipo de retorno

cadena: la cadena de privacidad de EE. UU.

Ejemplo
string usPrivacyString = GetUsPrivacyString();

 

Resumen: 

 

Función Descripción parámetros
Inicializar Inicializa CMP Manager con dominio, ID de código, nombre de la aplicación e idioma. dominio, codeId, appName, idioma
Inicializar Inicializa CMP Manager con un objeto de configuración. configuración (CmpConfig)
Tiene consentimiento Comprueba si el usuario ha dado su consentimiento. Ninguna
TieneVendedor Comprueba si el usuario selecciona un proveedor con el ID especificado. identificación (cadena)
Tiene un propósito Comprueba si el usuario selecciona un propósito con el ID especificado. identificación (cadena)
Abrir capa de consentimiento Abre la capa de consentimiento para administrar la configuración de consentimiento del usuario. Ninguna
AbrirConsentLayerOnCheck Abre la capa de consentimiento si es necesario, según una verificación con el backend. Ninguna
Comprobar consentimiento es necesario Comprueba si es necesario abrir la capa de consentimiento. Ninguna
Aceptar todo Acepta todas las opciones de consentimiento. Ninguna
Rechazar todo Rechaza todas las opciones de consentimiento. Ninguna
Más información Inicia CMP Manager y muestra la capa de consentimiento si es necesario. Ninguna
Reanudar Restablece la configuración de CMP. Ninguna
ExportarCmpString Exporta la configuración de CMP como una cadena. Ninguna
ImportarCmpString Importa la configuración de CMP desde una cadena determinada. cmp (cadena)
ObtenerGoogleAcString Obtiene la cadena de consentimiento del anunciante de Google. Ninguna
GetUsPrivacyString Obtiene la cadena de privacidad de EE. UU. Ninguna
ObtenerLastATTTrackingRequestDate Obtiene la fecha de la última solicitud de transparencia de seguimiento de aplicaciones. Ninguna
Obtener estado del modo de consentimiento de Google Obtiene el estado actual del modo de consentimiento de Google. Ninguna
Obtener todos los propósitos Obtiene una lista de todos los propósitos disponibles. Ninguna
GetEnabledPurposes Obtiene una lista de propósitos habilitados. Ninguna
GetDisabledPropósitos Obtiene una lista de propósitos deshabilitados. Ninguna
Obtener todos los proveedores Obtiene una lista de todos los proveedores disponibles. Ninguna
Obtener proveedores habilitados Obtiene una lista de proveedores habilitados. Ninguna
Obtener proveedores discapacitados Obtiene una lista de proveedores deshabilitados. Ninguna
Establecer UIConfig Establece la configuración de la interfaz de usuario para la interfaz de usuario de CMP. cmpUIConfig (CmpUIConfig)
Solicitar permiso de seguimiento AT (Solo iOS) Solicita permiso de transparencia de seguimiento de aplicaciones. Ninguna

Descripción general de CmpUIConfig: 

 

Propiedad/Método Descripción Tipo/Parámetros
configuración de pantalla Propiedad para contener la configuración de pantalla elegida. Enumeración ScreenConfig
androidUiType (Solo Android) Tipo de interfaz de usuario para dispositivos Android. Enumeración AndroidUiType
AndroidFragmentContainerId (Solo Android) ID de contenedor para fragmento de Android. int
es enfocable (Solo Android) Si la interfaz de usuario debería poder enfocarse. bool
está afuera tocable (Solo Android) Si se debe detectar el toque exterior. bool
Establecer AndroidFragmentContainerId (Solo Android) Establece el ID del contenedor para el fragmento de Android. Yo dint)
EstablecerAndroidUiType (Solo Android) Establece el tipo de interfaz de usuario para Android. tipo (AndroidUiType)
CmpPuenteConjuntoConsentManagerModalPresentationStyleModalPresentationStyle (solo iOS) Establece el estilo de presentación modal mediante llamada externa. Estilo de presentación modal (int)
Configurar estilo de presentación modal (solo iOS) Configura el estilo de presentación modal para iOS. estilo (CmpIOSModalPresentationStyle)

 

Descripción general de CmpConfig:

 

Propiedad/Método Descripción Tipo/Parámetros
Constructor Inicializa la configuración de CMP con los parámetros necesarios. id, dominio, nombre de aplicación, idioma, uiConfig (opcional)
UIConfig Propiedad para contener la configuración de la interfaz de usuario. CmpUIConfig
IdfaOrGaid Identificador de Anunciantes o ID de Publicidad de Google. cadena
Tiempo de espera Tiempo de espera para operaciones CMP. int
Saltar a la página de configuración Si se debe saltar a la página de configuración automáticamente. bool
ID de diseño ID de diseño opcional para la personalización de la interfaz de usuario de CMP. ¿En t?
Depurar Habilita el modo de depuración. bool
Id El identificador único de la instancia de CMP. cadena (solo lectura)
Dominio El dominio asociado con la instancia de CMP. cadena (solo lectura)
Nombre de la aplicación El nombre de la aplicación que utiliza CMP. cadena (solo lectura)
Idioma El idioma para la interfaz de usuario y las operaciones de CMP. cadena (solo lectura)
Volver