[Unidad] 2. Documentación API
SDK obsoleto / Actualización a v3: Esta documentación describe la versión 2.x de nuestro SDK. El SDK 2.x está obsoleto y se eliminará a finales de 2025. Actualice a la versión 3.x del SDK. Consulte la sección de ayuda sobre SDK v3 aquí.
Agregar oyentes de eventos
Establece devoluciones de llamadas específicas de Android para eventos CMP.
Ejemplo
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Comprobar consentimiento es necesario
Comprueba si se requiere el consentimiento del usuario y, en caso afirmativo, abre la interfaz de usuario de la capa de consentimiento. Este método consume una página vista.
parámetros
| Ninguna. |
Ida y vuelta
TRUE Si se requiere el consentimiento del usuario
FALSE de otra manera.
Ejemplo
var isRequired = await _cmpManager.CheckConsentIsRequired();Descripción general de CmpUIConfig
| Propiedad/Método | Descripción original | Tipo/Parámetros |
|---|---|---|
screenConfig |
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 |
isFocusable (Solo Android)
|
Si la interfaz de usuario debería poder enfocarse. | bool |
isOutsideTouchable (Solo Android)
|
Si se debe detectar el toque exterior. | bool |
SetAndroidFragmentContainerId (Solo Android)
|
Establece el ID del contenedor para el fragmento de Android. | Yo dint) |
SetAndroidUiType (Solo Android)
|
Establece el tipo de interfaz de usuario para Android. | tipo (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (solo iOS)
|
Establece el estilo de presentación modal mediante llamada externa. | Estilo de presentación modal (int) |
ConfigureModalPresentationStyle (solo iOS)
|
Configura el estilo de presentación modal para iOS. | estilo (CmpIOSModalPresentationStyle) |
Descripción general de CmpConfig
| Propiedad/Método | Descripción original | 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) |
ExportarCmpString
Exporta la cadena CMP actual que representa las preferencias de consentimiento del usuario. Se accede a este método de forma estática. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Cordón: La configuración de CMP exportada como una cadena.
Ejemplo
string cmpSettings = ExportCmpString();Obtener todos los propósitos
Devuelve los identificadores de todos los propósitos. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de propósito.
Ejemplo
List<string> purposes = GetAllPurposes();Obtener todos los proveedores
Devuelve los identificadores de todos los proveedores de un CMP determinado. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de proveedores.
Ejemplo
List<string> allVendors = GetAllVendors();GetDisabledPropósitos
Devuelve todos los identificadores de propósitos deshabilitados para un CMP determinado. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de propósito deshabilitados.
Ejemplo
List<string> disabledPurposes = GetDisabledPurposes();
Obtener proveedores discapacitados
Devuelve todos los identificadores de proveedores deshabilitados para un CMP determinado. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de proveedores deshabilitados.
Ejemplo
List<string> disabledVendors = GetDisabledVendors();GetEnabledPurposes
Devuelve los identificadores de todos los propósitos habilitados para un CMP determinado. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de propósito habilitados.
Ejemplo
List<string> enabledPurposes = GetEnabledPurposes();Obtener proveedores habilitados
Devuelve todos los identificadores de proveedores habilitados para un CMP determinado. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
Lista: una lista de ID de proveedores habilitados.
Ejemplo
List<string> enabledVendors = GetEnabledVendors();ObtenerGoogleAcString
Recupera la cadena de ID de consentimiento adicional de Google ('addtlConsent') que fue establecida por el consent manager.
Para más información, consulte el Especificación técnica del consentimiento adicional de Google.
Este método no consume páginas vistas.
parámetros
| Ninguna |
Ida y vuelta
cadena: la cadena de consentimiento del anunciante de Google.
Ejemplo
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Recupera la cadena de privacidad de EE. UU. Esta cadena de privacidad de EE. UU. es una cookie que almacena información sobre las divulgaciones realizadas y las opciones seleccionadas por el visitante del sitio web con respecto a sus derechos como consumidor. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
cadena: la cadena de privacidad de EE. UU.
Ejemplo
string usPrivacyString = GetUsPrivacyString();Tiene consentimiento
Comprueba si el usuario ya ha dado su consentimiento. La capa de consentimiento puede tener la opción de simplemente cerrar la capa. En ese caso, el usuario no ha dado su consentimiento. Este método no consume páginas vistas.
parámetros
| Ninguna. |
Ida y vuelta
TRUE Si el usuario ha dado su consentimiento
FALSE de otra manera
Ejemplo
var hasConsent = _cmpManager.HasConsent();Tiene un propósito
Comprueba si el ID de propósito está habilitado según el consentimiento del usuario. Este método no consume páginas vistas.
parámetros
- id: El ID del propósito a verificar.
Ida y vuelta
TRUE Si se selecciona el propósito
FALSE de otra manera.
Ejemplo
bool result = _cmpManager.HasPurpose(purposeId);TieneVendedor
Comprueba si el ID del proveedor está habilitado según el consentimiento del usuario. Este método no consume páginas vistas.
parámetros
| Nombre y Apellido | Tipo | Descripción original |
id |
cadena | El ID del proveedor a verificar. Puede encontrar los ID de proveedores en su cuenta en Menú > CMP > Proveedores. |
Ida y vuelta
TRUE Si se selecciona el proveedor
FALSE de otra manera.
Ejemplo
bool result = HasVendor("vendorId");ImportarCmpString
Importa una cadena CMP que representa las preferencias de consentimiento del usuario. La cadena debe informarse TAL CUAL cuando se recupera a través del método exportCmpString()Este método consume una página vista.
parámetros
cadena: La cadena CMP
Ida y vuelta
CmpImportResultado:Resultado si la importación fue exitosa.
Ejemplo
result = await _cmpManager.ImportCmpString(cmpString);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 abrirá la capa de consentimiento e interactuará con la API de transparencia de seguimiento de Apple para solicitar el consentimiento del usuario. Este método consume una página vista.
parámetros
| Nombre y Apellido | Tipo | Descripción original |
domain |
Cordón | El dominio de la Plataforma de Gestión del Consentimiento. |
codeId |
Cordón | El ID del código de la aplicación. |
appName |
Cordón | El nombre de la aplicación. |
language |
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
}Lanzamiento (en desuso)
Inicia CmpManager y muestra la capa de consentimiento si es necesario.
Ejemplo
_cmpManager.Launch();Abrir capa de consentimiento
Abre a la fuerza la vista web de la capa de consentimiento de CMP. Este método consume una vista de página.
parámetros
| Ninguna. |
Ida y vuelta
| Ninguna. |
Ejemplo
_cmpManager.OpenConsentLayer();
AbrirConsentLayerOnCheck
Comprueba si se requiere el consentimiento del usuario y, en caso afirmativo, abre la vista web de la capa de consentimiento. Este método consume una vista de página.
parámetros
| Ninguna. |
Ida y vuelta
| Ninguna. |
Ejemplo
_cmpManager.OpenConsentLayerOnCheck();
