Informacia
Treść

[Jedność] 1. consentmanager Integracja SDK

W tym dokumencie znajdziesz ogólne informacje na temat integracji naszego SDK z Twoim projektem. Więcej szczegółów znajdziesz w naszym Dokumentacja API dokumentacja.

1. Instalacja

consentmanager SDK to kompleksowe rozwiązanie do zarządzania zgodą użytkownika w aplikacjach mobilnych. Zaprojektowany do obsługi zgodności z GDPR, preferencji prywatności użytkownika i przejrzystości śledzenia reklam, ten SDK zapewnia bezproblemową integrację z platformami iOS i Android. Ponadto oferuje wtyczki/mostki wrapper dla React Native, Flutter i Unity, co czyni go wszechstronnym w różnych środowiskach programistycznych.

Kroki — opis wysokiego poziomu

  1. Integracja i konfiguracja:

    • Zintegruj pakiet SDK ze swoją aplikacją.
    • Skonfiguruj ustawienia SDK zgodnie ze swoimi potrzebami.
  2. Tworzenie instancji i wyświetlanie warstwy zgody:

    • Podczas uruchamiania aplikacji utwórz instancję CMPManager klasa. Ta instancja będzie obsługiwać proces wyrażania zgody.
    • W razie potrzeby zestaw SDK automatycznie wyświetli ekran zgody.
  3. Przetwarzanie danych zgody użytkownika:

    • Po zebraniu zgód informacje są przechowywane i dostępne do zapytania za pośrednictwem różnych właściwości i metod udostępnianych przez nasz zestaw SDK. Będziesz mieć informacje o odrzuconych lub zaakceptowanych zgodach, dostawcach i celach.

Jeśli chodzi o kompatybilność, mamy:

  • Unity 20XX.XX lub nowsza wersja
  • iOS (przez DllImport)
  • Android (przez JNI)

1. Importowanie pakietu SDK

Wszystko możesz skonfigurować w zaledwie dwóch krokach.

    • Pobierz najnowszą wersję Wtyczki.
    • Zaimportuj pakiet do projektu Unity przy użyciu opcji Zasoby > Importuj pakiet > Pakiet niestandardowy.

Skonfiguruj JSON

W pliku CmpSdkConfig.json możesz ustawić natywną wersję SDK dla iOS i Androida, która będzie używana w procesie kompilacji: 

Znajdź kompatybilne natywne wersje SDK tutaj

{
  "displayName": "Consentmanager SDK",
  "name": "CmpSdk",
  "androidBasePath": "net.consentmanager.sdk",
  "version": "3.0.0",
  "androidLibraryVersion": "x.xx.x",
  "iosLibraryVersion": "x.xx.x",
  "description": "Unity plugin helps you to use native Consentmanager functionality on Android and iOS."
}

Ustawienia kompilacji

Aby zmienić ustawienia kompilacji, przejdź do Window -> CmpSdk 

pluginwindow-unity.png

Ustawienia kompilacji iOS

  • Włącz skrypt kompilacji iOS: Przełącz tę opcję, aby włączyć lub wyłączyć skrypt kompilacji odpowiedzialny za integrację zestawu SDK systemu iOS z projektem Unity.
  • Ścieżka xcFramework: Określ ścieżkę do katalogu xcFramework. Ścieżkę tę można edytować bezpośrednio lub przeglądać za pomocą dołączonego przycisku.
  • Dołącz znacznik wersji: Po włączeniu dołącza wersję zestawu SDK systemu iOS do ścieżki xcFramework, umożliwiając konfiguracje specyficzne dla wersji.
  • Wynikowa ścieżka struktury: Wyświetla w pełni rozpoznaną ścieżkę do xcFramework, w tym wersję zestawu SDK, jeśli uwzględniono znacznik wersji.
  • Włącz przejrzystość śledzenia aplikacji: Przełącz tę opcję, aby włączyć funkcję przejrzystości śledzenia aplikacji dla systemu iOS, która jest niezbędna do uzyskania zgody użytkownika zgodnie z wytycznymi dotyczącymi prywatności w systemie iOS.
  • Wiadomość o zgodzie na przejrzystość śledzenia aplikacji: Pole tekstowe umożliwiające wprowadzenie niestandardowej wiadomości wyświetlanej użytkownikom podczas żądania zgody na śledzenie. Komunikat ten powinien być jasny i zwięzły oraz wyjaśniać, dlaczego potrzebna jest zgoda.

Ustawienia kompilacji Androida

  • Włącz skrypt kompilacji Androida: Przełącz, aby włączyć lub wyłączyć skrypt kompilacji służący do integracji zestawu SDK systemu Android z projektem Unity. 
  • Zintegruj układ niestandardowy: Po włączeniu tej opcji umożliwia użycie niestandardowego układu warstwy zgody dla fragmentu UIView.

    Jeśli chcesz użyć niestandardowego układu z fragmentami, upewnij się, że Twój projekt Unity dodaje appcompat zależność. Dodaj niestandardowy szablon główny: 
    Zasoby/Wtyczki/Android/mainTemplate.gradle
    i dodaj zależność:
    implementacja „androidx.appcompat:appcompat:1.xx”

2. Korzystanie z SDK

Sprawdź poniższy przykład, aby zobaczyć ilustrację użycia naszego SDK. Aby uzyskać więcej informacji, zapoznaj się z pełnym Dokumentacja API.

Należy pamiętać, że funkcjonalności związane z określeniem, czy zgoda jest potrzebna, czy nie, a także wyświetlanie warstwy zgody zależą od niezawodnego połączenia sieciowego. Jeśli nie ma dostępnego połączenia lub jeśli mechanizm ponownej próby nie dotrze do naszego serwera, zdarzenie didReceiveError zwróci błąd limitu czasu, a zatem SDK nie będzie w stanie określić potrzeby zgody, ponieważ nie będzie w stanie wyświetlić warstwy zgody. Upewnij się, że Twoja logika to uwzględnia.

Przykładowy skrypt

    private static void CheckConsentWithServer(){     
    	CmpManager.Instance.CheckWithServerAndOpenIfNecessary();}
    }  
        
    private static void SetCmpUrlConfig() {
      	const string id = "id";           
      	const string domain = "domain";           
      	const string language = "en";           
      	const string appName = "AppName";           
      
      	CmpManager.Instance.SetUrlConfig(id, domain, language, appName);       
    }         
    
    private void OpenConsentLayer() {            
      	CmpManager.Instance.OpenConsentLayer();        
    }        
    
    private void JumpToSettings() {            
      	CmpManager.Instance.JumpToSettings();        
    }        
    
    private void HasVendorConsent(string vendorId) {            
      	var hasConsent = CmpManager.Instance.HasVendorConsent(vendorId);            
      	Debug.Log($"Has vendor consent: {hasConsent}");        
    }        
    
    private void HasPurposeConsent(string purposeId) {            
      	var hasConsent = CmpManager.Instance.HasPurposeConsent(purposeId);            
      	Debug.Log($"Has purpose consent: {hasConsent}");        
    }

    Logowanie

    Podczas korzystania z naszego zestawu SDK dla systemu iOS może zaistnieć potrzeba debugowania lub analizowania informacji z dziennika w różnych celach. Dzienniki generowane przez nasz zestaw SDK są oznaczone jako „CMP”, co pozwala na łatwe filtrowanie i przeglądanie tylko odpowiednich dzienników. Aby uzyskać więcej informacji, zapoznaj się z w tej sekcji naszej dokumentacji.

     

    Powrót do góry