GDPR service, GDPR intermediate screen, Admob manager for loading and displaying Ads

Features

1. GDPR Manager.
2. Ads loading, displaing and returning the results.
3. GDPR and Ads fail gracefully.

Getting started

This package consists of two components: GDPR and Ads. Noth may be used individually. The example below combines both components.

Steps:

1. Admob account: create an Ad-ID and setup a GDPR message
2. Update AndroidManifest.xml and build.gradle
3. Configure MaterialApp( home: GdprScreenManager() )
4. Display Ads
5. Update or reset GDPR on request

Initialize GDPR and Ads

Add a navigation method that will navigate to the next screen after the GDPR screen. In the exmaple below, replace AfterGdprScreen() with your own widget.

Set Ad units and test device IDs. The Ad units below are Admob demo Ad units and are safe to use.

Will show GDPR dialog if user never interacted with it.

Will not show GDPR dialog if user already interacted with it.

void main() async {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(

      home: GdprScreenManager(

        (BuildContext context) => 
          Navigator.of(context).pushReplacement(
            MaterialPageRoute(builder: (context) => 
              const AfterGdprScreen())),

        bannerIds: ["ca-app-pub-3940256099942544/6300978111"],
        interstitialIds: ["ca-app-pub-3940256099942544/1033173712"],
        interRewardIds: ["ca-app-pub-3940256099942544/5354046379"],
        debugTestDeviceIds: [" ... YOUR TEST DEVICE ID HERE ... "],

        // Force or unforce GDPR dialog for testing
        debugGeography: GdprDebugGeography.insideEea,

        // Custom loading widget 
        loadingWidget: ...

      ).getInitialGdprScreen(),
    );
  }
}

Re-Visit GDPR

Will show GDPR dialog if user never interacted with it.

Will not show GDPR dialog if user already interacted with it.

GdprService.isUserUnderGdpr() returns if GDPR applies to users' location in general. Useful for showing a condictional Update-Button.

if(GdprService.isUserUnderGdpr()) {
  Navigator.of(context).pushReplacement(
    MaterialPageRoute(
      builder: (context) =>
          GdprScreenManager.initialGdprScreen(),
    ),
  );
}

Update existing GDPR

Will always show GDPR dialog, regardless of whether user already interacted with it or not.

Navigator.of(context).pushReplacement(
  MaterialPageRoute(
    builder: (context) =>
        GdprScreenManager.updateGdprScreen(),
  )
)

Reset and then re-visit GDPR

Will reset GDPR dialog and then re-visit GDPR dialog, regardless of whether user already interacted with it or not.

Will always show GDPR dialog, regardless of whether user already interacted with it or not.

Navigator.of(context).pushReplacement(
  MaterialPageRoute(
    builder: (context) =>
        GdprScreenManager.initialResetGdprScreen(),
  ),
)

Show Ads

If no adUnitId is given the first available Ad unit will be displayed.

Show a banner Ad

In kDebugMode the `AdBanner`` will display additonal info.

Scaffold(body: AdBanner(' ... Ad ID ...') );

// OR 

Scaffold(body: AdBanner( );

Show an Interstitial Ad

final ResponseInterstitial result 
  = await AdService().showInterstitial(' ... Ad ID ...');

// OR

final ResponseInterstitial result 
  = await AdService().showInterstitial();

Show an rewarded interstitial Ad

A Rewarded Interstitial requires a dialog with a timer.

The appearance of this dialog has to match your app's design.

For convenience, copy the class RewardedInterstitialDialog into your project and skin the AlertDialog inside as needed, find the source here.

Then, call AdService().showInterstitialRewarded() with your dialog as a parameter as given below.

// Both `adUnitId`s referenced below need to be the same, or NULL.

final String? adUnitId = null;

final ResponseInterstitialRewarded result 
  = await AdService().showInterstitialRewarded(
      context, 
      const RewardedInterstitialDialog(
        adUnitId: adUnitId, 
        countdownSeconds:5,
      ),
      adUnitId: adUnitId,
    );

Response details

The returned responses have a status-enum detailing the results.

final ResponseInterstitialRewarded result =
    await AdService().showInterstitialRewarded(
  context,
  const RewardedInterstitialDialog(
    countdownSeconds: 5,
  ),
);

if (
    result.status == StatusInterstitialRewarded.displaySuccess ||
    result.status ==
        StatusInterstitialRewarded.displayDeniedProgrammatically ||
    result.status ==
        StatusInterstitialRewarded.displayFailedUnspecificReasons ||
    result.status == StatusInterstitialRewarded.notLoadedInitialized ||
    result.status == StatusInterstitialRewarded.notLoadedAdIdNotSet ||
    result.status == StatusInterstitialRewarded.notLoadedButTryingTo ||
    result.status == StatusInterstitialRewarded.notLoadedGenerally ||
    result.status == StatusInterstitialRewarded.notLoadedAdIdNotSet

  ) {
  // Ad has been shown or is not available for some technical reason
} else {
  // User has canceld the Ad
}

Example

The example folder contains a working example. Set your test device ID before running it. The Ad units are Admob demo units and safe to use.

TODO

• Add other ad types
• Rename the enums detailing the ad results
• Add method call that returns whether user has accepted or declined ads.

Additional information

Google Admob can be painful, GDPR may time out, Ad slots may not get filled sometimes, also not sure if VPNs play well with Admob.

Issue Tracker

Admob project configuration, configure your app project for ads:

AndroidManifest.xml and build.gradle