Integrate Vungle with Mediation

Stay organized with collections Save and categorize content based on your preferences.

This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Vungle using mediation, covering both bidding and waterfall integrations. It covers how to add Vungle 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 AdMob mediation adapter for Vungle has the following capabilities:

Integration
Bidding  1
Waterfall
Formats
Banner  2
Interstitial
Rewarded
Rewarded Interstitial  2  3
Native  2  3
1 Bidding integration is in beta.

2 Not supported in bidding (supported only for waterfall mediation).

3 For access to this feature, contact your Vungle account manager.

Requirements

  • Android API level 21 or higher

  • [For bidding]: Vungle adapter 6.11.0.2 or higher (latest version recommended)

  • Latest Google Mobile Ads SDK

Limitations

  • Vungle does not support loading multiple ads using the same Placement Reference ID.
    • The Vungle adapter gracefully fails the 2nd request if another request for that placement is loading or waiting to be shown.
  • Vungle only supports loading 1 banner ad at a time.
    • The Vungle adapter gracefully fails subsequent banner requests if a banner ad is already loaded.

Step 1: Set up Vungle

Sign up or log in to your Vungle account.

Add your app to the Vungle Applications 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 Vungle Applications dashboard.

Take note of the App ID.

Add new placements

To create a new placement to be used with AdMob mediation, navigate to the Vungle 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.

Rewarded Interstitial

Reach out to your Vungle account manager to get access to create rewarded interstitial ad placements in the Vungle dashboard.

Native

Reach out to your Vungle account manager to get access to create native ad placements in the Vungle dashboard.

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

Rewarded Interstitial

Reach out to your Vungle account manager to get access to create rewarded interstitial ad placements in the Vungle dashboard.

Native

Reach out to your Vungle account manager to get access to create native ad placements in the Vungle dashboard.

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 Vungle Reporting API Key to set up your AdMob ad unit ID. Navigate to the Vungle Reports dashboard and click on the Reporting API Key button to view your Reporting API Key.

Step 2: Configure mediation settings for your AdMob ad unit

You need to add Vungle to the mediation configuration for your ad unit. First, sign in to your AdMob account.

Next, 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 Vungle as an ad source.

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

Enter your ad format and platform, then click Continue.

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 Vungle as an ad source

In the Ad Sources card, select Add Ad Network. Select Vungle 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 Vungle. Then enter an eCPM value for Vungle and click Continue.

Enter the Application ID and Placement Reference ID obtained in the previous section. If you're using Vungle SDK version 4.x or earlier, the Placement Reference ID can be any value.

Rewarded ads

In the settings for your rewarded ad unit, provide values for the reward amount and reward type. Then, to ensure you provide the same reward to the user no matter which ad network is served, check the Apply to all networks in Mediation groups box.

If you don't apply this setting, the Vungle adapter defaults to a reward of type vungle with a value of 1. The Vungle SDK does not provide specific reward values for its rewarded ads.

For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the Vungle SDK and adapter

Add the following implementation dependency with the latest version of the Vungle SDK and adapter in the app-level build.gradle file:

repositories {
    google()
    mavenCentral()
}

...
dependencies {
    implementation 'com.google.android.gms:play-services-ads:21.5.0'
    implementation 'com.google.ads.mediation:vungle:6.12.1.0'
}
...

Manual integration

  • Download the latest Vungle Android SDK and extract the .jar files under the libs folder and add it to your project.

  • Navigate to the Vungle 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: Add required code

No additional code required for Vungle integration.

Step 5: Test your implementation

To enable test ads, go to your Vungle 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.

That's it! You now have a working mediation integration with Vungle.

Optional steps

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.2.5, Vungle 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.

Java

import com.vungle.warren.Vungle;
// ...

Vungle.updateConsentStatus(Vungle.Consent.OPTED_IN, "1.0.0");

Kotlin

import com.vungle.warren.Vungle
// ...

Vungle.updateConsentStatus(Vungle.Consent.OPTED_IN, "1.0.0")

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

Add Vungle to GDPR ad partners list

Follow the steps in GDPR settings to add Vungle to the GDPR ad partners list in the AdMob UI.

CCPA

The California Consumer Privacy Act (CCPA) requires giving California state residents 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 CCPA preparation 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 with CCPA.

In SDK version 6.7.0, Vungle 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.

Java

import com.vungle.warren.Vungle;
// ...

Vungle.updateCCPAStatus(Vungle.Consent.OPTED_IN);

Kotlin

import com.vungle.warren.Vungle
// ...

Vungle.updateCCPAStatus(Vungle.Consent.OPTED_IN)

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

Add Vungle to CCPA ad partners list

Follow the steps in CCPA settings to add Vungle to the CCPA ad partners list in the AdMob UI.

Network-specific parameters

The Vungle adapter supports an additional request parameter which can be passed to the adapter using the VungleExtrasBuilder class. This class includes the following methods:

setSoundEnabled(bool)
Sets whether or not to enable sound when playing video ads.
setUserId(String)
A string representing Vungle's Incentivized User ID.

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

Java 

Bundle extras = new VungleExtrasBuilder(placements)
     .setSoundEnabled(false)
     .setUserId("test_user")
     .build();
AdRequest request = new AdRequest.Builder()
     .addNetworkExtrasBundle(VungleAdapter.class, extras)             // Rewarded.
     .addNetworkExtrasBundle(VungleInterstitialAdapter.class, extras) // Interstitial.
     .build();

Kotlin 

val extras = VungleExtrasBuilder(placements)
     .setSoundEnabled(false)
     .setUserId("test_user")
     .build()
val request = AdRequest.Builder()
     .addNetworkExtrasBundle(VungleAdapter::class.java, extras)       // Rewarded.
     .addNetworkExtrasBundle(VungleInterstitialAdapter.class, extras) // Interstitial.
     .build()

Native ads rendering

The Vungle adapter returns its native ads as NativeAd objects. It populates the following native ads field descriptions for a NativeAd.

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

1 The Vungle 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 Vungle, publishers can check the underlying error from the ad response using ResponseInfo.getAdapterResponse() under the following classes:

Format  Class name 
Banner com.vungle.mediation.VungleInterstitialAdapter
Interstitial com.vungle.mediation.VungleInterstitialAdapter
Rewarded com.vungle.mediation.VungleAdapter

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

Error code Domain Reason
0-100 com.vungle.warren Vungle SDK returned an error. See document for more details.
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 Vungle ad size.
103 com.google.ads.mediation.vungle Vungle 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.

Vungle Android Mediation Adapter Changelog

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 and targetSdkVersion 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, with mediationExtras 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 and FlexView (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.