Community Cordova Plugin Consent

Google User Messaging Platform (UMP) SDK plugin for Cordova/Ionic applications. This plugin helps you manage user consent for personalized advertising in compliance with GDPR and other privacy regulations.

Support This Plugin

I dedicate a considerable amount of my free time to developing and maintaining many Cordova plugins for the community (See the list with all my maintained plugins).

To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance.

Please consider donating if you're using this plugin in an app that makes you money, or if you're asking for new features or priority bug fixes. Thank you!

Credits & Acknowledgments

This plugin was originally forked from admob-plus by Ratson.

A huge thank you to Ratson for creating and maintaining the original admob-plus plugin and its consent module. The original work laid the foundation for this plugin, and we are grateful for their contributions to the Cordova community.

Due to the original plugin no longer being actively maintained, this standalone repository was created to continue development, provide updates, and ensure compatibility with the latest Google UMP SDK versions.

Features

• Request consent information update
• Load and show consent form
• Check consent status
• Reset consent state (for testing)
• Full TypeScript support
• iOS and Android support

Installation

cordova plugin add community-cordova-plugin-consent

Or with Ionic:

ionic cordova plugin add community-cordova-plugin-consent

SDK Versions

| Platform | SDK | Version | |----------|-----|---------| | Android | user-messaging-platform | 4.0.0 | | iOS | GoogleUserMessagingPlatform | 2.5.0 |

Basic Usage

Request Consent Information

document.addEventListener('deviceready', async () => {
  // Request consent info update
  await consent.requestInfoUpdate();

  // Check if form is available
  const status = await consent.getFormStatus();

  if (status === consent.FormStatus.Available) {
    // Load and show the form
    await consent.loadForm();
    await consent.showForm();
  }
}, false);

Check Consent Status

const consentStatus = await consent.getConsentStatus();

switch (consentStatus) {
  case consent.ConsentStatus.Required:
    // Consent is required but not yet obtained
    break;
  case consent.ConsentStatus.NotRequired:
    // Consent is not required (e.g., user not in EEA)
    break;
  case consent.ConsentStatus.Obtained:
    // User has provided consent
    break;
}

Reset Consent (Testing Only)

// Reset consent state for testing
await consent.reset();

Related Plugins

• community-cordova-plugin-admob - Google AdMob plugin for Cordova

Contributing

• Star this repository
• Open issue for feature requests
• Sponsor this project

License

This project is MIT licensed.