Informatie
Beschrijving
Boeken
CMP
Integratie in uw ...
[Android] 1. toestemming...

[Android] 1. consentmanager SDK-integratie

In dit document vindt u algemene informatie over hoe u onze SDK in uw project kunt integreren. Voor meer details verwijzen wij u naar onze API-referentie documentatie. Alle onderstaande codefragmenten zijn uit onze Demo-app. 

1. Installatie

consentmanager SDK is een uitgebreide oplossing voor het beheren van gebruikerstoestemming in mobiele applicaties. Deze SDK is ontworpen om GDPR-naleving, gebruikersprivacyvoorkeuren en transparantie bij het volgen van advertenties te verwerken en biedt een naadloze integratie voor iOS- en Android-platforms. Daarnaast biedt het wrapper-plugins/bruggen voor React Native, Flutter en Unity, waardoor het veelzijdig is in verschillende ontwikkelomgevingen.

Stappen - Beschrijving op hoog niveau

  1. Integratie en configuratie:

    • Integreer de SDK in uw app.
    • Configureer de SDK-instellingen volgens uw behoeften.

  2. Een instantie maken en de toestemmingslaag weergeven:

    • Maak bij het opstarten van de app een exemplaar van het CMPManager klas. Deze instantie zal het toestemmingsproces afhandelen.
    • De SDK geeft indien nodig automatisch het toestemmingsscherm weer.

  3. Verwerking van toestemmingsgegevens van gebruikers:

    • Zodra toestemmingen zijn verzameld, wordt informatie opgeslagen en is deze beschikbaar voor query's via verschillende eigenschappen en methoden die door onze SDK worden blootgesteld. U krijgt informatie over afgewezen of geaccepteerde toestemmingen, leveranciers en doeleinden.

1.1 Integratie en configuratie

Afhankelijkheid toevoegen via Gradle

Voeg de volgende regel toe aan uw build.gradle-bestand:

dependencies {
    implementation "net.consentmanager.sdkv3:cmsdkv3:3.2.0"
}

Synchroniseer vervolgens uw project. 

1.2 Een instantie maken en de toestemmingslaag weergeven

Binnen de app-start (uw onCreate function), moet u een instantie van klasse maken CMPManager. U moet twee objecten instellen die worden doorgegeven aan de getInstance-methode: UrlConfig, die uw CMP-configuratie afhandelt, zoals Code-ID en standaardtaal, en ConsentLayerUIConfig. die de looks van de WebView configureert die de toestemmingslaag zal weergeven. Daarna geeft u de huidige Activity met behulp van de methode setActivity, en ken de gedelegeerde toe, zoals hieronder getoond. In het onderstaande voorbeeld kunt u beide objecten vinden die worden doorgegeven. De checkWithServerAndOpenIfNecessary() functie haalt automatisch de benodigde gegevens op van onze server en bepaalt of het toestemmingsscherm moet worden weergegeven of niet. Als dat zo is, toont de SDK op dit punt automatisch het toestemmingsscherm, via een WebView gemaakt door onze SDK, die de toestemmingslaag weergeeft met de tekst en knoppen volgens uw CMP-configuraties (gekozen via de Code-ID van uw CMP), de gegevens verzamelt en de toestemmingsinformatie opslaat in het NSUserDefaults-gebied van het apparaat, zodat de app de gerichte advertenties dienovereenkomstig kan weergeven. 

Houd er rekening mee dat het van cruciaal belang is om de CMPManager SDK in de onCreate anders is de weergave mogelijk niet klaar voor gebruik en kan de SDK mislukken. Zorg er ook voor dat u de juiste configuratiegegevens gebruikt. De configuratiegegevens vindt u in uw consentmanager account bij Menu > CMP's > Code voor apps ophalen > Code-ID

Houd er ook rekening mee dat de functionaliteiten die betrekking hebben op het bepalen of toestemming nodig is of niet, evenals de weergave van de toestemmingslaag, afhankelijk zijn van een betrouwbare netwerkverbinding. Als er geen verbinding beschikbaar is of als het mechanisme van opnieuw proberen onze server niet bereikt, retourneert de gebeurtenis didReceiveError een time-outfout, en kan de SDK dus helemaal niet bepalen of er toestemming nodig is, omdat de toestemmingslaag helemaal niet kan worden weergegeven. Zorg ervoor dat uw logica hiermee rekening houdt.

Voorbeeld:

import net.consentmanager.cm_sdk_android_v3.CMPManager
import net.consentmanager.cm_sdk_android_v3.CMPManagerDelegate
import net.consentmanager.cm_sdk_android_v3.ConsentLayerUIConfig
import net.consentmanager.cm_sdk_android_v3.UrlConfig

class MainActivity : ComponentActivity(), CMPManagerDelegate {
    private lateinit var cmpManager: CMPManager

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        val urlConfig = UrlConfig(
            id = "YOUR_CODE_ID_HERE",
            domain = "delivery.consentmanager.net",
            language = "EN",
            appName = "CMDemoAppKotlin"
        )

        val webViewConfig = ConsentLayerUIConfig(
            position = ConsentLayerUIConfig.Position.FULL_SCREEN,
            backgroundStyle = ConsentLayerUIConfig.BackgroundStyle.dimmed(Color.BLACK, 0.5f),
            cornerRadius = 10f,
            respectsSafeArea = true,
            isCancelable = false
        )

        cmpManager = CMPManager.getInstance(
            context = this,
            urlConfig = urlConfig,
            webViewConfig = webViewConfig,
            delegate = this
        )

        cmpManager.setActivity(this)

        checkAndOpen()
    }

    private fun checkAndOpenConsentLayer() {
        cmpManager.checkAndOpen { result ->
            result.onSuccess {
                showCMPDemoScreen()
            }.onFailure { error ->
                Log.e("DemoApp", "Check and open consent layer failed with error: $error")
            }
        }
    }

    private fun showCMPDemoScreen() {
        setContent {
            MaterialTheme {
                Surface(
                    modifier = Modifier.fillMaxSize(),
                    color = MaterialTheme.colorScheme.background
                ) {
                    CMPDemoScreen(cmpManager)
                }
            }
        }
    }

    override fun onConfigurationChanged(newConfig: Configuration) {
        Log.d("CMP DemoApp", "Configuration changed")
        super.onConfigurationChanged(newConfig)
        cmpManager.onApplicationResume()
    }

	override fun onPause() {
        Log.d("CMP DemoApp", "Activity paused")
        super.onPause()
        cmpManager.onApplicationPause()
    }

    override fun onDestroy() {
        Log.d("CMP DemoApp", "Activity destroyed")
        super.onDestroy()
        cmpManager.onActivityDestroyed()
    }

    override fun didReceiveConsent(consent: String, jsonObject: Map<String, Any>) {
        Log.d("CMP DemoApp", "Consent Layer successfully received consent message.")
        runOnUiThread {
            showCMPDemoScreen()
        }
    }

    override fun didShowConsentLayer() {
        Log.d("CMP DemoApp", "Consent Layer open message received.")
    }

    override fun didCloseConsentLayer() {
        Log.d("CMP DemoApp", "Consent Layer close message received.")
        runOnUiThread {
            showCMPDemoScreen()
        }
    }

    override fun didReceiveError(error: String) {
        Log.e("CMP DemoApp", "SDK error: $error")
    }
}

1.3 Verwerking van toestemmingsgegevens van gebruikers

Controleren van toestemmingen van gebruikers

Onze SDK biedt een uniforme methode om toestemmingsinformatie te controleren en op te halen, getUserStatus(): 
val status = cmpManager.getUserStatus()
Log.d("CMPDemo", "User Status: ${status.hasUserChoice}")
Log.d("CMPDemo", "TCF: ${status.tcf}")
Log.d("CMPDemo", "Additional Consent: ${status.addtlConsent}")
Log.d("CMPDemo", "Regulation: ${status.regulation}")

Log.d("CMPDemo", "---- Vendors Status ----")
status.vendors.forEach { (vendorId, choice) ->
    Log.d("CMPDemo", "Vendor $vendorId: $choice")
}

Log.d("CMPDemo", "---- Purposes Status ----")
status.purposes.forEach { (purposeId, choice) ->
    Log.d("CMPDemo", "Purpose $purposeId: $choice")
}

Voor meer informatie over de andere methoden verwijzen wij u naar onze volledige API-documentatie. 

De toestemmingslaag opnieuw openen om de keuzes van de gebruikers te controleren

Om de gebruiker toe te staan ​​zijn keuzes te verifiëren of te wijzigen, kunt u eenvoudig bellen openConsentLayer()

cmpManager.forceOpen()

Met deze methode wordt de toestemmingslaag weergegeven via hetzelfde WebView-exemplaar dat in de vorige stappen is gemaakt. 

In sommige gevallen kan een native app webviews bevatten om informatie weer te geven, zoals advertenties of content. Om de toestemmingsinformatie van de SDK naar de webview te verzenden, kunt u de toestemmingsstring ophalen met:

consentData = cmpManager.exportCMPInfo()

Hiermee worden de toestemmingsinformatie en alle verdere gegevens die nodig zijn voor de CMP geëxporteerd. U kunt deze informatie vervolgens doorgeven aan de CMP die zich in uw webview bevindt door deze toe te voegen aan de URL die in de webview wordt aangeroepen.

Als u de toestemmingsreeks anders met behulp van de SDK moet importeren, kunt u het onderstaande voorbeeld gebruiken:

val consentStringToImport = "Q1FERkg3QVFERkg3QUFmR01CSVRCQkVnQUFBQUFBQUFBQWlnQUFBQUFBQUEjXzUxXzUyXzUzXzU0XzU1XzU2XyNfczI3ODlfczI3OTBfczI3OTFfczI2OTdfczk3MV9VXyMxLS0tIw"
cmpManager.importCMPInfo(consentStringToImport)

Een aangepaste lay-out maken

Om een ​​aangepaste weergave van de WKWebView te maken, kunt u een wrapper maken voor de ComponentActivity die moet worden doorgegeven aan de CMP SDK, zodat u volledige controle hebt over het uiterlijk en de levenscyclus ervan. Raadpleeg voor meer informatie de officiële documentatie.

Logging

Wanneer u onze iOS SDK gebruikt, kan het nodig zijn om loginformatie te debuggen of analyseren voor verschillende doeleinden. De logs die door onze SDK worden gegenereerd, zijn getagd onder "CMP", zodat u eenvoudig de relevante logs kunt filteren en bekijken. Raadpleeg voor meer informatie deze sectie van onze documentatie.

Troubleshooting

Klasse niet gevonden of NoSuchMethodException:

ProGuard kan soms klassennamen verdoezelen of methoden verwijderen waarnaar via reflectie dynamisch wordt verwezen. Om dit op te lossen, moet u de klassen en methoden specificeren die intact moeten blijven in het ProGuard-configuratiebestand met behulp van de -keep Richtlijn.

Voorbeeld van een ProGuard-configuratie om een ​​specifieke klasse en zijn methoden te behouden:

# Kotlin serialization looks up the generated serializer classes through a function on companion
# objects. The companions are looked up reflectively so we need to explicitly keep these functions.
-keepclasseswithmembers class **.*$Companion {
    kotlinx.serialization.KSerializer serializer(...);
}
# If a companion has the serializer function, keep the companion field on the original type so that
# the reflective lookup succeeds.
-if class **.*$Companion {
  kotlinx.serialization.KSerializer serializer(...);
}
-keepclassmembers class <1>.<2> {
  <1>.<2>$Companion Companion;
}

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
-keepclassmembers class * {
    @android.webkit.JavascriptInterface <methods>;
}

-keepattributes JavascriptInterface

-keepclassmembers class net.consentmanager.sdk.common.callbacks.* {
   public *;
}

-keepclassmembers class net.consentmanager.sdk.consentlayer.ui.consentLayer.CmpWebView {
   public *;
}

-keepclassmembers class net.consentmanager.sdk.consentlayer.ui.CmpLayerAppInterface {
   public *;
}
-keep class net.consentmanager.sdk.CMPConsentTool {
                                                      *;
                                                  }

-keepclassmembers class * {
    @android.webkit.JavascriptInterface <methods>;
}

-keepattributes JavascriptInterface

# Serializer for classes with named companion objects are retrieved using `getDeclaredClasses`.
# If you have any, uncomment and replace classes with those containing named companion objects.
#-keepattributes InnerClasses # Needed for `getDeclaredClasses`.
#-if @kotlinx.serialization.Serializable class
#com.example.myapplication.HasNamedCompanion, # <-- List serializable classes with named companions.
#com.example.myapplication.HasNamedCompanion2
#{
#    static **$* *;
#}
#-keepnames class <1>$$serializer { # -keepnames suffices; class is kept when serializer() is kept.
#    static <1>$$serializer INSTANCE;
#}

 

Details
Herziening # 8
Gemaakt 5 maanden geleden by fabio.torre@iubenda.com
Bijgewerkt 5 dagen geleden by fabio.torre@iubenda.com
Paginanavigatie
  • 1. Installatie
  • Stappen - Beschrijving op hoog niveau
  • 1.1 Integratie en configuratie
  • Afhankelijkheid toevoegen via Gradle
  • 1.2 Een instantie maken en...
  • 1.3 Verwerken van gebruikersconsen...
  • Controleren van toestemmingen van gebruikers
  • De toestemmingslaag opnieuw openen...
  • Toestemming importeren/exporteren...
  • Een aangepaste lay-out maken
  • Logging
  • Troubleshooting
    • Heeft u nog geen account hebt?

    Word AVG-compatibel met onze AVG-cookie Consent Manager oplossing. Probeer nu gratis!

    AVG-cookie Consent Manager
    Terug naar boven