GDPR-Admob-Android

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #android #machine-learning #windows #awesome #awesome-list #vue #pytorch #ios #openai

GDPR-Admob-Android

(★ 43)

Class helper to interact with google consent SDK easily.

GDPR-Admob-Android Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GDPR Android Admob Library
Class helper to easily interact with google consent SDK easily made with LOVE :heart: :earth_africa:.

# Example:
Demo version app has been added for a better explanation of the library.

# Required Dependencies:
> Add it in your root build.gradle at the end of repositories:
```gradle
    allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}
```
> Step 2. Add the dependency
```gradle
    dependencies {
	        implementation 'com.github.ayoubfletcher.GDPR-Admob-Android:consentsdk:0.1.7'
	}
```
---
# Get requirement you need:
> **Get your publisher id from admob:**
![Publisher Id](http://lh3.googleusercontent.com/jbo5TVXuXU0DEHD3dfyutomLUTtsKTkg9LunCXh8R_DTv7T__91P0e4KLtAt9foPzQ=w895)
[Source](https://support.google.com/admob/answer/2784578?hl=en)

> To get the device id you have to initialize an adrequest

**Java**
```java
    // Creating a dummy adview
    AdView adView = new AdView(context);
    adView.setAdSize(AdSize.BANNER);
    adView.setAdUnitId("ca-app-pub-3940256099942544/6300978111"); // Default test banner id
    adView.loadAd((new AdRequest.Builder()).build());
    
    // Or using this code is the same code above it uses the test banner id provided by admob. 'ca-app-pub-3940256099942544/6300978111'
    ConsentSDK.initDummyBanner(context);
```
**Kotlin**
```kotlin
    // Creating a dummy adview
    val adView = AdView(context)
    adView.adSize = AdSize.BANNER
    adView.adUnitId = "ca-app-pub-3940256099942544/6300978111"
    adView.loadAd(AdRequest.Builder().build())
    
    // Or using this code is the same code above it uses the test banner id provided by admob. 'ca-app-pub-3940256099942544/6300978111'
    ConsentSDK.initDummyBanner(context)
```
---
# How to use library:
`1.a Initializing using Builder class`

**Java**
```java
    ConsentSDK consentSDK = new ConsentSDK.Builder(context)
                .addTestDeviceId("your device id from logcat") // Add your test device id "Remove addTestDeviceId on production!"
                .addCustomLogTag("CUSTOM_TAG") // Add custom tag default: ID_LOG
                .addPrivacyPolicy("https://your.privacy.url/") // Add your privacy policy url
                .addPublisherId("pub-0123456789012345") // Add your admob publisher id
                .build();
```
**Kotlin**
```kotlin
    val consentSDK = ConsentSDK.Builder(context)
                .addTestDeviceId("your device id from logcat") // Add your test device id "Remove addTestDeviceId on production!"
                .addCustomLogTag("CUSTOM_TAG") // Add custom tag default: ID_LOG
                .addPrivacyPolicy("https://your.privacy.url/") // Add your privacy policy url
                .addPublisherId("pub-0123456789012345") // Add your admob publisher id
                .build()
```
`1.b Initializing without Builder class`

**Java**
```java
    String deviceId = "your device id from logcat";
    String publisherId = "pub-0123456789012345";
    String privacyUrl = "https://your.privacy.url/";
    ConsentSDK consentSDK = new ConsentSDK(context, publisherId, privacyUrl, true);
```
**Kotlin**
```kotlin
    val deviceId = "your device id from logcat"
    val publisherId = "pub-0123456789012345"
    val privacyUrl = "https://your.privacy.url/"
    val consentSDK = ConsentSDK(context, publisherId, privacyUrl, true)
```
> Choose one of the methods to initialize the ConsentSDK from above.

`2. Then check the consent using:`

**Java**
```java
    consentSDK.checkConsent(new ConsentSDK.ConsentCallback() {
            @Override
            public void onResult(boolean isRequestLocationInEeaOrUnknown) {
                // Your code
            }
        });
```
**Kotlin**
```kotlin
    consentSDK.checkConsent(object : ConsentSDK.ConsentCallback() {
            override fun onResult(isRequestLocationInEeaOrUnknown: Boolean) {
                // Your code
            }
        })
```
> How checkConsent works:
```
- Check the location of the user if it's within EEA and with unknown status.
- If the user is within EEA and with unknown status show the dialog for consent with two options to see relevant ads or to show less relevant ads.
- The function retrieve a callback after the consent has been submitted or if it's not necessary not show the dialog.
- It's save the consent of the user and if the user is not within EEA it saves show relevant ads status.
```

`3. You should load the ads (banner or interstitial ..) using the function below:`

**Java**
```java
    // To Load the banner
    adView.loadAd(ConsentSDK.getAdRequest(context));
    // To Load Interstitial
    interstitialAd.loadAd(ConsentSDK.getAdRequest(context));
```
**Kotlin**
```kotlin
    // To Load the banner
    adView.loadAd(ConsentSDK.getAdRequest(context))
    // To Load Interstitial
    interstitialAd.loadAd(ConsentSDK.getAdRequest(context))
```
`4. To Check if the user is within EEA or not.`

**Java**
```java
    // But you must be called after consent.checkConsent(callback) because it will update the status of the user
    ConsentSDK.isUserLocationWithinEea(context); // Returns true if within false if not.
```
**Kotlin**
```kotlin
    // But you must be called after consent.checkConsent(callback) because it will update the status of the user
    ConsentSDK.isUserLocationWithinEea(context) // Returns true if within false if not.
```
`5. To request the consent form to re-edit it for the users within EEA.`

**Java**
```java
    // To request the consent form to re-edit it for the users within EEA
    consentSDK.requestConsent(new ConsentSDK.ConsentStatusCallback() {
        @Override
        public void onResult(boolean isRequestLocationInEeaOrUnknown, int isConsentPersonalized) {
            // Your code after the consent is submitted if needed
        }
    });
```
**Kotlin**
```kotlin
    // To request the consent form to re-edit it for the users within EEA
    consentSDK.requestConsent(object : ConsentSDK.ConsentStatusCallback() {
            override fun onResult(isRequestLocationInEeaOrUnknown: Boolean, isConsentPersonalized: Int) {
                // Your code after the consent is submitted if needed
            }
        })
```
---
# Note:
> ~ This library is just an editing of the official [Google Consent SDK Android](https://github.com/googleads/googleads-consent-sdk-android) with some tweaks and with some helper class to simplify the comply of the app to GDPR policy.

> ~ That's it, if you followed the steps above your app will be comply with the **GDPR** policy.

Made by Ayoub Fletcher with LOVE :heart:.

GDPR-Admob-Android

GDPR-Admob-Android Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

GDPR-Admob-Android

GDPR-Admob-Android Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README