ConsentManager SDK RODO/CCPA dla Androida

Połączenia ConsentManager SDK dla aplikacji na Androida implementuje i zapewnia funkcjonalność informowania użytkownika o ochronie danych oraz pytania i zbierania zgody od użytkownika. Umożliwia programistom aplikacji łatwą integrację ConsentManager usługi do swojej aplikacji.

Obsługiwane standardy

Połączenia ConsentManager SDK RODO/CCPA dla systemu Android obsługuje następujące standardy branżowe:

• IAB TCF v1
• IAB TCF v2
• IAB USPrywatność v1
• ConsentManager niestandardowi dostawcy/cele
• Tryb dodatkowej zgody Google (ciąg Google AC)

Jak to działa?

1. Zintegruj SDK z aplikacją i skonfiguruj ustawienia SDK
2. Gdy SDK zostanie zintegrowany z aplikacją, SDK udostępni funkcje dla programisty aplikacji w celu pobrania danych dotyczących zgody
3. Gdy tylko aplikacja się uruchomi, SDK automatycznie pobierze informacje z ConsentManager serwery w celu przygotowania SDK do jego użycia.
4. Zaleca się, aby przy starcie aplikacji tworzyła instancję klasy CMPConsentTool. Po utworzeniu SDK automatycznie wyświetli ekran zgody, jeśli to konieczne.
5. Gdy aplikacja chce przetwarzać dane osobowe, powinna „zapytać” SDK, czy została wyrażona zgoda na konkretny cel i dostawcę.

Instalacja

Repozytorium na Bitbucket: https://bitbucket.org/consentmanager/android-consentmanager/src/master/

Gradle

Krok 1. Dodaj repozytorium jitpack do głównego pliku build.gradle na końcu repozytoriów:

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

Krok 2. Dodaj zależność do swoich aplikacji build.gradle. (Aby zawsze uzyskać najnowszą wersję, użyj symbolu +, aby uzyskać najnowsze aktualizacje. Możesz na przykład zawsze pobierać najnowsze wersje dla drobnych aktualizacji do 1.x.+)

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

Maven

Krok 1. Dodaj repozytorium jitpack do swojego build.gradle na końcu repozytoriów:

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

Krok 2. Dodaj zależność do swoich aplikacji build.gradle. (Aby zawsze mieć najnowszą wersję w maven, możesz użyć różnych metod, aby odrzucić zakres wersji. Możesz je sprawdzić tutaj )

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

Korzystanie z biblioteki

Uprawnienia

Ten pakiet SDK wymaga następujących uprawnień, upewnij się, że dodałeś je do pliku AndroidManifest.xml:

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

Zainicjuj narzędzie zgody

Za pomocą aplikacji startowej (zazwyczaj funkcji viewDidAppear) musisz utworzyć instancję klasy CMPConsentTool. Spowoduje to automatyczne pobranie niezbędnych danych z naszego serwera i określenie, czy ekran akceptacji ma być wyświetlany, czy nie. Jeśli tak, SDK automatycznie wyświetli w tym momencie ekran zgody, zbierze dane i przekaże je do aplikacji. Instancję można następnie wykorzystać w celu uzyskania szczegółów zgody z SDK w celu wykorzystania jej w aplikacji.

Aby zainicjować ConsentTool, przejdź do wybranej klasy i utwórz instancję CMPConsentTool, jak pokazano poniżej:

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

Aby utworzyć instancję CMPConsentTool, musisz skonfigurować instancję. Musisz podać CMP-ID, domenę serwera , nazwę aplikacji i język. CMP-ID i domenę serwera można znaleźć w swoim ConsentManager konto pod Menu > Pobierz kod. Nazwy aplikacji można użyć do rozróżnienia różnych aplikacji w ConsentManager raportowanie. Jako język możesz użyć pustego ciągu ("") do automatycznego wykrywania lub dwuliterowego kodu języka ("EN", "DE", "FR" itd.).

Wartości konfiguracyjne można wstawiać na różne sposoby:

a) Konfiguracja SDK przez CMPConfig

Dodaj następujące wiersze do swojego kodu:

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

b) Konfiguracja zestawu SDK za pomocą metody createInstance()

Dodaj następujący wiersz do swojego kodu:

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

Korzystanie z SDK

Sprawdź zgodę

Aby sprawdzić, czy sprzedawca lub cel mają zgodę, możesz skorzystać z dwóch metod:

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

Obie metody hasPurposeConsent i hasVendorConsent wymagają dwóch parametrów:

• id — ciąg identyfikatora dostawcy lub celu. Należy pamiętać, że identyfikatory dostawców mogą mieć różne formaty („123”, „s123” i „c123”), sprawdź dokładnie za pomocą Menu > Sprzedawcy i Menu > Cele w telefonie ConsentManager konto.
• isIABVendor / isIABPurpose — jeśli dostawca lub cel jest dostawcą/celem zgodnym ze standardem IAB TCF, należy ustawić wartość prawda, w przeciwnym razie fałsz.

Pamiętaj: wszyscy dostawcy, którzy nie należą do IAB, mają identyfikatory zaczynające się od „s” lub „c” (np. „s123”); dostawcy należący do IAB mają identyfikatory, które nie zaczynają się od „s” lub „c”.

Ponowne otwieranie ekranu zgody

Aby umożliwić użytkownikowi zmianę wyborów, wystarczy zadzwonić openCmpConsentToolView():

consentTool.openCmpConsentToolView(this);

Przekazywanie informacji o Zgodzie do innych źródeł

W niektórych przypadkach natywna aplikacja może zawierać widoki internetowe w celu wyświetlania pewnych rzeczy, takich jak reklamy lub treści. W celu przekazania informacji o zgodzie z SDK do webview prosimy o skorzystanie z funkcji:

String consentData = CMPConsentTool.exportCMPData(this);

Spowoduje to wyeksportowanie informacji o zgodzie i wszystkich dalszych danych wymaganych przez CMP. Następnie możesz przekazać te informacje do CMP w widoku sieciowym, dodając je do adresu URL wywoływanego w widoku sieciowym:

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

Niestandardowe odbiorniki zdarzeń

Aby dodać dodatkową logikę procesu, możesz skorzystać z detektorów zdarzeń. Dostępne są następujące detektory zdarzeń:

Zgoda na import/eksport

Aby zaimportować lub wyeksportować zgodę możesz skorzystać z funkcji exportCMPData (kontekst kontekstu) i importCMPData (kontekst kontekstu, ciąg cmpData). Sprawdź poniższy przykład: 

// 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);

ZgodaString, którą musisz przekazać, powinna być zakodowana w base64.

Diagram sekwencji CMP SDK

Przegląd interfejsu API: 

hasConsent(): Wartość logiczna

Opis: Sprawdza, czy użytkownik wyraził już zgodę.

Wartość zwracana: Zwraca true, jeśli użytkownik wyraził zgodę, w przeciwnym razie zwraca false.

getAllPurposes(kontekst: kontekst): Ciąg

Opis: Zwraca wszystkie cele jako ciąg znaków.

parametry:

• kontekst (typ: kontekst): kontekst, w którym mają zostać pobrane cele.

Powrót: Ciąg zawierający wszystkie cele.

getAllPurposeList(kontekst: kontekst): Lista

Opis: Zwraca wszystkie cele jako listę ciągów.

parametry:

• kontekst (typ: kontekst): kontekst, w którym mają zostać pobrane cele.

Powrót: Lista ciągów, gdzie każdy ciąg reprezentuje cel.

getAgreedPurposes (kontekst: kontekst): Ciąg

Opis: Zwraca cele, na które użytkownik wyraził zgodę jako ciąg znaków.

parametry:

• kontekst (typ: Kontekst): Kontekst, w którym należy pobrać uzgodnione cele.

Powrót: Ciąg zawierający cele, na które użytkownik wyraził zgodę.

getAgreedPurposeList(kontekst: kontekst): Lista

Opis: Zwraca listę celów, na które użytkownik wyraził zgodę.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista uzgodnionych celów.

Powrót: Lista wartości typu String reprezentujących cele, na które użytkownik wyraził zgodę.

getDisabledPurposes(kontekst: kontekst): lista

Opis: Zwraca listę celów, które są obecnie wyłączone.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista wyłączonych celów.

Powrót: Lista wartości ciągu reprezentujących cele, które są obecnie wyłączone.

getAllVendors(kontekst: kontekst): Ciąg

Opis: Zwraca ciąg zawierający listę wszystkich dostępnych dostawców.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista wszystkich dostawców.

Powrót: Ciąg zawierający listę wszystkich dostępnych dostawców.

getAllVendorsList(kontekst: kontekst): Lista

Opis: Zwraca listę wszystkich dostępnych dostawców.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista wszystkich dostawców.

Powrót: Lista wartości łańcuchowych reprezentujących wszystkich dostępnych dostawców.

getAgreedVendors (kontekst: kontekst): Ciąg

Opis: Zwraca ciąg znaków zawierający listę dostawców, z którymi użytkownik się zgodził.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista uzgodnionych dostawców.

Powrót: Ciąg zawierający listę dostawców, na których zgodził się użytkownik.

getAgreedVendorList(kontekst: kontekst): lista

Opis: Zwraca listę dostawców, których użytkownik zaakceptował.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista uzgodnionych dostawców.

Powrót: Lista wartości typu String reprezentujących dostawców, których użytkownik zaakceptował.

getDisabledVendors (kontekst: kontekst): Lista

Opis: Zwraca listę dostawców, którzy są obecnie wyłączeni.

parametry:

• kontekst (typ: kontekst): kontekst, w którym ma zostać pobrana lista wyłączonych dostawców.

Powrót: Lista wartości ciągów reprezentujących dostawców, którzy są obecnie wyłączeni.

enableVendorList (kontekst: kontekst, dostawcy: lista )

Opis: Włącza podaną listę dostawców.

parametry:

• kontekst (typ: kontekst): kontekst, w którym należy włączyć dostawców.
• dostawcy (typ: Lista ): Lista wartości łańcuchowych reprezentujących dostawców, których należy włączyć.

Powrót: Żaden.

disableVendorList(kontekst: kontekst, dostawcy: lista )

Opis: Wyłącza podaną listę dostawców.

parametry:

• kontekst (typ: kontekst): kontekst, w którym należy wyłączyć dostawców.
• dostawcy (typ: Lista ): Lista wartości łańcuchowych reprezentujących dostawców do wyłączenia.

Powrót: Żaden.

odrzuć wszystko (kontekst: kontekst, onConsentReceivedCallback: OnConsentReceivedCallback)

Opis: Odrzuca wszelkie zgody na aplikację.

Parametry:

• kontekst (typ: Kontekst): Kontekst, w którym zgoda jest odrzucana.
• onConsentReceivedCallback (typ: OnConsentReceivedCallback): Funkcja wywołania zwrotnego, która jest wykonywana po odrzuceniu zgody.

Powrót Wartość: Brak

acceptAll (kontekst: kontekst, onConsentReceivedCallback: OnConsentReceivedCallback)

Opis: Akceptuje wszystkie zgody na aplikację.

Parametry:

• kontekst (typ: Kontekst): Kontekst, w jakim zgoda jest akceptowana.
• onConsentReceivedCallback (typ: OnConsentReceivedCallback): Funkcja wywołania zwrotnego, która jest wykonywana po zaakceptowaniu zgody.

Powrót Wartość: Brak

getUSPrivacyString(kontekst: kontekst): Ciąg

Opis: Zwraca ciąg znaków prywatności w USA.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym zwracany jest ciąg dotyczący prywatności w USA.

Powrót Wartość:

• Ciąg reprezentujący ciąg dotyczący prywatności w USA.

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

Opis: Sprawdza, czy użytkownik udzielił zgody określonemu dostawcy.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym sprawdzana jest zgoda dostawcy.
• id (typ: String): Identyfikator dostawcy.
• checkConsent (typ: Boolean, opcjonalny): Określa, czy zgoda ma zostać sprawdzona. Wartość domyślna to prawda.

Powrót Wartość:

• true , jeśli użytkownik wyraził zgodę na dostawcę, w przeciwnym razie false .

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

Opis: Sprawdza, czy użytkownik wyraził zgodę na określony cel.

Parametry:

• kontekst (typ: Kontekst): Kontekst, w którym sprawdzana jest zgoda na cel.
• id (typ: String): Identyfikator celu.
• isIABPurpose (typ: Boolean): Określa, czy cel jest celem IAB.
• checkConsent (typ: Boolean, opcjonalny): Określa, czy zgoda ma zostać sprawdzona. Wartość domyślna to prawda.

Powrót Wartość:

• true , jeśli użytkownik wyraził zgodę na ten cel, false w przeciwnym razie.

getGoogleACString(kontekst: kontekst): Ciąg

Opis: Zwraca identyfikator reklamowy Google.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym zwracany jest identyfikator wyświetlania reklam Google.

Powrót Wartość:

• Ciąg reprezentujący identyfikator wyświetlania reklam Google.

getLastConsentString(kontekst: kontekst): Ciąg

Opis: Zwraca ostatni ciąg zgody.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym zwracany jest ostatni ciąg zgody.

Powrót Wartość:

• Ciąg reprezentujący ostatni ciąg zgody.

exportConsentString(): Ciąg

Opis: Eksportuje ciąg zgody.

Parametry: żaden

Powrót Wartość:

• Ciąg reprezentujący ciąg zgody.

getCalledLast(kontekst: kontekst): Data?

Opis: Zwraca datę ostatniego wywołania zgody.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym zwracana jest data ostatniego połączenia.

Powrót Wartość:

• Data reprezentująca datę ostatniego wywołania lub wartość null, jeśli nie znaleziono daty.

o nazwie ThisDay (kontekst: kontekst): wartość logiczna

Opis: Sprawdza, czy zgoda została wywołana tego samego dnia.

Parametry:

• kontekst (typ: kontekst): kontekst, w którym wykonywane jest sprawdzanie.

Powrót Wartość:

• true, jeśli zgoda została wywołana tego samego dnia, false w przeciwnym razie.

Wspólne preferencje

SDK ustawi wartości wspólnych preferencji dla IAB TCF v1, IAB TCF v2, IAB USPrivacy i Google AC String. Te wartości można odczytać za pomocą następującego kodu:

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

Zdefiniowano następujące klucze:

(Wycofane) Dynamiczne blokowanie treści za pomocą elementu zastępczego webView

Ta funkcja jest przestarzała i zostanie usunięta w przyszłości. Powodem wycofania jest to, że dzięki włączaniu i wyłączaniu interfejsów API dostawcy i celu nie ma już potrzeby tworzenia symbolu zastępczego. Możesz dodać własny interfejs użytkownika i własną logikę biznesową oraz dynamicznie aktywować i dezaktywować dostawców. Zamiast korzystać z tej funkcji, należy użyć metody włączListaDostawców() i wyłączListDostawców() funkcje do zarządzania, którzy dostawcy są włączani lub wyłączani, i tworzyć własny interfejs użytkownika, aby wyświetlać te informacje użytkownikowi.

Symbol zastępczy viewObject można zaimplementować, aby uzyskać funkcjonalność dynamicznego blokowania treści tutaj.Możesz utworzyć widok za pomocą następującej metody: 

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

Z obiektem opakowującym CMPPlaceholderParams możesz również przekazać parametry opcjonalne, takie jak teksty niestandardowe lub opcjonalny obraz podglądu. Funkcje konstruktora nazywają się setCustomplaceholder(String headline, String mainText, String checkboxText, String buttonText) i setOptionalImageUrl(String imageUrl).

Wymagana logika biznesowa, gdy chcesz pokazać widok i nie musi być stosowana przez dewelopera. Możesz przekazać wymagane warunki i akcje, używając wywołań zwrotnych EvenListener z CMPPlaceholderEventlistener. Należy wdrożyć następujące wymagane wydarzenie:

Wymagany: vendorAccepted(CMPPlaceholderView view) { // Your logic }

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

Omówienie interfejsu API (starsze wersje)