Info
Innehåll

[Enhet] 1. consentmanager SDK-integration

I det här dokumentet hittar du allmän information om hur du integrerar vår SDK i ditt projekt. För ytterligare information, se vår API-referens dokumentation.

1. Installation

consentmanager SDK är en heltäckande lösning för att hantera användarsamtycke i mobilapplikationer. Designad för att hantera GDPR-efterlevnad, användarnas integritetspreferenser och insyn i annonsspårning, ger denna SDK en sömlös integration för iOS- och Android-plattformar. Dessutom erbjuder den omslagsplugins/bryggor för React Native, Flutter och Unity, vilket gör den mångsidig i olika utvecklingsmiljöer.

Steg - Beskrivning på hög nivå

  1. Integration och konfiguration:

    • Integrera SDK:n i din app.
    • Konfigurera SDK-inställningarna efter dina behov.
  2. Skapa en instans och visa samtyckeslagret:

    • Vid appstart skapar du en instans av CMPManager klass. Denna instans kommer att hantera samtyckesprocessen.
    • SDK:n visar automatiskt samtyckesskärmen vid behov.
  3. Bearbetar användarens samtyckesdata:

    • När samtycken har samlats in lagras informationen och är tillgänglig för frågor genom olika egenskaper och metoder som exponeras av vår SDK. Du kommer att ha information om avvisade eller accepterade samtycken, leverantörer och syften.

När det gäller kompatibilitet har vi:

  • Unity 20XX.XX eller senare
  • iOS (via DllImport)
  • Android (via JNI)

1. Importera SDK-paketet

Med bara två steg kan du ställa in allt.

Konfigurera JSON

I CmpSdkConfig.json kan du ställa in den ursprungliga SDK-versionen för iOS och Android som kommer att användas för byggprocessen: 

Hitta de kompatibla inbyggda SDK-versionerna här.

{
  "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."
}

Bygg inställningar

Gå till för att ändra bygginställningarna Window -> CmpSdk 

pluginwindow-unity.png

iOS Bygginställningar

  • Aktivera iOS Build Script: Växla detta för att aktivera eller inaktivera byggskriptet som ansvarar för att integrera iOS SDK i Unity-projektet.
  • xcFramework-sökväg: Ange sökvägen till xcFramework-katalogen. Den här sökvägen kan redigeras direkt eller bläddra till med hjälp av den medföljande knappen.
  • Inkludera versionstagg: När det är aktiverat lägger du till iOS SDK-versionen till xcFramework-sökvägen, vilket möjliggör versionsspecifika konfigurationer.
  • Resulterande ramväg: Visar den fullständigt lösta sökvägen till xcFramework, inklusive SDK-versionen om versionstaggen ingår.
  • Aktivera insyn i appspårning: Växla detta för att aktivera funktionen App Tracking Transparency för iOS, vilket är nödvändigt för användarens samtycke enligt iOS sekretessriktlinjer.
  • App Tracking Transparency Consent Message: Ett textfält för att mata in det anpassade meddelande som visas för användare när de begär samtycke för spårning. Detta meddelande bör vara tydligt och kortfattat och förklara varför samtycke behövs.

Android Build-inställningar

  • Aktivera Android Build Script: Växla för att aktivera eller inaktivera byggskriptet för att integrera Android SDK i Unity-projektet. 
  • Integrera anpassad layout: När det är aktiverat tillåter detta användning av en anpassad layout för samtyckesskiktet för fragmentet UIView.

    Om du är villig att använda en anpassad layout med fragment, se till att ditt Unity-projekt lägger till appcompat beroende. Lägg till en anpassad huvudmall: 
    Tillgångar/Plugins/Android/mainTemplate.gradle
    och lägg till beroendet:
    implementering 'androidx.appcompat:appcompat:1.xx'

2. Använda SDK

Kontrollera exemplet nedan för att se en illustration av användningen av vår SDK. För ytterligare information, se hela API-referens.

Observera att funktionerna för att avgöra om samtycke behövs eller inte, liksom visningen av samtyckesskiktet, beror på en tillförlitlig nätverksanslutning. Om det inte finns någon tillgänglig anslutning eller om mekanismen för ett nytt försök misslyckas med att nå vår server, kommer didReceiveError-händelsen att returnera ett timeout-fel, och så SDK:n kommer att vara helt oförmögen att avgöra behovet av ett samtycke, eftersom det kommer att vara helt oförmöget att visa samtyckeslagret. Se till att din logik tar hänsyn till detta.

Exempelskript

    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}");        
    }

    Loggning

    När du använder vår iOS SDK kan du behöva felsöka eller analysera logginformation för olika ändamål. Loggarna som genereras av vår SDK är taggade under "CMP", vilket gör att du enkelt kan filtrera och bara visa relevanta loggar. För ytterligare information, se Den här delen av vår dokumentation.

     

    Tillbaka till toppen