[Unity] 2. Dokumentacja API
Wycofany zestaw SDK / Aktualizacja do wersji 3: Ta dokumentacja opisuje wersję 2.x naszego SDK. Wersja 2.x SDK jest przestarzała i zostanie usunięta do EOY 2025. Prosimy o uaktualnienie do wersji SDK 3.x. Zobacz sekcję Pomocy dotyczącą SDK v3 tutaj.
Dodaj słuchaczy zdarzeń
Ustawia wywołania zwrotne specyficzne dla Androida dla zdarzeń CMP.
Przykład
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Sprawdź, czy zgoda jest wymagana
Sprawdza, czy wymagana jest zgoda użytkownika i jeśli tak, otwiera interfejs użytkownika warstwy zgody. Ta metoda zużywa jedną odsłonę strony.
parametry
| Brak. |
Powrót
TRUE jeśli wymagana jest zgoda użytkownika
FALSE Inaczej.
Przykład
var isRequired = await _cmpManager.CheckConsentIsRequired();Przegląd CmpUIConfig
| Właściwość/metoda | Opis | Typ/Parametry |
|---|---|---|
screenConfig |
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 |
isFocusable (Tylko Android)
|
Jeśli interfejs użytkownika powinien umożliwiać skupienie. | bool |
isOutsideTouchable (Tylko Android)
|
Jeśli powinien zostać wykryty dotyk zewnętrzny. | bool |
SetAndroidFragmentContainerId (Tylko Android)
|
Ustawia identyfikator kontenera dla fragmentu Androida. | identyfikator (int) |
SetAndroidUiType (Tylko Android)
|
Ustawia typ interfejsu użytkownika dla Androida. | typ (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (Tylko iOS)
|
Ustawia styl prezentacji modalnej za pośrednictwem połączenia zewnętrznego. | modalnyStylPrezencji (int) |
ConfigureModalPresentationStyle (Tylko iOS)
|
Konfiguruje styl prezentacji modalnej dla systemu iOS. | styl (CmpIOSModalPresentationStyle) |
Przegląd CmpConfig
| Właściwość/metoda | Opis | 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) |
EksportujCmpString
Eksportuje bieżący ciąg CMP reprezentujący preferencje zgody użytkownika. Ta metoda jest dostępna w sposób statyczny. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
sznur: Wyeksportowane ustawienia CMP jako ciąg znaków.
Przykład
string cmpSettings = ExportCmpString();PobierzWszystkie Cele
Zwraca identyfikatory wszystkich celów. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista identyfikatorów celów.
Przykład
List<string> purposes = GetAllPurposes();PobierzAllVendors
Zwraca identyfikatory wszystkich dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista identyfikatorów dostawców.
Przykład
List<string> allVendors = GetAllVendors();GetDisabledCele
Zwraca wszystkie wyłączone identyfikatory celów dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista wyłączonych identyfikatorów celów.
Przykład
List<string> disabledPurposes = GetDisabledPurposes();
GetDisabledVendors
Zwraca wszystkie wyłączone identyfikatory dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista wyłączonych identyfikatorów dostawców.
Przykład
List<string> disabledVendors = GetDisabledVendors();GetEnabledCele
Zwraca wszystkie włączone identyfikatory celów dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista włączonych identyfikatorów celów.
Przykład
List<string> enabledPurposes = GetEnabledPurposes();GetEnabledVendors
Zwraca wszystkie włączone identyfikatory dostawców dla danego CMP. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
Lista: lista włączonych identyfikatorów dostawców.
Przykład
List<string> enabledVendors = GetEnabledVendors();PobierzGoogleAcString
Pobiera ciąg znaków dodatkowego identyfikatora zgody Google („addtlConsent”) ustawiony przez consent manager.
Aby uzyskać więcej informacji, sprawdź Specyfikacja techniczna dodatkowej zgody Google.
Metoda ta nie zużywa żadnej liczby odsłon.
parametry
| żaden |
Powrót
ciąg: ciąg znaków zgody reklamodawcy Google.
Przykład
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Pobiera US Privacy String. Ten US privacy string to plik cookie, który przechowuje informacje o ujawnieniach dokonanych i wyborach dokonanych przez odwiedzającego witrynę w odniesieniu do jego praw konsumenckich. Ta metoda nie zużywa żadnych odsłon stron.
parametry
| Brak. |
Powrót
ciąg: ciąg znaków dotyczący prywatności w USA.
Przykład
string usPrivacyString = GetUsPrivacyString();Ma zgodę
Sprawdza, czy użytkownik już wyraził zgodę. Warstwa zgody może mieć opcję po prostu zamknięcia warstwy. W takim przypadku użytkownik nie wyraził zgody. Ta metoda nie zużywa żadnych odsłon.
parametry
| Brak. |
Powrót
TRUE jeśli użytkownik wyraził zgodę
FALSE Inaczej
Przykład
var hasConsent = _cmpManager.HasConsent();Ma cel
Sprawdza, czy identyfikator celu jest włączony na podstawie zgody użytkownika. Ta metoda nie zużywa żadnych odsłon.
parametry
- id: Identyfikator celu sprawdzania.
Powrót
TRUE jeśli cel jest wybrany
FALSE Inaczej.
Przykład
bool result = _cmpManager.HasPurpose(purposeId);MaSprzedawca
Sprawdza, czy identyfikator dostawcy jest włączony na podstawie zgody użytkownika. Ta metoda nie zużywa żadnych odsłon.
parametry
| Imię | Typ | Opis |
id |
ciąg | Identyfikator dostawcy do sprawdzenia. Identyfikatory dostawców znajdziesz na swoim koncie w menu > CMP > Dostawcy. |
Powrót
TRUE jeśli wybrano dostawcę
FALSE Inaczej.
Przykład
bool result = HasVendor("vendorId");ImportujCmpString
Importuje ciąg CMP reprezentujący preferencje dotyczące zgody użytkownika. Ciąg musi zostać poinformowany w stanie AS-IS podczas pobierania za pomocą metody exportCmpString(). Ta metoda zużywa jedną odsłonę.
parametry
ciąg: Ciąg CMP
Powrót
Wynik importu Cmp: Wynik, jeśli import się powiódł.
Przykład
result = await _cmpManager.ImportCmpString(cmpString);Inicjalizacja
Funkcja Initialize zainicjuje warstwę zgody i automatycznie sprawdzi, czy użytkownik potrzebuje zgody, czy nie. Ta funkcja ostatecznie otworzy warstwę zgody i będzie współpracować z Apple Tracking Transparency API, aby poprosić użytkownika o zgodę. Ta metoda zużywa jedną odsłonę strony.
parametry
| Imię | Typ | Opis |
domain |
sznur | Domena Platformy Zarządzania Zgodami. |
codeId |
sznur | Identyfikator kodu aplikacji. |
appName |
sznur | Nazwa aplikacji. |
language |
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
}Uruchomienie (wycofane)
Uruchamia CmpManager i, jeśli to konieczne, wyświetla warstwę zgody.
Przykład
_cmpManager.Launch();Otwórz warstwę zgody
Otwiera siłą webview warstwy zgody CMP. Ta metoda zużywa jedną odsłonę strony.
parametry
| Brak. |
Powrót
| Brak. |
Przykład
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Sprawdza, czy wymagana jest zgoda użytkownika i jeśli tak, otwiera webview warstwy zgody. Ta metoda zużywa jedną odsłonę strony.
parametry
| Brak. |
Powrót
| Brak. |
Przykład
_cmpManager.OpenConsentLayerOnCheck();
