Integrate Liftoff Monetize with mediation

This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Liftoff Monetize using mediation, covering both bidding and waterfall integrations. It covers how to add Liftoff Monetize to an ad unit's mediation configuration, and how to integrate the Vungle SDK and adapter into a Unity app.

Supported integrations and ad formats

Integration
Bidding
Waterfall
Formats
Banner 1
Interstitial
Rewarded
Rewarded Interstitial 1, 2

1 Bidding integration for this format is in open beta.

2 Rewarded interstitial requires assistance to set up. Reach out to your account manager at Liftoff Monetize or monetize@liftoff.io.

Requirements

  • Unity 4 or higher
  • Latest Google Mobile Ads SDK
  • (For bidding): Google Mobile Ads mediation plugin for Liftoff Monetize 3.8.2 or higher (latest version recommended)
  • To deploy on Android
    • Android API level 21 or higher
  • To deploy on iOS
    • iOS deployment target of 11.0 or higher
  • A working Unity project configured with Google Mobile Ads SDK. See Get Started for details.
  • Complete the mediation Get started guide

Step 1: Set up configurations in Liftoff Monetize UI

Sign up or log in to your Liftoff Monetize account.

Add your app to the Liftoff Monetize Applications dashboard by clicking the Add Application button.

Fill out the form, entering all the necessary details.

Android

iOS

Once your app is created, select your app from the Liftoff Monetize Applications dashboard.

Android

iOS

Take note of the App ID.

Android

iOS

Add new placements

To create a new placement to be used with AdMob mediation, navigate to the Liftoff Monetize Placements dashboard, click on the Add Placement button and select your app from the drop-down list.

Details for adding new placements are included below:

Select Banner, enter your desired Placement Name and fill out the rest of the form. [Waterfall only] Click the Continue button at the bottom of the page to create the placement.

300x250 Banner

Select MREC, enter your desired Placement Name and fill out the rest of the form. [Waterfall only] Click the Continue button at the bottom of the page to create the placement.

Interstitial

Select Interstitial, enter your desired Placement Name and fill out the rest of the form. [Waterfall only] Click the Continue button at the bottom of the page to create the placement.

Rewarded

Select Rewarded, enter your desired Placement Name and fill out the rest of the form. [Waterfall only] Click the Continue button at the bottom of the page to create the placement.

Specify how to monetize your inventory

Bidding

Under Monetization toggle the In-App Bidding switch to Enabled, then click the Continue button.

Waterfall

No additional steps required.

Take note of the Reference ID and click Sounds Good.

300x250 Banner

Interstitial

Rewarded

Locate your Reporting API Key

Bidding

This step isn't required for bidding integrations.

Waterfall

In addition to the App ID and the Reference ID, you'll also need your Liftoff Monetize Reporting API Key to set up your AdMob ad unit ID. Navigate to the Liftoff Monetize Reports dashboard and click on the Reporting API Key button to view your Reporting API Key.

Turn on test mode

To enable test ads, go to your Liftoff Monetize dashboard and navigate to Applications.

Select your app for which you would like to enable test ads under the Placement Reference ID section of your app. Test ads can be enabled by selecting Test Mode to Show test ads only under the Status section.

Android

iOS

Step 2: Set up Liftoff Monetize demand in AdMob UI

Configure mediation settings for your ad unit

You need to add Liftoff Monetize to the mediation configuration for your AdMob ad units. First sign in to your AdMob account.

Navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add Liftoff Monetize as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Android

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units.

Associate this mediation group with one or more of your existing AdMob ad units. Then click Done.

You should now see the ad units card populated with the ad units you selected, as shown below:

iOS

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units.

Associate this mediation group with one or more of your existing AdMob ad units. Then click Done.

You should now see the ad units card populated with the ad units you selected, as shown below:

Add Liftoff Monetize as an ad source

Bidding

Under the Bidding card in the Ad Sources section, select Add Ad Source. Then select Liftoff Monetize.

Next, enter the Application ID, as well as the Placement Reference ID obtained in the previous section and click Done.

Finally, click Save.

Waterfall

In the Ad Sources card, select Add Ad Network. Select Liftoff Monetize and enable the Optimize switch.

For Reporting API Key, enter the Reporting API Key obtained in the previous section to set up ad source optimization for Liftoff Monetize. Then enter an eCPM value for Liftoff Monetize and click Continue.

If you already have a mapping for Liftoff Monetize, you can simply select it. Otherwise, click Add mapping.

Android

iOS

Next, enter the Application ID and Placement Reference ID obtained in the previous section. Then click Done.

Android

iOS

Add Liftoff to GDPR and US state regulations ad partners list

Follow the steps in GDPR settings and US state regulations settings to add Liftoff to the GDPR and US state regulations ad partners list in the AdMob UI.

Step 3: Import the Vungle SDK and Liftoff Monetize adapter

Download the latest version of Google Mobile Ads mediation plugin for Liftoff Monetize from the download link in the Changelog and extract the GoogleMobileAdsVungleMediation.unitypackage from the zip file.

In your Unity project editor, select Assets > Import Package > Custom Package and find the GoogleMobileAdsVungleMediation.unitypackage file you downloaded. Make sure all the files are selected and click Import.

Then, select Assets > Play Services Resolver > Android Resolver > Force Resolve. The Unity Play Services Resolver library will perform dependency resolution from scratch and copy the declared dependencies into the Assets/Plugins/Android directory of your Unity app.

Step 4: Implement privacy settings on Liftoff Monetize SDK

Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.

The Google Mobile Ads mediation plugin for Liftoff Monetize version 4.0.0 contains methods to pass consent information to the Vungle SDK.

Android

There are two possible values you can indicate when updating the consent status:

  • VungleConsentStatus.OPTED_IN
  • VungleConsentStatus.OPTED_OUT

The following sample code updates the consent status to VungleConsentStatus.OPTED_IN. If you choose to call this method, it is recommended that you do so prior to requesting ads using the Google Mobile Ads SDK.

using GoogleMobileAds.Mediation.LiftoffMonetize.Api;
// ...

LiftoffMonetize.UpdateConsentStatus(VungleConsentStatus.OPTED_IN, "1.0.0");

See GDPR recommended implementation instructions for more details and the values that can be provided in the method.

iOS

The following sample code forwards consent information to the Vungle iOS SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads using the Google Mobile Ads SDK.

using GoogleMobileAds.Mediation.LiftoffMonetize.Api;
// ...

LiftoffMonetize.SetGDPRStatus(true);
LiftoffMonetize.SetGDPRMessageVersion("1.0.0");

See GDPR recommended implementation instructions for more details and the values that can be provided in the method.

US state privacy laws

U.S. states privacy laws require giving users the right to opt out of the "sale" of their "personal information" (as the law defines those terms), with the opt-out offered via a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The U.S. states privacy laws compliance guide offers the ability to enable restricted data processing for Google ad serving, but Google is unable to apply this setting to each ad network in your mediation chain. Therefore, you must identify each ad network in your mediation chain that may participate in the sale of personal information and follow guidance from each of those networks to ensure compliance.

The Google Mobile Ads mediation plugin for Liftoff Monetize version 4.0.0 contains methods to pass consent information to the Vungle SDK.

Android

There are two possible values you can indicate when updating the consent status:

  • VungleCCPAStatus.OPTED_IN
  • VungleCCPAStatus.OPTED_OUT

The following sample code updates the consent status to VungleCCPAStatus.OPTED_IN. If you choose to call this method, it is recommended that you do so prior to requesting ads using the Google Mobile Ads SDK.

using GoogleMobileAds.Mediation.LiftoffMonetize.Api;
// ...

LiftoffMonetize.UpdateCCPAStatus(VungleCCPAStatus.OPTED_IN);

See CCPA recommended implementation instructions for more details and the values that can be provided in the method.

iOS

The following sample code forwards consent information to the Vungle iOS SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads using the Google Mobile Ads SDK.

using GoogleMobileAds.Mediation.LiftoffMonetize.Api;
// ...

LiftoffMonetize.SetCCPAStatus(true);

See CCPA recommended implementation instructions for more details and the values that can be provided in the method.

Step 5: Add required code

Android

No additional code is required Liftoff Monetize integration.

iOS

SKAdNetwork integration

Follow Liftoff Monetize's documentation to add the SKAdNetwork identifiers to your project's Info.plist file.

Liftoff Monetize required a list of all the placements that is used within your app to be passed to their SDK. You can provide the list of placements to the adapter using the VungleInterstitialMediationExtras and VungleRewardedVideoMediationExtras classes. The following code examples shows how to use these classes.

Interstitial

VungleInterstitialMediationExtras extras = new VungleInterstitialMediationExtras();
#if UNITY_ANDROID
    extras.SetAllPlacements(new string[] { "ANDROID_PLACEMENT_1", "ANDROID_PLACEMENT_2" });
#elif UNITY_IPHONE
    extras.SetAllPlacements(new string[] { "IOS_PLACEMENT_1", "IOS_PLACEMENT_2" });
#endif

AdRequest request = new AdRequest.Builder()
        .AddMediationExtras(extras)
        .Build();

Rewarded

VungleRewardedVideoMediationExtras extras = new VungleRewardedVideoMediationExtras();
#if UNITY_ANDROID
    extras.SetAllPlacements(new string[] { "ANDROID_PLACEMENT_1", "ANDROID_PLACEMENT_2" });
#elif UNITY_IPHONE
    extras.SetAllPlacements(new string[] { "IOS_PLACEMENT_1", "IOS_PLACEMENT_2" });
#endif

AdRequest request = new AdRequest.Builder()
        .AddMediationExtras(extras)
        .Build();

Step 6: Test your implementation

Enable test ads

Make sure you register your test device for AdMob and enable test mode in Liftoff Monetize UI.

Verify test ads

To verify that you are receiving test ads from Liftoff Monetize, enable single ad source testing in ad inspector using the Liftoff Monetize (Bidding) and Liftoff Monetize (Waterfall) ad source(s).

Error codes

If the adapter fails to receive an ad from Liftoff Monetize, publishers can check the underlying error from the ad response using ResponseInfo under the following classes:

iOS

Format Class name
Banner GADMAdapterVungleInterstitial
Interstitial GADMAdapterVungleInterstitial
Rewarded GADMAdapterVungleRewardBasedVideoAd

Here are the codes and accompanying messages thrown by the Liftoff Monetize adapter when an ad fails to load:

iOS

Error code Reason
1-100 Vungle SDK returned an error. See code for more details.
101 Liftoff Monetize server parameters configured in the AdMob UI are missing/invalid.
102 An ad is already loaded for this network configuration. Vungle SDK cannot load a second ad for the same placement ID.
103 The requested ad size does not match a Liftoff Monetize supported banner size.
104 Vungle SDK could not render the banner ad.
105 Vungle SDK only supports loading 1 banner ad at a time, regardless of placement ID.
106 Vungle SDK sent a callback saying the ad is not playable.

Liftoff Monetize Unity Mediation Plugin Changelog

Next Version

  • Fixed a duplicate definition warning for MediationExtras.

Version 4.0.0

  • Rebranded Unity mediation plugin from Vungle to Liftoff Monetize.
  • Moved adapter content to GoogleMobileAds/Mediation/LiftoffMonetize/.
  • Refactored adapter namespace to use GoogleMobileAds.Mediation.LiftoffMonetize.
  • Added the following methods to the LiftoffMonetize class:
    • SetGDPRStatus(bool)
    • SetGDPRMessageVersion(String)
    • SetCCPAStatus(bool)
  • Supports Liftoff Monetize Android adapter version 6.12.1.1.
  • Supports Liftoff Monetize iOS adapter version 7.0.1.0.
  • Built and tested with the Google Mobile Ads Unity Plugin version 8.4.1.

Version 3.9.2

Version 3.9.1

Version 3.9.0

Version 3.8.2

Version 3.8.1

Version 3.8.0

Version 3.7.5

Version 3.7.4

Version 3.7.3

Version 3.7.2

Version 3.7.1

Version 3.7.0

Version 3.6.0

Version 3.5.1

Version 3.5.0

Version 3.4.1

Version 3.4.0

Version 3.3.1

Version 3.3.0

Version 3.2.0

Version 3.1.4

  • Supports Android adapter version 6.3.24.1.
  • Supports iOS adapter version 6.3.2.3.

Version 3.1.3

  • Supports Android adapter version 6.3.24.1.
  • Supports iOS adapter version 6.3.2.2.

Version 3.1.2

  • Updated the plugin to support the new open-beta Rewarded API.
  • Supports Android adapter version 6.3.24.1.
  • Supports iOS adapter version 6.3.2.1.

Version 3.1.1

  • Supports Android adapter version 6.3.24.0.
  • Supports iOS adapter version 6.3.2.0.
  • Updated Vungle.UpdateConsentStatus() method to make the consentMessageVersion parameter optional. The value of consentMessageVersion is now ignored for iOS.
  • Deprecated Vungle.GetCurrentConsentMessageVersion() for iOS.

Version 3.1.0

  • Supports Android adapter version 6.3.17.0.
  • Supports iOS adapter version 6.3.0.0.
  • Updated Vungle.UpdateConsentStatus() method to take an additional String parameter for the publiser-provided consent message version.
  • Added Vungle.GetCurrentConsentMessageVersion() method to get the publisher-provided consent message version.

Version 3.0.1

  • Supports Android adapter version 6.2.5.1.
  • Supports iOS adapter version 6.2.0.3.

Version 3.0.0

  • Supports Android adapter version 6.2.5.0.
  • Supports iOS adapter version 6.2.0.2.
  • Added the following methods:
    • Vungle.UpdateConsentStatus() method to set the consent status that will be recorded in the Vungle SDK.
    • Vungle.GetCurrentConsentStatus() method to get the user's current consent status.

Version 2.0.0

  • Supports Android adapter version 5.3.2.1.
  • Supports iOS adapter version 6.2.0.0.

Version 1.1.0

  • Supports Android adapter version 5.3.2.1.
  • Supports iOS adapter version 5.4.0.0.

Version 1.0.0

  • First release!
  • Supports Android adapter version 5.3.0.0.
  • Supports iOS adapter version 5.3.0.0.