[Unity] 2. API-Dokumentation
Initialisieren
Initialisiert die Consent Manager mit der angegebenen Domain, Code-ID, App-Namen und Sprache.
Parameter
| Name | Typ | Beschreibung |
| Domain | Schnur | Die Domäne der Consent Management Platform. |
| Code-ID | Schnur | Die Code-ID für die Anwendung. |
| App Name | Schnur | Der Name der Anwendung. |
| Sprache | Schnur | Der Sprachcode (z. B. „EN“, „DE“) für die Lokalisierung. |
Beispiel
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
}
AddEventListeners
Legt Android-spezifische Rückrufe für CMP-Ereignisse fest.
Beispiel
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Launch
Startet den CmpManager und zeigt bei Bedarf die Einwilligungsebene an
Beispiel
_cmpManager.Launch();HasConsent
Prüft, ob der Benutzer seine Einwilligung gegeben hat.
Return
true, wenn der Benutzer seine Einwilligung gegeben hat, andernfalls false.
Beispiel
var hasConsent = _cmpManager.HasConsent();
OpenConsentLayer
Öffnet die Einwilligungsebene zum Verwalten der Einwilligungseinstellungen des Benutzers.
Beispiel
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Öffnet bei Bedarf den Consent Layer basierend auf Prüfungen.
Beispiel
_cmpManager.OpenConsentLayerOnCheck();HasVendor
Prüft, ob ein Anbieter mit der angegebenen ID vom Benutzer ausgewählt wurde.
Parameter
| Name | Typ | Beschreibung |
id |
Schnur | Die ID des zu prüfenden Anbieters. Die Anbieter-IDs finden Sie in Ihrem Konto unter Menü > CMPs > Anbieter. |
Rückgabetyp
(boolesch) true wenn der Anbieter ausgewählt ist, false Andernfalls.
Beispiel
bool result = HasVendor("vendorId");HasPurpose
Prüft, ob ein Zweck mit der angegebenen ID vom Benutzer ausgewählt wurde.
Parameter
- id: Die ID des zu prüfenden Zwecks.
Rückgabetyp
bool: True, wenn der Zweck ausgewählt ist, andernfalls false.
Beispiel
bool result = _cmpManager.HasPurpose(purposeId);CheckConsentIsRequired
Prüft, ob der Benutzer seine Einwilligung geben muss
Rückgabetyp
bool: True, wenn eine Einwilligung erforderlich ist
Beispiel
var isRequired = await _cmpManager.CheckConsentIsRequired();ExportCmpString
Exportiert die Einstellungen der Consent Management Platform (CMP) als Zeichenfolge.
Rückgabetyp
Schnur: Die exportierten CMP-Einstellungen als Zeichenfolge.
Beispiel
string cmpSettings = ExportCmpString();ImportCmpString
Importieren Sie die Consent Management Platform (CMP)-Zeichenfolge.
Parameter
Schnur: Die CMP-Zeichenfolge
Rückgabetyp
CmpImportResult: Ergebnis, wenn der Import erfolgreich war
Beispiel
result = await _cmpManager.ImportCmpString(cmpString);GetAllPurposes
Ruft eine Liste aller verfügbaren Zwecke ab.
Rückgabetyp
Aufführen: Eine Liste von Zweck-IDs.
Beispiel
List<string> purposes = GetAllPurposes();GetEnabledPurposes
Ruft eine Liste der aktivierten Zwecke ab.
Rückgabetyp
Aufführen: Eine Liste der aktivierten Zweck-IDs.
Beispiel
List<string> enabledPurposes = GetEnabledPurposes();GetDisabledPurposes
Ruft eine Liste deaktivierter Zwecke ab.
Rückgabetyp
Aufführen: Eine Liste deaktivierter Zweck-IDs.
Beispiel
List<string> disabledPurposes = GetDisabledPurposes();GetAllVendors
Ruft eine Liste aller verfügbaren Anbieter ab.
Rückgabetyp
Aufführen: Eine Liste von Anbieter-IDs.
Beispiel
List<string> allVendors = GetAllVendors();GetEnabledVendors
Ruft eine Liste der aktivierten Anbieter ab.
Rückgabetyp
Aufführen: Eine Liste der aktivierten Anbieter-IDs.
Beispiel
List<string> enabledVendors = GetEnabledVendors();GetDisabledVendors
Ruft eine Liste deaktivierter Anbieter ab.
Rückgabetyp
Aufführen: Eine Liste deaktivierter Anbieter-IDs.
Beispiel
List<string> disabledVendors = GetDisabledVendors();GetGoogleAcString
Ruft die Google Advertiser Consent-Zeichenfolge ab.
Rückgabetyp
Schnur: Die Google Advertiser Consent-Zeichenfolge.
Beispiel
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Ruft die US-Datenschutzzeichenfolge ab.
Rückgabetyp
Schnur: Die US-Datenschutzzeichenfolge.
Beispiel
string usPrivacyString = GetUsPrivacyString();
Überblick:
| Funktion | Beschreibung | Parameter |
|---|---|---|
| Initialisieren | Initialisiert den CMP-Manager mit Domäne, Code-ID, App-Namen und Sprache. | Domäne, Code-ID, AppName, Sprache |
| Initialisieren | Initialisiert den CMP-Manager mit einem Konfigurationsobjekt. | config (CmpConfig) |
| HasConsent | Prüft, ob der Benutzer seine Einwilligung gegeben hat. | Keine |
| HasVendor | Überprüft, ob ein Anbieter mit der angegebenen ID vom Benutzer ausgewählt wird. | ID (Zeichenfolge) |
| HasPurpose | Prüft, ob ein Zweck mit der angegebenen ID vom Benutzer ausgewählt wird. | ID (Zeichenfolge) |
| OpenConsentLayer | Öffnet die Einwilligungsebene zum Verwalten der Benutzereinwilligungseinstellungen. | Keine |
| OpenConsentLayerOnCheck | Öffnet bei Bedarf den Consent Layer, basierend auf einer Prüfung mit dem Backend. | Keine |
| CheckConsentIsRequired | Überprüft, ob das Öffnen der Einwilligungsschicht erforderlich ist. | Keine |
| Akzeptiere alle | Akzeptiert alle Zustimmungsoptionen. | Keine |
| Alles ablehnen | Lehnt alle Zustimmungsoptionen ab. | Keine |
| Launch | Startet den CMP-Manager und zeigt bei Bedarf die Einwilligungsebene an. | Keine |
| Zurücksetzen | Setzt die CMP-Einstellungen zurück. | Keine |
| ExportCmpString | Exportiert CMP-Einstellungen als Zeichenfolge. | Keine |
| ImportCmpString | Importiert CMP-Einstellungen aus einer bestimmten Zeichenfolge. | cmp (Zeichenfolge) |
| GetGoogleAcString | Ruft die Google Advertiser Consent-Zeichenfolge ab. | Keine |
| GetUsPrivacyString | Ruft die US-Datenschutzzeichenfolge ab. | Keine |
| GetLastATTrackingRequestDate | Ruft das Datum der letzten App-Tracking-Transparenzanfrage ab. | Keine |
| GetGoogleConsentModeStatus | Ruft den aktuellen Status des Google Consent Mode ab. | Keine |
| GetAllPurposes | Ruft eine Liste aller verfügbaren Zwecke ab. | Keine |
| GetEnabledPurposes | Ruft eine Liste der aktivierten Zwecke ab. | Keine |
| GetDisabledPurposes | Ruft eine Liste deaktivierter Zwecke ab. | Keine |
| GetAllVendors | Ruft eine Liste aller verfügbaren Anbieter ab. | Keine |
| GetEnabledVendors | Ruft eine Liste der aktivierten Anbieter ab. | Keine |
| GetDisabledVendors | Ruft eine Liste deaktivierter Anbieter ab. | Keine |
| SetUIConfig | Legt die UI-Konfiguration für die CMP-UI fest. | cmpUIConfig (CmpUIConfig) |
| RequestATTrackingPermission | (Nur iOS) Fordert die Berechtigung zur App-Tracking-Transparenz an. | Keine |
CmpUIConfig-Übersicht:
| Eigenschaft/Methode | Beschreibung | Typ/Parameter |
|---|---|---|
| screenConfig | Eigenschaft zum Speichern der gewählten Bildschirmkonfiguration. | ScreenConfig-Enumeration |
| androidUiType (Nur Android) | UI-Typ für Android-Geräte. | AndroidUiType-Enumeration |
| androidFragmentContainerId (Nur Android) | Container-ID für Android-Fragment. | int |
| ist fokussierbar (Nur Android) | Wenn die Benutzeroberfläche fokussierbar sein soll. | bool |
| isOutsideTouchable (Nur Android) | Wenn die äußere Berührung erkannt werden soll. | bool |
| SetAndroidFragmentContainerId (Nur Android) | Legt die Container-ID für das Android-Fragment fest. | id (int) |
| SetAndroidUiType (Nur Android) | Legt den UI-Typ für Android fest. | Typ (AndroidUiType) |
| CmpBridgeSetConsentManagerModalPresentationStyle (nur iOS) | Legt den modalen Präsentationsstil per externem Aufruf fest. | modalPresentationStyle (int) |
| Konfigurieren Sie ModalPresentationStyle (nur iOS) | Konfiguriert den modalen Präsentationsstil für iOS. | Stil (CmpIOSModalPresentationStyle) |
CmpConfig-Übersicht:
| Eigenschaft/Methode | Beschreibung | Typ/Parameter |
|---|---|---|
| Bauherr | Initialisiert die CMP-Konfiguration mit den erforderlichen Parametern. | ID, Domäne, AppName, Sprache, uiConfig (optional) |
| UIConfig | Eigenschaft zum Speichern der UI-Konfiguration. | CmpUIConfig |
| IdfaOrGaid | Kennung für Werbetreibende oder Google-Werbe-ID. | Schnur |
| Timeout | Timeout für CMP-Vorgänge. | int |
| JumpToSettingsPage | Ob automatisch zur Einstellungsseite gesprungen werden soll. | bool |
| DesignId | Optionale Design-ID für die Anpassung der CMP-Benutzeroberfläche. | Int? |
| Debuggen | Aktiviert den Debug-Modus. | bool |
| Id | Der eindeutige Bezeichner für die CMP-Instanz. | Zeichenfolge (schreibgeschützt) |
| Domain | Die mit der CMP-Instanz verknüpfte Domäne. | Zeichenfolge (schreibgeschützt) |
| App Name | Der Name der Anwendung, die CMP verwendet. | Zeichenfolge (schreibgeschützt) |
| Sprache | Die Sprache für die CMP-Benutzeroberfläche und -Vorgänge. | Zeichenfolge (schreibgeschützt) |
