admob_consent 1.1.2

A wrapper for Google's User Messaging Platform (UMP) SDK, used for consent gathering (i.e. GDPR, ATT) on Android and iOS.

Admob Consent Plugin

User Messaging Platform wrapper used for consent gathering (i.e. GDPR, ATT or both) on Android and iOS. Uses Google's new User Messaging Platform with Funding Choices.

Screenshots

Example 1	Example 2

Usage

To use this plugin, add admob_consent as a dependency in your pubspec.yaml file.

Requirements

1. Funding Choices

• Create a Funding Choices account
• Create respective messages inside Funding Choices for your desired app and publish them

2. Android Setup

Make sure to have added your app ID to AndroidManifest.xml.

<meta-data
    android:name="com.google.android.gms.ads.APPLICATION_ID"
    android:value="YOUR-APP-ID"/>

copied to clipboard

3. iOS Setup

Make sure to have added your app ID to Info.plist.

<key>GADApplicationIdentifier</key>
<string>YOUR-APP-ID</string>

copied to clipboard

3.1 iOS ATT Dialog

If you intend to use this SDK for Apple's new ATT requirement (iOS 14+), add the following to Info.plist. If you have the IDFA message enabled in Funding Choices, the ATT dialog will appear automatically after it within your app. More information here.

<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>

copied to clipboard

Next, you'll need to link the AppTrackingTransparency framework by going to your application's target in Xcode and clicking the plus icon on Frameworks, Libraries and Embedded Content tab. See Google's guide here.

Example

import 'package:admob_consent/admob_consent.dart';

final AdmobConsent _admobConsent = AdmobConsent();

// Form won't appear (again) if it isn't required, you can safely call this at app start
_admobConsent.show(); // Internally defaults to: forceShow: false

// Form will appear (again) even if consent was already configured (i.e. use in button to let user manage his consent)
_admobConsent.show(forceShow: true);

copied to clipboard

Listener

You can listen to the onConsentFormLoaded, onConsentFormOpened, onConsentFormObtained and onConsentFormError streams. The UMP SDK should handle most of the things though.

_admobConsent.onConsentFormObtained.listen((o) {
  // Obtained consent
});

copied to clipboard

Enjoy it?