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 an iOS app.

Supported integrations and ad formats

The Ad Manager mediation adapter for Liftoff Monetize has the following capabilities:

Integration
Bidding 1
Waterfall
Formats
Banner
Interstitial
Rewarded
Rewarded Interstitial 2
Native 3

1 Bidding integration 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.

3 Bidding integration for this format is in closed beta.

Requirements

  • iOS deployment target of 12.0 or higher

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 dashboard by clicking the Add Application button.

Fill out the form, entering all the necessary details.

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

Take note of the App ID.

Add new placements

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

Details for adding new placements are included below:

Select Banner, enter a Placement Name and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

300x250 Banner

Select MREC, enter a Placement Name and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

Interstitial

Select Interstitial, enter a Placement Name, and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

Rewarded

Select Rewarded, enter a Placement Name and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

Rewarded Interstitial

Select Rewarded. Enter a Placement Name, enable Skippable and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

Native

Select Native, enter a Placement Name and fill out the rest of the form. [Bidding only] Under Monetization, toggle the In-App Bidding switch to Enabled. Click the Continue button at the bottom of the page to create the placement.

Take note of the Reference ID and click Sounds Good.

300x250 Banner

Interstitial

Rewarded

Rewarded Interstitial

Native

Locate your Reporting API Key

In addition to the App ID and the Reference ID, you'll also need your Liftoff Monetize Reporting API Key to set up your Ad Manager ad unit ID. Navigate to the Liftoff Monetize Reports dashboard and click 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.

Step 2: Set up Liftoff Monetize demand in Ad Manager UI

Sign in to your Ad Manager account.

Add Liftoff Monetize in Companies

Bidding

This step isn't required for bidding integrations.

Waterfall

Navigate to Admin > Companies, then click the New company button in the All companies tab. Select Ad network.

Select Liftoff Monetize as the Ad network, enter a unique Name and enable Mediation. Turn on Automatic data collection, and enter the Reporting API Key obtained in the previous section.

You don't need to enter a Username or Password. Click Save when done.

Enable secure signal sharing

Bidding

Navigate to Admin > Global settings. Go to the Ad Exchange account settings tab and review and toggle on Secure signal sharing. Click Save.

Waterfall

This step isn't required for waterfall integrations.

Configure Liftoff Monetize bidding

Bidding

Navigate to Delivery > Bidders, and click New bidder under the SDK Bidding tab.

Select Liftoff Monetize as the bidder.

Toggle on Add this bidder's signal library to the list of allowed signals and Allow signals to be shared with this bidder. Then, click Continue.

Click Continue.

Click Done.

Waterfall

This step isn't required for waterfall integrations.

Configure ad unit mapping

Bidding

Navigate to Delivery > Bidders, and select the company for Liftoff Monetize under the SDK Bidding tab.

Go to the Ad unit mapping tab and click New ad unit mapping.

Choose Specific ad unit. Select an ad unit and format, Mobile app as the Inventory type, and your Mobile application. Then, enter Application ID and Placement Reference ID obtained in the previous section. Finally, click Save.

Waterfall

Navigate to Delivery > Yield groups and click the New yield group button. Select your Mobile application.

Scroll down and click Add yield partner.

Select the company you created for Liftoff Monetize in the previous section. Choose Mobile SDK mediation as the Integration type, iOS as the Platform, and Active as the Status.

Enter the Application ID and Placement Reference ID obtained in the previous section, and the Default CPM value. Click Save.

Note: Automatic data collection takes a few days to gather data before it can accurately calculate a Dynamic CPM value for a mediation network. Once the eCPM can be calculated, it is automatically updated on your behalf.

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 Ad Manager UI.

Step 3: Import the Vungle SDK and adapter

  • Add the following line to your project's Podfile:

    pod 'GoogleMobileAdsMediationVungle'
    
  • From the command line run:

    pod install --repo-update
    

Manual integration

  • Download the latest version of the Vungle SDK and link VungleSDK.framework in your project.

  • Download the latest version of the Liftoff Monetize adapter from the download link in the Changelog and link LiftoffMonetizeAdapter.framework in your project.

  • Add the following Frameworks to your project:

    • AdSupport
    • AudioToolbox
    • AVFoundation
    • CFNetwork
    • CoreGraphics
    • CoreMedia
    • libz.tbd
    • MediaPlayer
    • QuartzCore
    • StoreKit
    • SystemConfiguration

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.

In SDK version 6.3.2, Liftoff Monetize added an API that lets you pass consent to the Vungle SDK. The following sample code shows how to pass this consent information to the Vungle SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads through the Google Mobile Ads SDK.

Swift

import VungleAdsSDK
// ...

VunglePrivacySettings.setGDPRStatus(true)
VunglePrivacySettings.setGDPRMessageVersion("v1.0.0")

Objective-C

#import <VungleAdsSDK/VungleAdsSDK.h>
// ...

[VunglePrivacySettings setGDPRStatus:YES];
[VunglePrivacySettings setGDPRMessageVersion:@"v1.0.0"];

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

US states 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.

In SDK version 6.7.0, Liftoff Monetize added an API that lets you pass consent to the Vungle SDK. The following sample code shows how to pass this consent information to the Vungle SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads through the Google Mobile Ads SDK.

Swift

import VungleAdsSDK
// ...

VunglePrivacySettings.setCCPAStatus(true)

Objective-C

#import <VungleAdsSDK/VungleAdsSDK.h>
// ...

[VunglePrivacySettings setCCPAStatus:YES];

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

Step 5: Add required code

SKAdNetwork integration

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

Step 6: Test your implementation

Enable test ads

Make sure you register your test device for Ad Manager 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).

Optional steps

Network-specific parameters

The Liftoff Monetize adapter supports an additional request parameter which can be passed to the adapter using the VungleAdNetworkExtras class. This class includes the following properties:

userId
A string representing Liftoff Monetize's Incentivized User ID.
nativeAdOptionPosition
An integer specifying the privacy icon position for native ads.

Here's a code example of how to create an ad request that sets these parameters:

Swift

#import "VungleAdapter.h"
// ...

let request = GAMRequest()
let extras = VungleAdNetworkExtras()
extras.userId = "myUserID"
extras.nativeAdOptionPosition = 1
// ...
request.register(extras)

Objective-C

#import <LiftoffMonetizeAdapter/VungleAdapter.h>
// ...

GAMRequest *request = [GAMRequest request];
VungleAdNetworkExtras *extras = [[VungleAdNetworkExtras alloc] init];
extras.userId = @"myUserID";
extras.nativeAdOptionPosition = 1;
// ...
[request registerAdNetworkExtras:extras];

Native ads rendering

The Liftoff Monetize adapter returns its native ads as GADNativeAd objects. It populates the following fields for a GADNativeAd.

Field Assets always included by Liftoff Monetize adapter
Headline
Image 1
Media view
Body
App icon
Call to action
Star rating
Store
Price

1 The Liftoff Monetize adapter does not provide direct access to the main image asset for its native ads. Instead, the adapter populates the GADMediaView with a video or an image.

Error codes

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

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:

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

Liftoff Monetize iOS Mediation Adapter Changelog

Next version

  • Included Info.plist in the frameworks in LiftoffMonetizeAdapter.xcframework.

Version 7.2.2.0

  • Verified compatibility with Vungle SDK 7.2.2.
  • Now requires minimum iOS version of 12.0.

Built and tested with:

  • Google Mobile Ads SDK version 11.0.0.
  • Vungle SDK version 7.2.2.

Version 7.2.1.1

  • Updated the MREC matching to be any size that can fit an MREC instead of being an exact match.

Built and tested with:

  • Google Mobile Ads SDK version 10.14.0.
  • Vungle SDK version 7.2.1.

Version 7.2.1.0

  • Verified compatibility with Vungle SDK 7.2.1.

Built and tested with:

  • Google Mobile Ads SDK version 10.14.0.
  • Vungle SDK version 7.2.1.

Version 7.2.0.0

  • Verified compatibility with Vungle SDK 7.2.0.
  • Removed the deprecated willBackgroundApplication delegate methods from the banner and interstitial ad implementations.
  • Replaced the deprecated childDirectedTreatment method with the GADMobileAds.sharedInstance.requestConfiguration.tagForChildDirectedTreatment property.

Built and tested with:

  • Google Mobile Ads SDK version 10.14.0.
  • Vungle SDK version 7.2.0.

Version 7.1.0.0

  • Verified compatibility with Vungle SDK 7.1.0.

Built and tested with:

  • Google Mobile Ads SDK version 10.10.0.
  • Vungle SDK version 7.1.0.

Version 7.0.1.0

  • Added watermark support for bidding ads.
  • Verified compatibility with Vungle SDK 7.0.1.

Built and tested with:

  • Google Mobile Ads SDK version 10.7.0.
  • Vungle SDK version 7.0.1.

Version 7.0.0.0

  • Rebranded adapter name from Vungle to Liftoff Monetize.
  • Verified compatibility with Vungle SDK 7.0.0.
  • Removed support of the armv7 architecture.
  • Added support for the arm64 simulator architecture.
  • Now requires minimum iOS version 11.0.
  • Now requires Google Mobile Ads SDK version 10.4.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 10.4.0.
  • Vungle SDK version 7.0.0.

Version 6.12.3.0

  • Verified compatibility with Vungle SDK 6.12.3.

Built and tested with:

  • Google Mobile Ads SDK version 10.2.0.
  • Vungle SDK version 6.12.3.

Version 6.12.2.0

  • Verified compatibility with Vungle SDK 6.12.2.

Built and tested with:

  • Google Mobile Ads SDK version 10.0.0.
  • Vungle SDK version 6.12.2.

Version 6.12.1.2

  • Now requires Google Mobile Ads SDK version 10.0.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 10.0.0.
  • Vungle SDK version 6.12.1.

Version 6.12.1.1

  • Verified compatibility with Vungle SDK 6.12.1.
  • Added bidding support for banner ad format.

Built and tested with:

  • Google Mobile Ads SDK version 9.14.0.
  • Vungle SDK version 6.12.1.

Version 6.12.1.0

  • Verified compatibility with Vungle SDK 6.12.1.

Built and tested with:

  • Google Mobile Ads SDK version 9.13.0.
  • Vungle SDK version 6.12.1.

Version 6.12.0.0

  • Verified compatibility with Vungle SDK 6.12.0.
  • Added waterfall mediation and bidding support for rewarded interstitial ad format.
  • Added bidding support for native ad format.
  • Updated the adapter to use the didRewardUser API.
  • Removed the ordinal extra in VungleAdNetworkExtras.
  • Now requires Google Mobile Ads SDK version 9.8.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 9.9.0.
  • Vungle SDK version 6.12.0.

Version 6.11.0.2

  • Added waterfall mediation support for native ad format.

Built and tested with:

  • Google Mobile Ads SDK version 9.8.0.
  • Vungle SDK version 6.11.0.

Version 6.11.0.1

  • Added support for loading multiple ads for the same placement ID in bidding interstitial and rewarded ads.

Built and tested with:

  • Google Mobile Ads SDK version 9.6.0.
  • Vungle SDK version 6.11.0

Version 6.11.0.0

  • Verified compatibility with Vungle SDK 6.11.0.

Built and tested with:

  • Google Mobile Ads SDK version 9.4.0.
  • Vungle SDK version 6.11.0

Version 6.10.6.1

  • Fixed an issue where the ad delegate was removed if the next ad failed to download. This applies to auto-cached setting placements only.
  • Removed willPresentFullScreenView and adapterWillPresentFullScreenModal callbacks in banner ads.

Built and tested with:

  • Google Mobile Ads SDK version 9.0.0.
  • Vungle SDK version 6.10.6

Version 6.10.6.0

  • Verified compatibility with Vungle SDK 6.10.6.
  • Verified compatibility with Google Mobile Ads SDK version 9.0.0.
  • Now requires Google Mobile Ads SDK version 9.0.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 9.0.0.
  • Vungle SDK version 6.10.6

Version 6.10.5.1

  • Added bidding support for interstitial and rewarded ad formats.

Built and tested with

  • Google Mobile Ads SDK version 8.13.0.
  • Vungle SDK version 6.10.5

Version 6.10.5.0

  • Verified compatibility with Vungle SDK 6.10.5.

Built and tested with

  • Google Mobile Ads SDK version 8.13.0.
  • Vungle SDK version 6.10.5

Version 6.10.4.0

  • Verified compatibility with Vungle SDK 6.10.4.
  • Updated the adapter to respect the mute setting in Vungle's publisher dashboard when the muteIsSet boolean in VungleAdNetworkExtras is not explicitly set.

Built and tested with

  • Google Mobile Ads SDK version 8.12.0.
  • Vungle SDK version 6.10.4

Version 6.10.3.1

  • Fixed a bug where interstitial callbacks were not invoked after the first playback.
  • Updated the options dictionary that is passed into playAd method to include the muted property set by the publisher in the extras object.

Built and tested with

  • Google Mobile Ads SDK version 8.12.0.
  • Vungle SDK version 6.10.3

Version 6.10.3.0

  • Verified compatibility with Vungle SDK 6.10.3.
  • Now requires minimum iOS version of 10.0.

Built and tested with

  • Google Mobile Ads SDK version 8.11.0.
  • Vungle SDK version 6.10.3.

Version 6.10.1.0

  • Verified compatibility with Vungle SDK 6.10.1.
  • Relaxed dependency to Google Mobile Ads SDK version 8.0.0 or higher.
  • Now requires building against Xcode 12.5 or higher.

Built and tested with

  • Google Mobile Ads SDK version 8.9.0.
  • Vungle SDK version 6.10.1.

Version 6.10.0.0 (rolled back)

  • Verified compatibility with Vungle SDK 6.10.0.
  • Relaxed dependency to Google Mobile Ads SDK version 8.0.0 or higher.
  • Now requires building against Xcode 12.5 or higher.

Built and tested with

  • Google Mobile Ads SDK version 8.4.0.
  • Vungle SDK version 6.10.0.

Version 6.9.2.0

  • Verified compatibility with Vungle SDK 6.9.2.
  • Now requires Google Mobile Ads SDK version 8.3.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 8.3.0.
  • Vungle SDK version 6.9.2.

Version 6.9.1.0

  • Verified compatibility with Vungle SDK 6.9.1.
  • Now requires Google Mobile Ads SDK version 8.1.0 or higher.
  • Added standardized adapter error codes and messages.
  • Updated the adapter to use the .xcframework format.
  • Remove VungleSDKResetPlacementForDifferentAdSize error check for loading Ads.
  • Introduce the new SDK delegate callback vungleAdViewedForPlacement: to track impression.

Built and tested with

  • Google Mobile Ads SDK version 8.1.0.
  • Vungle SDK version 6.9.1.

Version 6.8.1.0

  • Verified compatibility with Vungle SDK 6.8.1.
  • Now requires Google Mobile Ads SDK version 7.66.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 7.66.0.
  • Vungle SDK version 6.8.1.

Version 6.8.0.0

  • Verified compatibility with Vungle SDK 6.8.0.
  • Now requires Google Mobile Ads SDK version 7.65.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 7.65.0.
  • Vungle SDK version 6.8.0.

Version 6.7.1.0

  • Verified compatibility with Vungle SDK 6.7.1.
  • Now requires Google Mobile Ads SDK version 7.64.0 or higher.
  • Fixed an issue where didFailToPresentWithError: was not called when a rewarded ad failed to present.

Built and tested with

  • Google Mobile Ads SDK version 7.64.0.
  • Vungle SDK version 6.7.1.

Version 6.7.0.0

  • Verified compatibility with Vungle SDK 6.7.0.
  • Now requires Google Mobile Ads SDK version 7.62.0 or higher.
  • Added support for playing multiple banner ads at the same time.
  • Clicks now reported when the click happens instead of when the ad is closed.
  • Banner and interstitial ads now forward the willLeaveApplication callback.

Built and tested with

  • Google Mobile Ads SDK version 7.62.0.
  • Vungle SDK version 6.7.0.

Version 6.5.3.0

  • Verified compatibility with Vungle SDK 6.5.3.
  • Now requires Google Mobile Ads SDK version 7.58.0 or higher.
  • Added support for Smart and Adaptive Banner ads.
  • Added support for Banner (320x50, 300x50, 728x90) ads.
  • Added video orientation option when play ads.
  • Fix a bug where failed to call report_ad after the first refresh.
  • Fix ad availability delays issue with longer waterfall.
  • Remove support for i386 architecture.

Built and tested with

  • Google Mobile Ads SDK version 7.58.0.
  • Vungle SDK version 6.5.3.

Version 6.4.6.0

  • Verified compatibility with Vungle SDK 6.4.6.
  • Added support for banner (MREC) ads.
  • Fixed a bug where didReceiveInterstitial: callback is called more than once.
  • Removed callbacks to adapterWillLeaveApplication, which were previously not invoked at the correct time.

Built and tested with

  • Google Mobile Ads SDK version 7.52.0.
  • Vungle SDK version 6.4.6.

Version 6.3.2.3

  • Fixed a crash in [GADMAdapterVungleRewardedAd adAvailable:].

Version 6.3.2.2

  • Fixed a bug where the Vungle adapter would never load rewarded ads if Vungle SDK initialization failed. Now, the adapter will try to re-initialize the Vungle SDK on subsequent rewarded ad requests.
  • Now requires Google Mobile Ads SDK version 7.42.2 or higher.

Version 6.3.2.1

  • Updated the adapter to use new rewarded API.
  • Now requires Google Mobile Ads SDK version 7.41.0 or higher.

Version 6.3.2.0

  • Verified compatibility with Vungle SDK 6.3.2.

Version 6.3.0.0

  • Verified compatibility with Vungle SDK 6.3.0.
  • Updated updateConsentStatus method to updateConsentStatus:consentMessageVersion: in VungleRouterConsent class.

Version 6.2.0.3

  • Added adapterDidCompletePlayingRewardBasedVideoAd: callback to the adapter.

Version 6.2.0.2

  • Added VungleRouterConsent class which contains updateConsentStatus and getConsentStatus methods.

Version 6.2.0.1

  • Updated Vungle SDK initializer correctly.

Version 6.2.0.0

  • Verified compatibility with Vungle SDK 6.2.0.

Version 5.4.0.0

  • Verified compatibility with Vungle SDK 5.4.0.
  • Updated adapter to correctly report clicks to the Google Mobile Ads SDK.

Version 5.3.2.0

  • Added two new extras to VungleAdNetworkExtras:
    • ordinal - An integer indicating the order in which this ad was shown in the game session.
    • flexViewAutoDismissSeconds - Sets Flex View ads to automatically close in the specified amount of seconds.
  • Verified compatibility with Vungle SDK 5.3.2.

Version 5.3.0.0

  • Updated the deployment target to iOS 8.
  • Verified compatibility with Vungle SDK 5.3.0.

Version 5.2.0.0

  • Verified compatibility with Vungle SDK 5.2.0.

Version 5.1.1.0

  • Verified compatibility with Vungle SDK 5.1.1.

Version 5.1.0.0

  • Verified compatibility with Vungle SDK 5.1.0.

Earlier versions

  • Added support for interstitial and rewarded video ad formats.