Integrating Vungle with Mediation

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from Vungle via mediation.

It covers how to add Vungle to an ad unit's mediation configuration, how to set up Automatic data collection, and how to integrate the Vungle SDK and adapter into an Android app.

Supported formats and features

The Ad Manager mediation adapter for Vungle has the following capabilities:

Formats
Banners
Interstitials
Rewarded video
Rewarded Video (new APIs)
Native Ads - Custom Rendering
Features
Smart banners
Automatic data collection

Requirements

  • Android SDK 4.0 (API level 14) or later
  • Google Play services 17.2.0 or later

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, then click the Continue button at the bottom of the page to add your app to Vungle.

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

Take note of the App ID.

Adding new placements

To create a new placement to be used with Ad Manager 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:

Interstitial

Select Interstitial, enter a Name for your placement and fill out the rest of the form. Click the Continue button at the bottom of the page to create the placement.

Take note of the Reference ID and click Sounds Good.

Rewarded Video

Select Rewarded, enter a Name for your placement and fill out the rest of the form. Click the Continue button at the bottom of the page to create the placement.

Take note of the Reference ID and click Sounds Good.

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

Sign in to your Ad Manager account. Navigate to Delivery > Yield groups and click the New yield group button.

Enter a unique Name for your yield group, set the Status to Active, select your Ad Format, and set the Inventory type to Mobile App. Under the Targeting > Inventory section, select the Ad Unit ID to which you want to add mediation.

Next, click the Add yield partner button.

If you already have a Yield partner for Vungle, you can simply select it. Otherwise, select Create a new yield partner.

Select Vungle as the Ad network and enter a unique Name. Enable Mediation and turn on Automatic data collection, and enter the Reporting API Key obtained in the previous section for the API Key. You don't need to enter a Username and Password. Click Save when done.

Once the Yield partner is selected, choose Mobile SDK mediation as the Integration type, Android as the Platform, and Active as the Status. Enter the Application ID and the Placement Reference ID obtained in the previous section and a Default CPM value.

Click Save at the bottom of the page when done.

Using rewarded video ads

In the settings for your rewarded video 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 Override reward settings from third-party ad networks when using mediation 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 video ads.

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:

...
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.0.2'
    implementation 'com.google.android.gms:play-services-ads:18.3.0'
    implementation 'com.google.ads.mediation:vungle:6.4.11.1'
}
...

Manual integration

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

  • Download the latest Vungle adapter .aar file from Bintray 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.

The section below shows you how to enable or disable personalized ads for Vungle.

In version 6.2.5.0, the Vungle adapter added the VungleConsent class that allows you to pass consent to Vungle. The following sample code sets the consent status to OPTED_IN. If you choose to call this method, it is recommended that you do so prior to requesting ads via the Google Mobile Ads SDK.

import com.vungle.warren.Vungle;
import com.vungle.mediation.VungleConsent;
...

VungleConsent.updateConsentStatus(Vungle.Consent.OPTED_IN);

You can also check the current consent status for Vungle using the following code:

VungleConsent.getCurrentVungleConsent();

In version 6.3.12.0 of the Vungle Adapter, the updateConsentStatus() method was updated to include a consent message version:

import com.vungle.warren.Vungle;
import com.vungle.mediation.VungleConsent;
...

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

You can get this consent message version for Vungle using the following code:

VungleConsent.getCurrentVungleConsentMessageVersion();

See Vungle's GDPR recommended implementation for more information.

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 set these ad request parameters:

JAVA

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

KOTLIN

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

Vungle Android Mediation Adapter Changelog

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.