Implement Google User Messaging Platform SDK In .Net Maui

When showing ads in your app, getting user consent to follow privacy rules like GDPR and CCPA is important. For .NET MAUI developers, the Google User Messaging Platform (UMP) SDK makes this process easy. It helps you show consent forms, collect user choices, and update their preferences before displaying ads. In this guide, we’ll follow the steps to set up and use the UMP SDK in a .NET MAUI app.

STEP 1: Create a GDPR or CCPA message for your app.

The first step is to add your app to Admob and create the appropriate regulations message for your app. You can check out the step-by-step process by going to https://support.google.com/admob/answer/10113207?hl=en-GB or check the screenshot below.

Sample Message. Source - Google

STEP 2: Add your Ads App ID to AndroidManifest.xml and info.plist files.

From your AdMob account, go to your app from the app list to copy your App ID and paste it into your AndroidManifest.xml and info.plist files as shown below. If you have done this step, you can skip to the next step

For IOS (You also need to add the User Tracking Description)

GADApplicationIdentifier ca-app-pub-XXXXXXXXXXXXXXXX~XXXXXXXXXX NSUserTrackingUsageDescription This identifier will be used to deliver personalized ads to you.

For Android (You also need to add your Ads Unit ID)

Note: Replace ca-app-pub-XXXXXXXXXXXXXXXX~XXXXXXXXXX with your App IDs

STEP 3: Install the Google User Messaging Platform Plugin

For Android: Install the Xamarin.Google.UserMessagingPlatform

dotnet add package Xamarin.Google.UserMessagingPlatform --version 3.1.0.1

For IOS: Install the Xamarin.Google.iOS.UserMessagingPlatform

dotnet add package Xamarin.Google.iOS.UserMessagingPlatform --version 1.2.0.5

Now edit your .csproj and make sure the plugins are separated with the following conditions

STEP 4: Show the Google UMP User Consent Form

Now that we have completed the setup, we are ready to request the user's consent by loading and displaying the consent form to the user. We have to do this at the platform level, which means we will have two different implementations - one for Android and the other for iOS.

For Android: Open the MainActivity.cs, Copy the code below and paste it after the OnCreate Method

private void SetGDPR() { Console.WriteLine("DEBUG: MainActivity.OnCreate: Starting consent management flow, via UserMessagingPlatform."); try { #if DEBUG var debugSettings = new Xamarin.Google.UserMesssagingPlatform.ConsentDebugSettings.Builder(this) .SetDebugGeography(Xamarin.Google.UserMesssagingPlatform.ConsentDebugSettings .DebugGeography .DebugGeographyEea) .AddTestDeviceHashedId(Android.Provider.Settings.Secure.GetString(this.ContentResolver, Android.Provider.Settings.Secure.AndroidId)) .Build(); #endif

var requestParameters = new Xamarin.Google.UserMesssagingPlatform.ConsentRequestParameters .Builder() .SetTagForUnderAgeOfConsent(false) #if DEBUG .SetConsentDebugSettings(debugSettings) #endif .Build();

var consentInformation = Xamarin.Google.UserMesssagingPlatform.UserMessagingPlatform.GetConsentInformation(this);

consentInformation.RequestConsentInfoUpdate( this, requestParameters, new GoogleUMPConsentUpdateSuccessListener( () => { // The consent information state was updated. // You are now ready to check if a form is available. if (consentInformation.IsConsentFormAvailable) { Xamarin.Google.UserMesssagingPlatform.UserMessagingPlatform.LoadConsentForm( this, new GoogleUMPFormLoadSuccessListener((Xamarin.Google.UserMesssagingPlatform.IConsentForm f) => { googleUMPConsentForm = f; googleUMPConsentInformation = consentInformation; Console.WriteLine("DEBUG: MainActivity.OnCreate: Consent management flow: LoadConsentForm has loaded a form, which will be shown if necessary, once the ViewModel is ready."); DisplayAdvertisingConsentFormIfNecessary(); }), new GoogleUMPFormLoadFailureListener((Xamarin.Google.UserMesssagingPlatform.FormError e) => { // Handle the error. Console.WriteLine("ERROR: MainActivity.OnCreate: Consent management flow: failed in LoadConsentForm with error " + e.Message); })); } else { Console.WriteLine("DEBUG: MainActivity.OnCreate: Consent management flow: RequestConsentInfoUpdate succeeded but no consent form was available."); } }), new GoogleUMPConsentUpdateFailureListener( (Xamarin.Google.UserMesssagingPlatform.FormError e) => { // Handle the error. Console.WriteLine("ERROR: MainActivity.OnCreate: Consent management flow: failed in RequestConsentInfoUpdate with error " + e.Message); }) ); } catch (Exception ex) { Console.WriteLine("ERROR: MainActivity.OnCreate: Exception thrown during consent management flow: ", ex); } }

private Xamarin.Google.UserMesssagingPlatform.IConsentForm googleUMPConsentForm = null; private Xamarin.Google.UserMesssagingPlatform.IConsentInformation googleUMPConsentInformation = null; public void DisplayAdvertisingConsentFormIfNecessary() { try { if (googleUMPConsentForm != null && googleUMPConsentInformation != null) { /* ConsentStatus: Unknown = 0, NotRequired = 1, Required = 2, Obtained = 3 */ if (googleUMPConsentInformation.ConsentStatus == 2) { Console.WriteLine("DEBUG: MainActivity.DisplayAdvertisingConsentFormIfNecessary: Consent form is being displayed."); DisplayAdvertisingConsentForm(); } else { Console.WriteLine("DEBUG: MainActivity.DisplayAdvertisingConsentFormIfNecessary: Consent form is not being displayed because consent status is " + googleUMPConsentInformation.ConsentStatus.ToString()); } } else { Console.WriteLine("ERROR: MainActivity.DisplayAdvertisingConsentFormIfNecessary: consent form or consent information missing."); } } catch (Exception ex) { Console.WriteLine("ERROR: MainActivity.DisplayAdvertisingConsentFormIfNecessary: Exception thrown: ", ex); } }

public void DisplayAdvertisingConsentForm() { try { if (googleUMPConsentForm != null && googleUMPConsentInformation != null) { Console.WriteLine("DEBUG: MainActivity.DisplayAdvertisingConsentForm: Consent form is being displayed.");

googleUMPConsentForm.Show(this, new GoogleUMPConsentFormDismissedListener( (Xamarin.Google.UserMesssagingPlatform.FormError f) => { if (googleUMPConsentInformation.ConsentStatus == 2) // required { Console.WriteLine("ERROR: MainActivity.DisplayAdvertisingConsentForm: Consent was dismissed; showing it again because consent is still required."); DisplayAdvertisingConsentForm(); } })); } else { Console.WriteLine("ERROR: MainActivity.DisplayAdvertisingConsentForm: consent form or consent information missing."); } } catch (Exception ex) { Console.WriteLine("ERROR: MainActivity.DisplayAdvertisingConsentForm: Exception thrown: ", ex); } }

public class GoogleUMPConsentFormDismissedListener : Java.Lang.Object, Xamarin.Google.UserMesssagingPlatform.IConsentFormOnConsentFormDismissedListener { public GoogleUMPConsentFormDismissedListener(Action failureAction) { a = failureAction; } public void OnConsentFormDismissed(Xamarin.Google.UserMesssagingPlatform.FormError f) { a(f); }

private Action a = null; }

public class GoogleUMPConsentUpdateFailureListener : Java.Lang.Object, Xamarin.Google.UserMesssagingPlatform.IConsentInformationOnConsentInfoUpdateFailureListener { public GoogleUMPConsentUpdateFailureListener(Action failureAction) { a = failureAction; } public void OnConsentInfoUpdateFailure(Xamarin.Google.UserMesssagingPlatform.FormError f) { a(f); }

private Action a = null; }

public class GoogleUMPConsentUpdateSuccessListener : Java.Lang.Object, Xamarin.Google.UserMesssagingPlatform.IConsentInformationOnConsentInfoUpdateSuccessListener { public GoogleUMPConsentUpdateSuccessListener(Action successAction) { a = successAction; }

public void OnConsentInfoUpdateSuccess() { a(); }

private Action a = null; }

public class GoogleUMPFormLoadFailureListener : Java.Lang.Object, Xamarin.Google.UserMesssagingPlatform.UserMessagingPlatform.IOnConsentFormLoadFailureListener { public GoogleUMPFormLoadFailureListener(Action failureAction) { a = failureAction; } public void OnConsentFormLoadFailure(Xamarin.Google.UserMesssagingPlatform.FormError e) { a(e); }

private Action a = null; }

public class GoogleUMPFormLoadSuccessListener : Java.Lang.Object, Xamarin.Google.UserMesssagingPlatform.UserMessagingPlatform.IOnConsentFormLoadSuccessListener { public GoogleUMPFormLoadSuccessListener(Action successAction) { a = successAction; } public void OnConsentFormLoadSuccess(Xamarin.Google.UserMesssagingPlatform.IConsentForm f) { a(f); }

private Action a = null; }

Now, in the OnCreate Method, call the SetGDPR method as shown.

protected override void OnCreate(Bundle? savedInstanceState) { SetGDPR(); base.OnCreate(savedInstanceState); }

For iOS: Open the AppDelegate.cs, Copy the code below and paste it after the FinishedLaunching Method

private void ShowUMPConsent() { try { var requestParameters = new RequestParameters(); requestParameters.TagForUnderAgeOfConsent = false;

#if DEBUG requestParameters.DebugSettings = new DebugSettings { Geography = DebugGeography.Eea }; #endif

ConsentInformation.SharedInstance.RequestConsentInfoUpdateWithParameters(requestParameters, (error) => { if (error == null) { var consentStatus = ConsentInformation.SharedInstance.ConsentStatus;

// Check user location if (consentStatus == ConsentStatus.Unknown || consentStatus == ConsentStatus.Required) // IsRequestLocationInEeaOrUnknown { // Load consent message ConsentForm.LoadWithCompletionHandler((consentForm, loadError) => { if (loadError == null) { // Show consent message var viewController = UIApplication.SharedApplication.KeyWindow.RootViewController;

if(viewController != null) { consentForm?.PresentFromViewController(viewController, (error) => { Console.WriteLine(error); }); }

} }); } } }); } catch (Exception ex) { Console.WriteLine(ex); } }

private void CompletionHandler(InitializationStatus status) { }

Now, in the FinishedLaunching Method, call the ShowUMPConsentmethod as shown.

public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions) { ShowUMPConsent();

return base.FinishedLaunching(application, launchOptions); }

There you have it. Build your project and run it - you should have the user consent form displayed to the user.

In conclusion, integrating the Google User Messaging Platform (UMP) SDK into your .NET MAUI app is an essential step for managing user consent in compliance with privacy regulations like GDPR and CCPA. By following the steps outlined in this guide, you can ensure that your app collects, updates, and respects user preferences before showing ads. This not only helps you meet legal requirements but also builds trust with your users by prioritizing their privacy. With the UMP SDK in place, you can confidently deliver ads and make money while maintaining a user-friendly and transparent experience.

How To Implement Google User Messaging Platform (UMP) SDK In .Net Maui

Source Code: Implementing Dependency Injection the easy way in .Net MAUI

Source Code: Property App in .Net MAUI

A. Creating Beautiful Notes App in .Net MAUI | Project Structure

B. Staggered List in .Net MAUI

Register Shell Navigation in .Net MAUI (the easy way)

B. Staggered List in .Net MAUI

Best Web Hosting Services for your Website

Getting Started With .Net MAUI

Create A WordPress Website in 2023

How To Implement Google User Messaging Platform (UMP) SDK In .Net Maui

Source Code: Implementing Dependency Injection the easy way in .Net MAUI

Register Shell Navigation in .Net MAUI (the easy way)

Source Code: How to Set Status Bar Color in .Net MAUI

Welcome Back!

Create New Account!

Retrieve your password

Are you sure want to unlock this post?

Are you sure want to cancel subscription?

How To Implement Google User Messaging Platform (UMP) SDK In .Net Maui

STEP 1: Create a GDPR or CCPA message for your app.

Premium Article/Course

Subscribe

Buy Article

Source Code: Implementing Dependency Injection the easy way in .Net MAUI

Welcome Back!

Create New Account!

Retrieve your password

Are you sure want to unlock this post?

Are you sure want to cancel subscription?