RingPublishingGDPR

Module which collects and saves user's consent in accordance with the standard TCF2.0

Documentation

The documentation can be found at https://developer.ringpublishing.com/Money/docs/GDPRConsentManager/index.html.

Integration tutorial:

https://developer.ringpublishing.com/Money/docs/GDPRConsentManager/howto/integrate-using-android-sdk.html.

How consents are stored:

https://developer.ringpublishing.com/Money/docs/GDPRConsentManager/topics/consent-storage-using-mobile-sdk.html.

Reference guide:

https://developer.ringpublishing.com/Money/docs/GDPRConsentManager/reference/gdpr-android-sdk.html.

Requirements

• Android API >= 21
• AndroidX

Permissions

List permissions used in module:

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

Installation from GitHub Packages

1. Add to your main build.gradle script section to GitHub repository

maven {
    name = "RingPublishingGDPR-Android"
    url = uri("https://maven.pkg.github.com/ringpublishing/RingPublishingGDPR-Android")
    credentials {
        username = "your github username"
        password = "you github access token"
    }
}

2. Add to your application project module dependencies section

implementation("com.ringpublishing:gdpr:1.7.+")

Installation from GitHub source code

1. Checkout code from GitHub
2. Add RingPublishingGDPR like module to your project

In settings.gradle add:

include ':yourApplication', ':RingPublishingGDPR'

In your application build.gradle add dependency

implementation project(path: ':RingPublishingGDPR'))

Usage

Sync project and start looks usage in demo project. Start look in class DemoApplication.java

Start by importing RingPublishingGDPR:

import com.ringpublishing.gdpr.RingPublishingGDPR;

then you have access to module instance:

RingPublishingGDPR.getInstance()

For detailed example see example project in demo directory and start with class DemoApplication, SplashActivity and MainActivity or check our documentation.

Additional query parameters for the consent form

To append your own query parameters to the URL loaded by the consent form webview, use the initialize overloads accepting Map<String, String> additionalQueryParameters:

RingPublishingGDPR.getInstance().initialize(application, tenantId, brandName, uiConfig,
        Collections.singletonMap("app_is", "value"));

Values are URL-encoded by the SDK. A parameter replaces a same-named one already present in the URL; other existing parameters are kept. Parameters are read once, at initialization.