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 Android app.
Supported integrations and ad formats
The mediation adapter for Liftoff Monetize has the following capabilities:
Integration | |
---|---|
Bidding | 1 |
Waterfall | |
Formats | |
App Open | |
Banner | |
Interstitial | |
Rewarded | |
Rewarded Interstitial | 3 |
Native | 2 |
1 Bidding integration is in open beta.
2 Bidding integration for this format is in closed beta.
3 Rewarded
interstitial requires assistance to set up. Reach out to your account
manager at Liftoff Monetize or monetize@liftoff.io
.
Requirements
Android API level 21 or higher
Latest Google Mobile Ads SDK
Complete the mediation Get started guide
Step 1: Set up configurations in Liftoff Monetize UI
点击添加应用按钮,将您的应用添加到 Liftoff Monetize 信息中心。
填写表单,输入所有必填的详细信息。
创建应用后,从 Liftoff Monetize Applications 信息中心选择您的应用。
记下应用 ID。
添加新的展示位置
如需创建要与 Ad Manager中介结合使用的新展示位置,请前往 Liftoff“Monetize Placement”信息中心,点击添加展示位置按钮,然后从下拉列表中选择您的应用。
有关添加新展示位置的详情,请参见下文:
横幅
选择横幅,输入展示位置名称,然后填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮创建展示位置。
300 x 250 横幅
选择 MREC,输入展示位置名称,然后填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮创建展示位置。
插页式广告
选择 插页式广告,输入展示位置名称,然后填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮以创建展示位置。
已奖励
选择激励广告,输入展示位置名称并填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮创建展示位置。
插页式激励广告
选择激励广告。输入展示位置名称,启用可跳过并填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮以创建展示位置。
原生
选择原生,输入展示位置名称,然后填写表单的其余部分。[仅出价] 在创收下,将应用内出价开关切换为已启用。点击页面底部的继续按钮创建展示位置。
记下参考 ID,然后点击听起来不错。
横幅
300 x 250 横幅
插页式广告
已奖励
插页式激励广告
原生
找到您的 Reporting API 密钥
出价
出价集成不需要执行此步骤。
瀑布
除了应用 ID 和参考 ID 之外,您还需要 Liftoff Monetize Reporting API 密钥才能设置Ad Manager 广告单元 ID。前往 Liftoff Monetize Reports 信息中心,然后点击 Reporting API Key 按钮,查看您的 Reporting API Key。
开启测试模式
如需启用测试广告,请转到 Liftoff Monetize 信息中心并导航到 Applications。
在应用的展示位置参考 ID 部分下,选择要启用测试广告的应用。在状态部分下,将测试模式选为仅显示测试广告即可启用测试广告。
Step 2: Set up Liftoff Monetize demand in Ad Manager UI
登录您的 Ad Manager 帐号。
添加 Liftoff Monetize 公司
出价
出价集成不需要执行此步骤。
瀑布
依次前往管理 > 公司,然后点击所有公司标签页中的新公司按钮。选择广告联盟。
选择 Liftoff Monetize 作为广告联盟,输入一个唯一的名称并启用中介。 开启自动数据收集,然后输入在上一部分中获得的 Reporting API Key。
您无需输入用户名或密码。完成后,点击保存。
启用安全信号共享
出价
依次前往管理 > 全局设置。前往 Ad Exchange 帐号设置标签页,然后查看并开启安全信号共享。点击保存。
瀑布
广告瀑布流集成不需要执行此步骤。
配置 Liftoff Monetize 出价
出价
依次前往投放 > 出价方,然后点击 SDK 出价标签页下的新出价方。
选择Liftoff Monetize作为出价方。
开启将此出价方的信号库添加到允许的信号列表中和允许与此出价方共享信号。然后,点击继续。
点击继续。
点击完成。
瀑布
广告瀑布流集成不需要执行此步骤。
配置广告单元映射
出价
依次前往投放 > 出价方,然后在 SDK 出价标签页下,为Liftoff Monetize 选择公司。
转到广告单元映射标签页,然后点击新建广告单元映射。
选择特定广告单元。选择一种广告单元和格式,选择移动应用作为广告资源类型,然后选择移动应用。然后,输入在上一部分中获得的Application ID and Placement Reference ID 。最后,点击保存。
瀑布
依次转到投放 > 收益组,然后点击新建收益组按钮。选择您的移动应用。
向下滚动,然后点击添加收益合作伙伴。
选择您在上一部分中为 Liftoff Monetize创建的公司。选择移动 SDK 中介作为集成类型,选择 Android 作为平台,选择活跃作为状态。
输入在上一部分获得的 Application ID and Placement Reference ID,以及默认 CPM 值。点击保存。
注意:“自动收集数据”功能需要几天时间来收集数据,然后才能准确计算中介广告联盟的动态 CPM 值。可以计算出 eCPM 后,系统会自动为您更新该值。
Add Liftoff to GDPR and US state regulations ad partners list
按照 GDPR 设置 和 美国州级法规设置 中的步骤,将 Liftoff 添加到 Ad Manager 界面中的 GDPR 和美国州级法规广告合作伙伴列表中。
Step 3: Import the Vungle SDK and adapter
Android Studio integration (recommended)
In your app-level build.gradle.kts
file, add the following implementation
dependencies and configurations. Use the latest versions of the Vungle SDK
and adapter:
dependencies {
implementation("com.google.android.gms:play-services-ads:23.3.0")
implementation("com.google.ads.mediation:vungle:7.4.1.0")
}
Manual integration
Download the latest Vungle Android SDK and extract the
.jar
files under thelibs
folder and add it to your project.Navigate to the Liftoff Monetize adapter artifacts on Google's Maven Repository. Select the latest version, download the Vungle adapter's
.aar
file, and add it to your project.
Step 4: Implement privacy settings on Liftoff Monetize SDK
EU consent and GDPR
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.
Liftoff Monetize includes 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.
Java
import com.vungle.ads.VunglePrivacySettings;
// ...
VunglePrivacySettings.setGDPRStatus(true, "v1.0.0");
Kotlin
import com.vungle.ads.VunglePrivacySettings
// ...
VunglePrivacySettings.setGDPRStatus(true, "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.
Liftoff Monetize includes 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.
Java
import com.vungle.ads.VunglePrivacySettings;
// ...
VunglePrivacySettings.setCCPAStatus(true);
Kotlin
import com.vungle.ads.VunglePrivacySettings
// ...
VunglePrivacySettings.setCCPAStatus(true)
See CCPA implementation for more details and the values that can be provided in the method.
Step 5: Add required code
No additional code required for Liftoff Monetize integration.
Step 6: Test your implementation
启用测试广告
请务必为Ad Manager 注册您的测试设备,并在 Liftoff Monetize 界面中启用测试模式。
验证测试广告
如需验证您收到的是来自Liftoff Monetize的测试广告,请使用相应广告来源在广告检查器中启用单一广告来源测试。 Liftoff Monetize (Bidding) and Liftoff Monetize (Waterfall)
Optional steps
Network-specific parameters
The Liftoff Monetize adapter supports the following additional request parameters which can be passed to the adapter:
userId
- A string representing Liftoff Monetize's Incentivized User ID.
adOrientation
- An integer specifying the presentation orientation for full-screen ads.
Here's a code example of how to create an ad request that sets these parameters:
Java
Bundle extras = new Bundle();
extras.putString(VungleConstants.KEY_USER_ID, "myUserID");
extras.putInt(VungleConstants.KEY_ORIENTATION, 1);
AdManagerAdRequest request = new AdManagerAdRequest.Builder()
.addNetworkExtrasBundle(VungleAdapter.class, extras) // Rewarded.
.addNetworkExtrasBundle(VungleInterstitialAdapter.class, extras) // Interstitial.
.build();
Kotlin
val extras = Bundle()
extras.putString(VungleConstants.KEY_USER_ID, "myUserID")
extras.putInt(VungleConstants.KEY_ORIENTATION, 1)
val request = AdManagerAdRequest.Builder()
.addNetworkExtrasBundle(VungleAdapter::class, extras) // Rewarded.
.addNetworkExtrasBundle(VungleInterstitialAdapter.class, extras) // Interstitial.
.build()
Native ads rendering
The Liftoff Monetize adapter returns its native ads as
NativeAd
objects. It populates the following
fields
for a
NativeAd
.
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
MediaView
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
ResponseInfo.getAdapterResponses()
under the following classes:
Format | Class name |
---|---|
App Open (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
App Open (Waterfall) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Banner (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Banner (Waterfall) | com.vungle.mediation.VungleInterstitialAdapter |
Interstitial (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Interstitial (Waterfall) | com.vungle.mediation.VungleInterstitialAdapter |
Rewarded (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Rewarded (Waterfall) | com.vungle.mediation.VungleAdapter |
Rewarded Interstitial (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Rewarded Interstitial (Waterfall) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Native (Bidding) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Native (Waterfall) | com.google.ads.mediation.vungle.VungleMediationAdapter |
Here are the codes and accompanying messages thrown by the Liftoff Monetize adapter when an ad fails to load:
Error code | Domain | Reason |
---|---|---|
101 | com.google.ads.mediation.vungle | Invalid server parameters (e.g. app ID or placement ID). |
102 | com.google.ads.mediation.vungle | The requested banner size does not map to a valid Liftoff Monetize ad size. |
103 | com.google.ads.mediation.vungle | Liftoff Monetize requires an Activity context to request
ads. |
104 | com.google.ads.mediation.vungle | The Vungle SDK cannot load multiple ads for the same placement ID. |
105 | com.google.ads.mediation.vungle | The Vungle SDK failed to initialize. |
106 | com.google.ads.mediation.vungle | Vungle SDK returned a successful load callback, but Banners.getBanner() or Vungle.getNativeAd() returned null. |
107 | com.google.ads.mediation.vungle | Vungle SDK is not ready to play the ad. |
108 | com.google.ads.mediation.vungle | Vungle SDK returned invalid bidding token. |
For errors that come from the Vungle SDK, refer to Error Codes: Vungle SDK for iOS and Android.
Liftoff Monetize Android Mediation Adapter Changelog
Version 7.4.1.0
- Verified compatibility with Vungle SDK 7.4.1.
Built and tested with:
- Google Mobile Ads SDK version 23.3.0.
- Vungle SDK version 7.4.1.
Version 7.4.0.1
- Added custom ad size support for bidding and waterfall banner ads.
Built and tested with:
- Google Mobile Ads SDK version 23.2.0.
- Vungle SDK version 7.4.0.
Version 7.4.0.0
- Extended the
VungleInterstitialAdapter
class fromVungleMediationAdapter
to add waterfall support for the app open ad format on Google Ad Manager. - Verified compatibility with Vungle SDK 7.4.0.
Built and tested with:
- Google Mobile Ads SDK version 23.2.0.
- Vungle SDK version 7.4.0.
Version 7.3.2.0
- Verified compatibility with Vungle SDK 7.3.2.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Vungle SDK version 7.3.2.
Version 7.3.1.0
- Verified compatibility with Vungle SDK 7.3.1.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Vungle SDK version 7.3.1.
Version 7.3.0.0
- Updated the minimum required Google Mobile Ads SDK version to 23.0.0.
- Verified compatibility with Vungle SDK 7.3.0.
- Added waterfall and bidding support for app open ad format.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Vungle SDK version 7.3.0.
Version 7.1.0.0
- Verified compatibility with Vungle SDK 7.1.0.
Built and tested with:
- Google Mobile Ads SDK version 22.3.0.
- Vungle SDK version 7.1.0.
Version 7.0.0.1
- Fixed an issue where Google Mobile Ads SDK was not recording impressions for bidding native ads.
- Reverted the adapter to depend on Google Mobile Ads SDK version 22.3.0.
Built and tested with:
- Google Mobile Ads SDK version 22.3.0.
- Vungle SDK version 7.0.0.
Version 7.0.0.0
- Added support to load multiple ads with the same placement ID for all waterfall ad formats.
- Rebranded adapter name from Vungle to Liftoff Monetize.
- Verified compatibility with Vungle SDK 7.0.0.
Built and tested with:
- Google Mobile Ads SDK version 22.4.0.
- Vungle SDK version 7.0.0.
Version 6.12.1.1
- Updated adapter to use new
VersionInfo
class. - Updated the minimum required Google Mobile Ads SDK version to 22.0.0.
Built and tested with:
- Google Mobile Ads SDK version 22.0.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 21.4.0.
- Vungle SDK version 6.12.1.
Version 6.12.0.1
- Added bidding support for banner ad format.
- Verified compatibility with Vungle SDK 6.12.0.
- Updated the minimum required Google Mobile Ads SDK version to 21.4.0.
Built and tested with:
- Google Mobile Ads SDK version 21.4.0.
- Vungle SDK version 6.12.0.
Version 6.12.0.0
- Added waterfall mediation and bidding support for rewarded interstitial ad format.
- Added bidding support for native ad format.
Built and tested with:
- Google Mobile Ads SDK version 21.1.0.
- Vungle SDK version 6.12.0.
Version 6.11.0.3
- Added waterfall mediation support for native ad format.
- Updated the minimum required Google Mobile Ads SDK version to 21.1.0.
Built and tested with:
- Google Mobile Ads SDK version 21.1.0.
- Vungle SDK version 6.11.0.
Version 6.11.0.2
- Added support for loading multiple ads for the same placement ID in rewarded bidding ads.
Built and tested with:
- Google Mobile Ads SDK version 21.0.0.
- Vungle SDK version 6.11.0.
Version 6.11.0.1
- Updated
compileSdkVersion
andtargetSdkVersion
to API 31. - Updated the minimum required Google Mobile Ads SDK version to 21.0.0.
- Updated the minimum required Android API level to 19.
Built and tested with:
- Google Mobile Ads SDK version 21.0.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 20.6.0.
- Vungle SDK version 6.11.0.
Version 6.10.5.0
- Verified compatibility with Vungle SDK 6.10.5.
- Updated the minimum required Google Mobile Ads SDK version to 20.6.0.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Vungle SDK version 6.10.5.
Version 6.10.4.0
- Verified compatibility with Vungle SDK 6.10.4.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Vungle SDK version 6.10.4.
Version 6.10.3.0
- Verified compatibility with Vungle SDK 6.10.3.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Vungle SDK version 6.10.3.
Version 6.10.2.1
- Verified compatibility with Vungle SDK 6.10.2.
- Added bidding support for interstitial and rewarded ad formats.
- Updated the minimum required Google Mobile Ads SDK version to 20.5.0.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Vungle SDK version 6.10.2.
Version 6.10.2.0
- Verified compatibility with Vungle SDK 6.10.2.
- Fixed an adapter issue by replacing parameter
serverParameters
, withmediationExtras
to obtain Vungle network-specific parameters, when requesting Banner and Interstitial ads.
Built and tested with:
- Google Mobile Ads SDK version 20.3.0.
- Vungle SDK version 6.10.2.
Version 6.10.1.0
- Verified compatibility with Vungle SDK 6.10.1.
- Updated the minimum required Google Mobile Ads SDK version to 20.3.0.
- MREC Ads are now supported with Vungle's banner API.
- Updated standardized error codes and messages.
Built and tested with:
- Google Mobile Ads SDK version 20.3.0.
- Vungle SDK version 6.10.1.
Version 6.9.1.1
- Updated the minimum required Google Mobile Ads SDK version to 20.0.0.
Built and tested with:
- Google Mobile Ads SDK version 20.0.0.
- Vungle SDK version 6.9.1.
Version 6.9.1.0
- Verified compatibility with Vungle SDK 6.9.1.
- Added support for OMSDK.
- Various bug fixes.
- Rewarded Ad Support for Vungle onAdViewed callback.
- Updated the minimum required Google Mobile Ads SDK version to 19.7.0.
Built and tested with:
- Google Mobile Ads SDK version 19.7.0.
- Vungle SDK version 6.9.1.
Version 6.8.1.1
- Updated the minimum required Google Mobile Ads SDK version to 19.6.0.
Built and tested with:
- Google Mobile Ads SDK version 19.6.0.
- Vungle SDK version 6.8.1.
Version 6.8.1.0
- Verified compatibility with Vungle SDK 6.8.1.
- Updated the minimum required Google Mobile Ads SDK version to 19.5.0.
Built and tested with:
- Google Mobile Ads SDK version 19.5.0.
- Vungle SDK version 6.8.1.
Version 6.8.0.0
- Verified compatibility with Vungle SDK 6.8.0.
- Updated the adapter to not forward
onAdClosed()
when banner ads are refreshed or destroyed. - Remove
FlexFeed
andFlexView
(deprecated in Vungle 6.8.0). - Updated the minimum required Google Mobile Ads SDK version to 19.4.0.
Built and tested with:
- Google Mobile Ads SDK version 19.4.0.
- Vungle SDK version 6.8.0.
Version 6.7.1.0
- Verified compatibility with Vungle SDK 6.7.1.
- Fixed a bug where ads wouldn't load if an ad was loaded using an application context.
- Updated
targetSdkVersion
to API 29. - Updated the minimum required Google Mobile Ads SDK version to 19.3.0.
Built and tested with:
- Google Mobile Ads SDK version 19.3.0.
- Vungle SDK version 6.7.1.
Version 6.7.0.0
- Verified compatibility with Vungle SDK 6.7.0.
- Updated the adapter to support inline adaptive banner requests.
- Interstitial and rewarded ads are now unmuted by default.
- Interstitial ads now forward the
onAdLeftApplication()
callback when clicked. - Updated the minimum required Google Mobile Ads SDK version to 19.2.0.
Built and tested with:
- Google Mobile Ads SDK version 19.2.0.
- Vungle SDK version 6.7.0.
Version 6.5.3.0
- Verified compatibility with Vungle SDK 6.5.3.
- Add support for the newly-introduced Vungle's Banner format.
- Updated the minimum required Google Mobile Ads SDK version to 19.0.1.
Built and tested with:
- Google Mobile Ads SDK version 19.0.1.
- Vungle SDK version 6.5.3.
Version 6.4.11.1
- Fixed an issue where banner ads failed to refresh.
Version 6.4.11.0
- Verified compatibility with Vungle SDK 6.4.11.
- Added support for banner ads.
- Migrated the adapter to AndroidX.
- Updated the minimum required Google Mobile Ads SDK version to 18.2.0.
Version 6.3.24.1
- Updated adapter to support new open-beta Rewarded API.
- Updated the minimum required Google Mobile Ads SDK version to 17.2.0.
Version 6.3.24.0
- Verified compatibility with Vungle SDK 6.3.24.
Version 6.3.17.0
- Verified compatibility with Vungle SDK 6.3.17.
Version 6.3.12.0
- Verified compatibility with Vungle SDK 6.3.12.
Version 6.2.5.1
- Updated the adapter to invoke the
onRewardedVideoComplete()
ad event.
Version 6.2.5.0
- Verified compatibility with Vungle SDK 6.2.5.
Version 5.3.2.1
- Updated adapter to correctly report clicks to the Google Mobile Ads SDK.
Version 5.3.2.0
- Verified compatibility with Vungle SDK 5.3.2.
- Updated the Adpater project for Android Studio 3.0.
- Added the following methods to Bundle builder class.
setOrdinalViewCount
: This field is used to pass the mediation ordinal, whenever Publisher receives the ordinal data reports from Vungle.setFlexViewCloseTimeInSec
: This option is used to make flex view ads dismiss on their own after the specified number of seconds.
Version 5.3.0.0
- Verified compatibility with Vungle SDK 5.3.0.
Version 5.1.0.0
- Updated the adapter to make it compatible with Vungle SDK 5.1.0.
- Changed the version naming system to [Vungle SDK version].[adapter patch version].
Earlier versions
- Added support for interstitial and rewarded video ad formats.