ConsentManager GDPR / CCPA SDK för Android

Du har nu möjlighet ConsentManager SDK för Android-appar implementerar och tillhandahåller funktionalitet för att informera användaren om dataskydd och fråga och samla in samtycke från användaren. Det gör det möjligt för app-utvecklare att enkelt integrera ConsentManager tjänst i deras app.

Stödda standarder

Du har nu möjlighet ConsentManager GDPR / CCPA SDK för Android stöder följande branschstandarder:

• IAB TCF v1
• IAB TCF v2
• IAB USPrivacy v1
• ConsentManager anpassade leverantörer / ändamål
• Googles ytterligare samtyckesläge (Google AC String)

Hur det fungerar

1. Integrera SDK i appen och konfigurera SDK-inställningarna
2. När SDK-enheten är sammankopplad i en app kommer SDK att tillhandahålla funktioner för apputvecklaren för att hämta samtyckesdata
3. Så snart appen startar hämtar SDK automatiskt information från ConsentManager servrar för att förbereda SDK för dess användning.
4. Det rekommenderas att appen skapar en klassinstans vid start av appen CMPConsentTool. När detta har skapats kommer SDK automatiskt att visa samtyckeskärmen vid behov.
5. När appen vill behandla personuppgifter, bör den "fråga" SDK om samtycke gavs för det specifika syftet och leverantören.

Installation

Förvar på Bitbucket: https://bitbucket.org/consentmanager/android-consentmanager/src/master/

Gradle

Steg 1. Lägg till jitpack-arkivet i din root build.gradle i slutet av arkiv:

allprojects {  
  repositories {    
    ...    
    maven { url 'https://jitpack.io' }  
  }
}

Steg 2. Lägg till beroendet till dina appar build.gradle. (För att alltid få den senaste versionen använd +-symbolen för att få de senaste uppdateringarna. Du kan till exempel alltid få de senaste versionerna för mindre uppdateringar genom 1.x.+)

dependencies {
  implementation 'org.bitbucket.consentmanager:android-consentmanager:1.5.+'
}

Maven

Steg 1. Lägg till jitpack-arkivet i din build.gradle i slutet av arkiv:

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

Steg 2. Lägg till beroendet till dina appar build.gradle. (För att alltid få den senaste versionen i maven kan du använda olika metoder för att avböja versionsintervallet. du kan slå upp dem här )

    <dependency>
        <groupId>org.bitbucket.consentmanager</groupId>
        <artifactId>android-consentmanager</artifactId>
        <version>1.5.7</version>
    </dependency>

Använda biblioteket

behörigheter

Denna SDK kräver följande behörigheter, se till att lägga till dem i din AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

Initiera ConsentTool

Med app-start (vanligtvis din viewDidAppear-funktion) måste du skapa en instans av klass CMPConsentTool. Detta hämtar automatiskt nödvändiga data från vår server och avgör om samtycksskärmen måste visas eller inte. Om så är fallet kommer SDK automatiskt att visa samtyckskärmen vid denna tidpunkt, samla in data och tillhandahålla informationen till appen. Instansen kan sedan användas för att få samtyckeuppgifter från SDK för att kunna använda den i appen.

För att initiera ConsentTool, gå till din riktade klass och skapa en instans av CMPConsentTool som visas nedan:

//...
import net.consentmanager.sdk.CMPConsentTool;
//...
public class MainActivity extends AppCompatActivity {
    private CMPConsentTool consentTool;
    //...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
      //..
      consentTool = CMPConsentTool.createInstance(this, 123456, "consentmanager.mgr.consensu.org", "MyFavouriteApp", "");
    }
//...
}

För att skapa förekomsten av CMPConsentTool måste du konfigurera instansen. Du måste ange CMP-ID, serverdomän, ett appnamn och ett språk. CMP-ID och serverdomän finns i din ConsentManager konto under Meny> Hämta kod. Appnamnet kan användas för att distribuera olika appar i ConsentManager rapportering. För språket kan du antingen använda en tom sträng ("") för automatisk upptäckt eller en två-bokstavs språkkod ("EN", "DE", "FR" och så vidare).

Konfigurationsvärdena kan sättas in på olika sätt:

a) SDK-konfiguration via CMPConfig

Lägg till följande rader i din kod:

val config = CMPConfig.apply { 
            serverDomain = CMP_DOMAIN
            appName = CMP_APP_NAME
            language = LANG
            id = APP_ID
        }
val consentTool = CMPConsentTool.createInstance(this, config);

b) SDK-konfiguration via createInstance()

Lägg till följande rad i din kod:

consentTool = CMPConsentTool.createInstance(this, 1234567, "consentmanager.mgr.consensu.org", "MyFavouriteApp", "EN");

Med SDK

Kontrollera för samtycke

För att kontrollera om en leverantör eller syfte har samtycke kan du använda de två metoderna:

if(consentTool.hasPurposeConsent(this,"52",false))
{
    if(consentTool.hasVendorConsent(this,"s26", false))
    {
        //do something with data
    }
}

Båda metoderna hasPurposeConsent och hasVendorConsent kräver två parametrar:

• id - Sträng av leverantören eller syfte-ID. Observera att leverantörs-ID: n kan ha olika format ("123", "s123" och "c123"), vänligen dubbelkontrollera med Meny> Leverantörer och Meny> Syften i din ConsentManager konto.
• isIABVendor / isIABPurpose - Om leverantören eller syftet är en leverantör / syfte som följer IAB TCF-standarden, måste du ställa in en sann, annars en falsk.

Kom ihåg: Alla leverantörer som inte tillhör IAB har ID som börjar med "s" eller "c" (t.ex. "s123"); leverantörer som tillhör IAB har ID som inte börjar med "s" eller "c".

Öppna åtkomstskärmen igen

För att låta användaren ändra valen kan du helt enkelt ringa openCmpConsentToolView():

consentTool.openCmpConsentToolView(this);

Överlåta samtyckeinformation till andra källor

I vissa fall kan en inbyggd app innehålla webbvisningar för att visa vissa saker som reklam eller innehåll. För att överföra samtyckeinformation från SDK till webbvisningen, använd funktionen:

String consentData = CMPConsentTool.exportCMPData(this);

Detta kommer att exportera samtyckeinformationen och all ytterligare information som behövs av CMP. Du kan sedan skicka den här informationen till CMP som finns i din webbvy genom att lägga till den i URL: en som heter i webbvisningen:

myWebView.loadURL("https://mywebsite.com/....#cmpimport=" + consentData);

Anpassade evenemangslyssnare

För att lägga till ytterligare processlogik kan du använda dig av Event Listeners. Följande evenemangslyssnare är tillgängliga:

Import/Export samtycke

För att importera eller exportera samtycket kan du använda funktionen exportCMPData(kontextkontext) och importCMPData(Kontextkontext, String cmpData). Kontrollera exemplet nedan: 

// Importing consent data if you like
CMPConsentTool.importCMPData(this, "${your consentString}");

// Instantiate CMPConsentTool()
consentTool = CMPConsentTool.createInstance(...)


// ... Your code here ...


// Exporting Consent data 
String consentString = CMPConsentTool.exportCMPData(this);

ConsentString du behöver skicka bör vara base64-kodad.

CMP SDK-sekvensdiagram

API-översikt: 

hasConsent(): Boolean

Beskrivning: Kontrollerar om användaren redan har gett sitt samtycke.

Returvärde: Returnerar sant om användaren har gett sitt samtycke, annars falskt.

getAllPurposes(context: Context): String

Beskrivning: Returnerar alla ändamål som en sträng.

parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket syftena ska hämtas.

Retur: En sträng som innehåller alla syften.

getAllPurposeList(context: Context): List

Beskrivning: Returnerar alla ändamål som en lista med strängar.

parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket syftena ska hämtas.

Retur: En lista med strängar, där varje sträng representerar ett syfte.

getAgreedPurposes(context: Context): String

Beskrivning: Returnerar de syften som användaren har accepterat som en sträng.

parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket de överenskomna syftena ska hämtas.

Retur: En sträng som innehåller de syften som användaren har gått med på.

getAgreedPurposeList(kontext: Kontext): Lista

Beskrivning: Returnerar en lista över syften som användaren har gått med på.

parametrar:

• sammanhang (typ: Kontext): Kontexten i vilken listan över överenskomna ändamål ska hämtas.

Retur: En lista med strängvärden som representerar de syften som användaren har gått med på.

getDisabledPurposes(kontext: Kontext): Lista

Beskrivning: Returnerar en lista över ändamål som för närvarande är inaktiverade.

parametrar:

• context (typ: Context): Kontexten i vilken listan med inaktiverade syften ska hämtas.

Retur: En lista med strängvärden som representerar de syften som för närvarande är inaktiverade.

getAllVendors(context: Context): String

Beskrivning: Returnerar en sträng som innehåller en lista över alla tillgängliga leverantörer.

parametrar:

• context (typ: Context): Kontexten i vilken listan över alla leverantörer ska hämtas.

Retur: En sträng som innehåller en lista över alla tillgängliga leverantörer.

getAllVendorsList(context: Context): List

Beskrivning: Returnerar en lista över alla tillgängliga leverantörer.

parametrar:

• context (typ: Context): Kontexten i vilken listan över alla leverantörer ska hämtas.

Retur: En lista med strängvärden som representerar alla tillgängliga leverantörer.

getAgreedVendors(context: Context): String

Beskrivning: Returnerar en sträng som innehåller en lista över leverantörer som användaren har accepterat.

parametrar:

• context (typ: Context): Kontexten i vilken listan över överenskomna leverantörer ska hämtas.

Retur: En sträng som innehåller en lista över leverantörer som användaren har gått med på.

getAgreedVendorList(kontext: Kontext): Lista

Beskrivning: Returnerar en lista över leverantörer som användaren har gått med på.

parametrar:

• context (typ: Context): Kontexten i vilken listan över överenskomna leverantörer ska hämtas.

Retur: En lista med strängvärden som representerar de leverantörer som användaren har gått med på.

getDisabledVendors(kontext: Kontext): Lista

Beskrivning: Returnerar en lista över leverantörer som för närvarande är inaktiverade.

parametrar:

• context (typ: Context): Kontexten i vilken listan över inaktiverade leverantörer ska hämtas.

Retur: En lista med strängvärden som representerar de leverantörer som för närvarande är inaktiverade.

enableVendorList(kontext: Kontext, leverantörer: List )

Beskrivning: Aktiverar den givna listan över leverantörer.

parametrar:

• context (typ: Context): Kontexten i vilken leverantörerna ska aktiveras.
• leverantörer (typ: List ): En lista med strängvärden som representerar de leverantörer som ska aktiveras.

Retur: Ingen.

disableVendorList(kontext: Kontext, leverantörer: List )

Beskrivning: Inaktiverar den givna listan över leverantörer.

parametrar:

• context (typ: Context): Kontexten i vilken leverantörerna ska inaktiveras.
• leverantörer (typ: List ): En lista med strängvärden som representerar de leverantörer som ska inaktiveras.

Retur: Ingen.

rejectAll(context: Context, onConsentReceived Callback: OnConsentReceived Callback)

Beskrivning: Avvisar allt samtycke till ansökan.

Parametrar:

• sammanhang (typ: Kontext): Det sammanhang där samtycket avvisas.
• onConsentReceivedCallback (typ: OnConsentReceivedCallback): Återuppringningsfunktionen som exekveras efter att samtycket avvisats.

Retur Värde: Inget

acceptAll(context: Context, onConsentReceived Callback: OnConsentReceived Callback)

Beskrivning: Accepterar allt samtycke för ansökan.

Parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket samtycket accepteras.
• onConsentReceivedCallback (typ: OnConsentReceivedCallback): Återuppringningsfunktionen som exekveras efter att samtycket har accepterats.

Retur Värde: Inget

getUSPrivacyString(context: Context): String

Beskrivning: Returnerar den amerikanska sekretesssträngen.

Parametrar:

• context (typ: Context): Kontexten där den amerikanska sekretesssträngen returneras.

Retur Värde:

• En sträng som representerar den amerikanska integritetssträngen.

hasVendorConsent(context: Context, id: String, checkConsent: Boolean = true): Boolean

Beskrivning: Kontrollerar om användaren har gett sitt samtycke till en specifik leverantör.

Parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket leverantörens samtycke kontrolleras.
• id (typ: String): ID för leverantören.
• checkConsent (typ: Boolean, valfritt): Anger om samtycket ska kontrolleras. Standardvärdet är sant.

Retur Värde:

• sant om användaren har gett sitt samtycke till säljaren, falskt annars.

hasPurposeConsent(context: Context, id: String, isIABPurpose: Boolean, checkConsent: Boolean = true): Boolean

Beskrivning: Kontrollerar om användaren har gett sitt samtycke till ett specifikt ändamål.

Parametrar:

• sammanhang (typ: Kontext): Det sammanhang i vilket syftet samtycke kontrolleras.
• id (typ: String): ID för ändamålet.
• isIABPurpose (typ: Boolean): Anger om syftet är ett IAB-ändamål.
• checkConsent (typ: Boolean, valfritt): Anger om samtycket ska kontrolleras. Standardvärdet är sant.

Retur Värde:

• sant om användaren har gett sitt samtycke till syftet, falskt annars.

getGoogleACString(context: Context): String

Beskrivning: Returnerar Google Advertising ID.

Parametrar:

• kontext (typ: kontext): Det sammanhang där Googles annonserings-ID returneras.

Retur Värde:

• En sträng som representerar Google Advertising ID.

getLastConsentString(context: Context): String

Beskrivning: Returnerar den senaste samtyckessträngen.

Parametrar:

• context (typ: Context): Kontexten i vilken den senaste samtyckessträngen returneras.

Retur Värde:

• En sträng som representerar den sista samtyckessträngen.

exportConsentString(): String

Beskrivning: Exporterar samtyckessträngen.

Parametrar: Ingen

Retur Värde:

• En sträng som representerar samtyckessträngen.

getCalledLast(context: Context): Datum?

Beskrivning: Returnerar det datum då samtycket senast begärdes.

Parametrar:

• context (typ: Context): Kontexten där det senaste anropsdatumet returneras.

Retur Värde:

• Ett datum som representerar det senaste samtalsdatumet eller null om inget datum hittades.

calledThisDay(context: Context): Boolean

Beskrivning: Kontrollerar om samtycket inkallades samma dag.

Parametrar:

• sammanhang (typ: Kontext): Kontexten där kontrollen utförs.

Retur Värde:

• sant om samtycket begärdes samma dag, falskt annars.

Delade preferenser

SDK kommer att ställa in de delade preferensvärdena för IAB TCF v1, IAB TCF v2, IAB USPrivacy och Google AC String. Dessa värden kan läsas med följande kod:

Context mContext = getApplicationContext();

SharedPreferences mPreferences = PreferenceManager.getDefaultSharedPreferences(mContext);

SharedPreferences.OnSharedPreferenceChangeListener mListener;

mListener = new SharedPreferences.OnSharedPreferenceChangeListener() {

            public void onSharedPreferenceChanged(SharedPreferences preferences, String key) {
                        if (key.equals([Specific Consent Key])) {
                                   // Update Consent settings
                                   }
                        }
            };
mPreferences.registerOnSharedPreferenceChangeListener(mListener);

Följande nycklar definieras:

(Utfasad) Dynamisk innehållsblockering med platshållare webView

Den här funktionen har fasats ut och kommer att tas bort i framtiden. Anledningen till utfasningen är att med aktivera och inaktivera leverantörs- och ändamåls-API:er finns det inget behov av att skapa en platshållare längre. Du kan lägga till ditt eget användargränssnitt och din egen affärslogik och aktivera och inaktivera leverantörer dynamiskt. Istället för att använda den här funktionen bör du använda enableVendorList() och disableVendorList() funktioner för att hantera vilka leverantörer som är aktiverade eller inaktiverade, och skapa ditt eget användargränssnitt för att visa denna information för användaren.

Platshållaren viewObject kan implementeras för att få funktionen för dynamisk innehållsblockering här.Du kan skapa vyn med följande metod: 

CMPPlaceholder placeholderView = CMPConsentTool.createPlaceholder(getApplicationContext(),CMPPlaceholderParams
                        .ofVendor("${vendorId}"), new CMPPlaceholderEventListener() {
                        
                    @Override
                    public void vendorAccepted(WebView view) {
                    	//... Actions to trigger if Consent is accepted
                        // Like showing Youtube Video View
                    	}
                    });

Med Wrapper Object CMPPlaceholderParams du kan också skicka valfria parametrar som anpassade texter eller en valfri förhandsvisningsbild. Byggarfunktionerna kallas setCustomplaceholder(String headline, String mainText, String checkboxText, String buttonText) och setOptionalImageUrl(String imageUrl).

Den nödvändiga affärslogiken, när du vill visa vyn och när den inte behöver appliceras av utvecklaren. Du kan skicka erforderliga villkor och åtgärder genom att använda EvenListener Callbacks från CMPPlaceholderEventlistener. Följande obligatoriska evenemang måste implementeras:

Nödvändig: vendorAccepted(CMPPlaceholderView view) { // Your logic }

Frivillig: errorOccurred(String message) { // Error handling }

API-översikt (äldre versioner)