[Unity] 2. Dokumentacja API
Inicjalizacja
Inicjuje Consent Manager z podaną domeną, identyfikatorem kodu, nazwą aplikacji i językiem.
parametry
| Imię | Typ | Opis Projektu |
| domena | sznur | Domena Platformy Zarządzania Zgodami. |
| codeId | sznur | Identyfikator kodu aplikacji. |
| Nazwa aplikacji | sznur | Nazwa aplikacji. |
| język | sznur | Kod języka (np. „EN”, „DE”) dla lokalizacji. |
Przykład
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
}
Dodaj słuchaczy zdarzeń
Ustawia wywołania zwrotne specyficzne dla Androida dla zdarzeń CMP.
Przykład
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Premiera
Uruchamia CmpManager i w razie potrzeby wyświetla warstwę zgody
Przykład
_cmpManager.Launch();Ma zgodę
Sprawdza, czy użytkownik wyraził zgodę.
Powrót
true, jeśli użytkownik wyraził zgodę, false w przeciwnym razie.
Przykład
var hasConsent = _cmpManager.HasConsent();
Otwórz warstwę zgody
Otwiera warstwę zgody, w której można zarządzać ustawieniami zgody użytkownika.
Przykład
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Otwiera warstwę zgody, jeśli to konieczne na podstawie kontroli.
Przykład
_cmpManager.OpenConsentLayerOnCheck();MaSprzedawca
Sprawdza, czy użytkownik wybrał dostawcę o podanym identyfikatorze.
parametry
| Imię | Typ | Opis Projektu |
id |
ciąg | Identyfikator dostawcy do sprawdzenia. Identyfikatory dostawców znajdziesz na swoim koncie w menu > CMP > Dostawcy. |
Typ zwrotu
(liczba) true jeśli dostawca zostanie wybrany, false Inaczej.
Przykład
bool result = HasVendor("vendorId");Ma cel
Sprawdza, czy użytkownik wybrał cel o podanym identyfikatorze.
parametry
- id: Identyfikator celu sprawdzania.
Typ zwrotu
bool: Prawda, jeśli wybrano cel, w przeciwnym razie fałsz.
Przykład
bool result = _cmpManager.HasPurpose(purposeId);Sprawdź, czy zgoda jest wymagana
Sprawdza, czy użytkownik musi wyrazić zgodę
Typ zwrotu
bool: Prawda, jeśli wymagana jest zgoda
Przykład
var isRequired = await _cmpManager.CheckConsentIsRequired();EksportujCmpString
Eksportuje ustawienia platformy zarządzania zgodą (CMP) jako ciąg znaków.
Typ zwrotu
ciąg: Wyeksportowane ustawienia CMP jako ciąg znaków.
Przykład
string cmpSettings = ExportCmpString();ImportujCmpString
Zaimportuj ciąg znaków platformy zarządzania zgodą (CMP).
parametry
ciąg: Ciąg CMP
Typ zwrotu
Wynik importu Cmp: Wynik, jeśli import się powiódł
Przykład
result = await _cmpManager.ImportCmpString(cmpString);PobierzWszystkie Cele
Pobiera listę wszystkich dostępnych celów.
Typ zwrotu
Lista: lista identyfikatorów celów.
Przykład
List<string> purposes = GetAllPurposes();GetEnabledCele
Pobiera listę włączonych celów.
Typ zwrotu
Lista: lista włączonych identyfikatorów celów.
Przykład
List<string> enabledPurposes = GetEnabledPurposes();GetDisabledCele
Pobiera listę wyłączonych celów.
Typ zwrotu
Lista: lista wyłączonych identyfikatorów celów.
Przykład
List<string> disabledPurposes = GetDisabledPurposes();PobierzAllVendors
Pobiera listę wszystkich dostępnych dostawców.
Typ zwrotu
Lista: lista identyfikatorów dostawców.
Przykład
List<string> allVendors = GetAllVendors();GetEnabledVendors
Pobiera listę włączonych dostawców.
Typ zwrotu
Lista: lista włączonych identyfikatorów dostawców.
Przykład
List<string> enabledVendors = GetEnabledVendors();GetDisabledVendors
Pobiera listę wyłączonych dostawców.
Typ zwrotu
Lista: lista wyłączonych identyfikatorów dostawców.
Przykład
List<string> disabledVendors = GetDisabledVendors();PobierzGoogleAcString
Pobiera ciąg zgody reklamodawcy Google.
Typ zwrotu
ciąg: ciąg znaków zgody reklamodawcy Google.
Przykład
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Pobiera ciąg prywatności w USA.
Typ zwrotu
ciąg: ciąg znaków dotyczący prywatności w USA.
Przykład
string usPrivacyString = GetUsPrivacyString();
Przegląd:
| Funkcjonować | Opis Projektu | parametry |
|---|---|---|
| Inicjalizacja | Inicjuje Menedżera CMP z domeną, identyfikatorem kodu, nazwą aplikacji i językiem. | domena, codeId, nazwa aplikacji, język |
| Inicjalizacja | Inicjuje Menedżera CMP za pomocą obiektu konfiguracyjnego. | konfiguracja (CmpConfig) |
| Ma zgodę | Sprawdza, czy użytkownik wyraził zgodę. | żaden |
| MaSprzedawca | Sprawdza, czy użytkownik wybrał dostawcę o podanym identyfikatorze. | identyfikator (ciąg) |
| Ma cel | Sprawdza, czy użytkownik wybrał cel o podanym identyfikatorze. | identyfikator (ciąg) |
| Otwórz warstwę zgody | Otwiera warstwę zgody umożliwiającą zarządzanie ustawieniami zgody użytkownika. | żaden |
| OpenConsentLayerOnCheck | W razie potrzeby otwiera warstwę zgody na podstawie kontroli z backendem. | żaden |
| Sprawdź, czy zgoda jest wymagana | Sprawdza, czy konieczne jest otwarcie warstwy zgody. | żaden |
| Akceptuj wszystkie | Akceptuje wszystkie opcje zgody. | żaden |
| Odrzuć wszystko | Odrzuca wszystkie opcje zgody. | żaden |
| Premiera | Uruchamia Menedżera CMP i w razie potrzeby wyświetla warstwę zgody. | żaden |
| Zresetuj | Resetuje ustawienia CMP. | żaden |
| EksportujCmpString | Eksportuje ustawienia CMP jako ciąg znaków. | żaden |
| ImportujCmpString | Importuje ustawienia CMP z podanego ciągu znaków. | cmp (ciąg) |
| PobierzGoogleAcString | Pobiera ciąg zgody reklamodawcy Google. | żaden |
| GetUsPrivacyString | Pobiera ciąg prywatności w USA. | żaden |
| GetLastATTrackingRequestDate | Pobiera datę ostatniego żądania przejrzystości śledzenia aplikacji. | żaden |
| Uzyskaj stan GoogleConsentMode | Pobiera bieżący stan trybu zgody Google. | żaden |
| PobierzWszystkie Cele | Pobiera listę wszystkich dostępnych celów. | żaden |
| GetEnabledCele | Pobiera listę włączonych celów. | żaden |
| GetDisabledCele | Pobiera listę wyłączonych celów. | żaden |
| PobierzAllVendors | Pobiera listę wszystkich dostępnych dostawców. | żaden |
| GetEnabledVendors | Pobiera listę włączonych dostawców. | żaden |
| GetDisabledVendors | Pobiera listę wyłączonych dostawców. | żaden |
| UstawUIConfig | Ustawia konfigurację interfejsu użytkownika dla interfejsu użytkownika CMP. | cmpUIConfig (CmpUIConfig) |
| Poproś o pozwolenie na śledzenie | (tylko iOS) Żąda pozwolenia na przejrzystość śledzenia aplikacji. | żaden |
Przegląd CmpUIConfig:
| Właściwość/metoda | Opis Projektu | Typ/Parametry |
|---|---|---|
| konfiguracja ekranu | Właściwość przechowująca wybraną konfigurację ekranu. | Wyliczenie ScreenConfig |
| AndroidUiType (Tylko Android) | Typ interfejsu użytkownika dla urządzeń z systemem Android. | Wyliczenie AndroidUiType |
| androidFragmentContainerId (Tylko Android) | Identyfikator kontenera dla fragmentu Androida. | int |
| jest Fokusowalny (Tylko Android) | Jeśli interfejs użytkownika powinien umożliwiać skupienie. | bool |
| jestOutsideTouchable (Tylko Android) | Jeśli powinien zostać wykryty dotyk zewnętrzny. | bool |
| UstawAndroidFragmentContainerId (Tylko Android) | Ustawia identyfikator kontenera dla fragmentu Androida. | identyfikator (int) |
| UstawAndroidUiType (Tylko Android) | Ustawia typ interfejsu użytkownika dla Androida. | typ (AndroidUiType) |
| Zestaw CmpBridgeConsentManagerModalny styl prezentacji (tylko iOS) | Ustawia styl prezentacji modalnej za pośrednictwem połączenia zewnętrznego. | modalnyStylPrezencji (int) |
| Skonfiguruj styl ModalPresentation (tylko iOS) | Konfiguruje styl prezentacji modalnej dla systemu iOS. | styl (CmpIOSModalPresentationStyle) |
Przegląd konfiguracji CmpConfig:
| Właściwość/metoda | Opis Projektu | Typ/Parametry |
|---|---|---|
| Konstruktor | Inicjuje konfigurację CMP z niezbędnymi parametrami. | identyfikator, domena, nazwa aplikacji, język, uiConfig (opcjonalnie) |
| UIConfig | Właściwość do przechowywania konfiguracji interfejsu użytkownika. | CmpUIConfig |
| IdfaOrGaid | Identyfikator reklamodawców lub identyfikator reklamowy Google. | ciąg |
| Timeout | Limit czasu dla operacji CMP. | int |
| Przejdź do strony ustawień | Określa, czy automatycznie przejść do strony ustawień. | bool |
| Identyfikator projektu | Opcjonalny identyfikator projektu do dostosowywania interfejsu użytkownika CMP. | int? |
| Debug | Włącza tryb debugowania. | bool |
| Id | Unikalny identyfikator instancji CMP. | ciąg znaków (tylko do odczytu) |
| Domena | Domena powiązana z instancją CMP. | ciąg znaków (tylko do odczytu) |
| Nazwa aplikacji | Nazwa aplikacji korzystającej z CMP. | ciąg znaków (tylko do odczytu) |
| Wybierz język | Język interfejsu użytkownika i operacji CMP. | ciąg znaków (tylko do odczytu) |
