[Unity] 2. API-Dokumentation
AddEventListeners
Legt Android-spezifische Rückrufe für CMP-Ereignisse fest.
Beispiel
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);CheckConsentIsRequired
Überprüft, ob die Zustimmung des Benutzers erforderlich ist, und öffnet, wenn ja, die Benutzeroberfläche der Zustimmungsebene. Diese Methode verbraucht einen Seitenaufruf.
Parameter
| Keiner. |
Return
TRUE wenn die Einwilligung des Nutzers erforderlich ist
FALSE Andernfalls.
Beispiel
var isRequired = await _cmpManager.CheckConsentIsRequired();CmpUIConfig-Übersicht
| Eigenschaft/Methode | Beschreibung | Typ/Parameter |
|---|---|---|
screenConfig |
Eigenschaft zum Speichern der gewählten Bildschirmkonfiguration. | ScreenConfig-Enumeration |
androidUiType (Nur für Android)
|
UI-Typ für Android-Geräte. | AndroidUiType-Enumeration |
androidFragmentContainerId (Nur für Android)
|
Container-ID für Android-Fragment. | int |
isFocusable (Nur für Android)
|
Wenn die Benutzeroberfläche fokussierbar sein soll. | bool |
isOutsideTouchable (Nur für Android)
|
Wenn die äußere Berührung erkannt werden soll. | bool |
SetAndroidFragmentContainerId (Nur für Android)
|
Legt die Container-ID für das Android-Fragment fest. | id (int) |
SetAndroidUiType (Nur für Android)
|
Legt den UI-Typ für Android fest. | Typ (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (Nur für iOS)
|
Legt den modalen Präsentationsstil per externem Aufruf fest. | modalPresentationStyle (int) |
ConfigureModalPresentationStyle (Nur für 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) |
ExportCmpString
Exportiert die aktuelle CMP-Zeichenfolge, die die Zustimmungseinstellungen des Benutzers darstellt. Auf diese Methode wird statisch zugegriffen. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Schnur: Die exportierten CMP-Einstellungen als Zeichenfolge.
Beispiel
string cmpSettings = ExportCmpString();GetAllPurposes
Gibt die IDs aller Zwecke zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste von Zweck-IDs.
Beispiel
List<string> purposes = GetAllPurposes();GetAllVendors
Gibt alle Anbieter-IDs für ein bestimmtes CMP zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste von Anbieter-IDs.
Beispiel
List<string> allVendors = GetAllVendors();GetDisabledPurposes
Gibt alle deaktivierten Zweck-IDs für ein bestimmtes CMP zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste deaktivierter Zweck-IDs.
Beispiel
List<string> disabledPurposes = GetDisabledPurposes();
GetDisabledVendors
Gibt alle deaktivierten Anbieter-IDs für ein bestimmtes CMP zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste deaktivierter Anbieter-IDs.
Beispiel
List<string> disabledVendors = GetDisabledVendors();GetEnabledPurposes
Gibt alle aktivierten Zweck-IDs für ein bestimmtes CMP zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste der aktivierten Zweck-IDs.
Beispiel
List<string> enabledPurposes = GetEnabledPurposes();GetEnabledVendors
Gibt alle aktivierten Anbieter-IDs für ein bestimmtes CMP zurück. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Aufführen: Eine Liste der aktivierten Anbieter-IDs.
Beispiel
List<string> enabledVendors = GetEnabledVendors();GetGoogleAcString
Ruft die zusätzliche Google-Einwilligungs-ID ('addtlConsent') ab, die vom consent manager.
Weitere Informationen finden Sie im Technische Spezifikation für die zusätzliche Zustimmung zu Google.
Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keine |
Return
Schnur: Die Google Advertiser Consent-Zeichenfolge.
Beispiel
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Ruft den US-Datenschutz-String ab. Dieser US-Datenschutz-String ist ein Cookie, der Informationen über vom Website-Besucher vorgenommene Offenlegungen und ausgewählte Entscheidungen bezüglich seiner Verbraucherrechte speichert. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
Schnur: Die US-Datenschutzzeichenfolge.
Beispiel
string usPrivacyString = GetUsPrivacyString();HasConsent
Überprüft, ob der Benutzer bereits seine Zustimmung gegeben hat. Die Zustimmungsebene kann die Option enthalten, die Ebene einfach zu schließen. In diesem Fall hat der Benutzer keine Zustimmung gegeben. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
| Keiner. |
Return
TRUE ob der Nutzer eingewilligt hat
FALSE Andernfalls
Beispiel
var hasConsent = _cmpManager.HasConsent();HasPurpose
Überprüft, ob die Zweck-ID basierend auf der Benutzereinwilligung aktiviert ist. Diese Methode verbraucht keine Seitenaufrufe.
Parameter
- id: Die ID des zu prüfenden Zwecks.
Return
TRUE wenn der Zweck ausgewählt ist
FALSE Andernfalls.
Beispiel
bool result = _cmpManager.HasPurpose(purposeId);HasVendor
Überprüft, ob die Anbieter-ID basierend auf der Benutzereinwilligung aktiviert ist. Diese Methode verbraucht keine Seitenaufrufe.
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. |
Return
TRUE wenn der Lieferant ausgewählt ist
FALSE Andernfalls.
Beispiel
bool result = HasVendor("vendorId");ImportCmpString
Importiert eine CMP-Zeichenfolge, die die Zustimmungseinstellungen des Benutzers darstellt. Der String muss unverändert übermittelt werden, wenn er über die Methode exportCmpString() abgerufen wird.. Diese Methode verbraucht einen Seitenaufruf.
Parameter
Schnur: Die CMP-Zeichenfolge
Return
CmpImportResult: Ergebnis, wenn der Import erfolgreich war.
Beispiel
result = await _cmpManager.ImportCmpString(cmpString);Initialisieren
Die Initialisierungsfunktion initialisiert die Zustimmungsebene und prüft automatisch, ob der Benutzer eine Zustimmung benötigt oder nicht. Diese Funktion öffnet schließlich die Zustimmungsebene und interagiert mit der Apple Tracking Transparency API, um den Benutzer um Zustimmung zu bitten. Diese Methode verbraucht einen Seitenaufruf.
Parameter
| Name | Typ | Beschreibung |
domain |
Schnur | Die Domäne der Consent Management Platform. |
codeId |
Schnur | Die Code-ID für die Anwendung. |
appName |
Schnur | Der Name der Anwendung. |
language |
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
}Starten (veraltet)
Startet den CmpManager und zeigt bei Bedarf die Consent-Ebene an.
Beispiel
_cmpManager.Launch();OpenConsentLayer
Öffnet zwangsweise die CMP-Zustimmungsebene-Webansicht. Diese Methode verbraucht eine Seitenansicht.
Parameter
| Keiner. |
Return
| Keiner. |
Beispiel
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Überprüft, ob die Zustimmung des Benutzers erforderlich ist, und öffnet, wenn ja, die Webansicht der Zustimmungsebene. Diese Methode verbraucht einen Seitenaufruf.
Parameter
| Keiner. |
Return
| Keiner. |
Beispiel
_cmpManager.OpenConsentLayerOnCheck();
