Use this guide to add Vungle Android SDK into your app, using MoPub as your main advertising mediation layer. MoPub Android adapter 6.4.11 is compatible with Vungle Android SDK 6.4.11.

• Download Vungle Android SDK 6.4.11
• Download MoPub Android Adapter 6.4.11

Contents

• Before You Begin
• Step 1. Set Up Vungle as a Network
  • Set Up Vungle as an SDK Network
  • Set Up Vungle as a Custom Native Network
• Step 2. Add Vungle as a Third-Party Ad Network
• Optional Advanced Settings
  • Early SDK Initialization
  • Memory Settings
  • Restrict usage of device ID
  • Interstitial Ads
  • Rewarded Ads
• Additional Note

Before You Begin

• The Vungle Android SDK 6.4.11 has been tested with MoPub Android SDK 5.7.1.
• The MoPub Dashboard does not yet include Vungle placements. You can check placement level performance using our Reporting API for Publishers.
• MoPub must be set up in your app before starting this tutorial. For a step-by-step guide, refer to MoPub’s Getting Started Guide for Android.
• You will need the Vungle’s App ID and all the placement reference IDs you want to use in your app. You can find these IDs in the Vungle Dashboard (refer to Setting Up and Reporting on Placements).
  
  • Interstitial: https://developers.mopub.com/publishers/android/interstitial/
  • Rewarded Video: https://developers.mopub.com/publishers/android/rewarded-video/
  • MREC (300 x 250): https://developers.mopub.com/publishers/android/banner/
• Vungle SDK requires Android OS 4.0 (Ice Cream Sandwich - API version 14) and up

Step 1. Set Up Vungle as an SDK Network or as a Custom Native Network

Set Up Vungle as an SDK Network

1. Log in to the MoPub dashboard and select Networks from the main navigation panel.
2. Click New Network.
   
   
   
   and select Vungle.
   
   
3. In the Network Settings section, if you Enable reporting access, enter your Reporting API Key from the Vungle Dashboard.
   
   
4. In App & Ad Unit Setup, enter the Vungle Application ID and Placement Reference IDs.
   
   

Set Up Vungle as a Custom Native Network

To ensure that the MoPub servers recognize the integrated Vungle Adapters, set up Vungle as a Custom Native Network in the MoPub dashboard.

1. Log into the MoPub dashboard, and select Networks​ from the main navigation bar.
2. Click New network button on the top right.
   
   
   
   and select Vungle​ from the list.

3. After creating Vungle as a Network, click on the name from the list of Networks. In the Set Up Your Inventory section, for each ad unit that will use the Vungle SDK to present video ads, ensure that the MoPub SDK can find the network adapter used to interact with the Vungle SDK:
   
   
   
   
   • If you are using Rewarded Video​ for an ad unit, add com.mopub.mobileads.VungleRewardedVideo under the Custom Event Class​ section.
   • If you are using Fullscreen (320 x 480)​ for an ad unit, add com.mopub.mobileads.VungleInterstitial under the Custom Event Class​ section.
   • If you are using Medium (300 x 250)​ for an ad unit, add com.mopub.mobileads.VungleBanner under the Custom Event Class​ section.
   • Add your Vungle App ID​, placement reference ID​ of the placement to be called from the ad unit, and all placement reference IDs​ that will be used in the app in JSON format under the Custom Event Class Data​.
   • Set the placement Reference ID you want to link to the MoPub Ad Unit for pid​.
     Note: A default placement is created for each app automatically. You must provide its placement reference ID in this initialization step whether or not you plan to take advantage of the placements' functionality. If you create multiple placements, provide all the reference IDs.
   • Make sure to link a placement that is set to rewarded type at Vungle dashboard to the MoPub Ad Unit that is set to Rewarded Video​; and link a placement that is set to interstitial type at Vungle dashboard to the MoPub Ad Unit that is set to Fullscreen (320 x 480).

     {
     "appId":"5935efecc802d63d5100000f",
     "pid":"DEFAULT05223"
     }

Note:​ The Vungle SDK will cache an ad automatically for the placement you selected to be Auto Cached​ in the Vungle Dashboard. We highly recommend selecting the MoPub Ad Unit shown first or the Ad Unit shown most frequently as the Auto Cached​ placement.

Step 2. Add Vungle as a Third-Party Ad Network

To add the Vungle Android SDK into your app using MoPub mediation:

1. Add all the Vungle-related adapter files to the /src/main/java/com/mopub/mobileads/ directory in your app’s project. This step is necessary because the MoPub SDK references these files as Custom Event Class properties in the directory.
   
   
   • VungleAdapterConfiguration.java
   • VungleBanner.java
   • VungleInterstitial.java
   • VungleNetworkSettings.java
   • VungleRewardedVideo.java
   • VungleRouter.java
   • VungleRouterListener.java
     
     
2. Follow the instructions in the “Step 1. Include the Vungle SDK in Your Project“ section of “Get Started with Vungle - Android SDK“ to add the necessary frameworks.
3. If you need to set Multidex , Proguard and Google Play Services, follow the instructions in the “Advanced Settings“ section of “Get Started with Vungle - Android SDK“ to update AndroidManifest.xml in your project.
4. Call the MoPubInterstitial’s show method (or, for rewarded ads, call the MoPubRewardedVideos's showRewardedVideo method) when you want to present a Vungle video ad. (No need to call the Vungle Android SDK methods directly. The MoPub SDK will do it.)

Optional Advanced Settings

Early SDK Initialization (Recommended)

MoPub Android SDK 5.5.0 and above allows you to early initialize ad network SDK when MoPub SDK completes initialization. We strongly recommend you to use this feature as it will allow additional time for Vungle SDK to pre-cache an ad and have it ready to play at display opportunity.

Sample code:

SharedPreferences mPreferences = PreferenceManager.getDefaultSharedPreferences(this);
Map<String, String> vungleSettings = new HashMap<>();

vungleSettings.put("appId", "YOUR_VUNGLE_APP_ID");

SdkConfiguration configBuilder = new SdkConfiguration.Builder("MOPUB_AD_UNIT_WITH_VUNGLE_PLACEMENT")
        .withMediatedNetworkConfiguration(VungleAdapterConfiguration.class.getName(), vungleSettings)
        .build();

MoPub.initializeSdk(this, configBuilder, initSdkListener());

Memory Settings

Starting from v6.4.0, you can prevent the SDK from downloading, requesting ads or even initializing if the storage of your Android device falls below a predefined threshold.

These are the option keys available:

Keys	Type/Value	Description
pre_key_min_space_for_init	String, value in bytes (default 51 MB)	Sets the required minimum available free storage space to be able to initialize the SDK
pre_key_min_space_for_ad	String, value in bytes (default 50 MB)	Sets the required minimum available free storage space to be able to request an ad

 

Sample code:

Map<String, String> vungleSettings = new HashMap<>();

vungleSettings.put("appId", "YOUR_VUNGLE_APP_ID");

vungleSettings.put("VNG_MIN_SPACE_INIT",
        mPreferences.getString("pref_key_min_space_for_init", String.valueOf(20 * 1024 * 1024)));
vungleSettings.put("VNG_MIN_SPACE_LOAD_AD",
        mPreferences.getString("pref_key_min_space_for_ad", String.valueOf(20 * 1024 * 1024)));

Restrict usage of device ID

For SDK version 6.4.10 onwards, publishers can now restrict from passing Android ID from the device to the SDK.

Map<String, String> vungleSettings = new HashMap<>();

vungleSettings.put("appId", "YOUR_VUNGLE_APP_ID");

vungleSettings.put("VNG_DEVICE_ID_OPT_OUT",
        String.valueOf(mPreferences.getBoolean("pref_key_key_android_id_opted_out", true)));

Interstitial Ads

Attribute	Default Value	Description
SOUND_ENABLED_KEY	true	Play ad with sound muted or unmuted. Set to 'false' to play muted. Set to 'true' to play with sound.
ORDINAL_VIEW_COUNT_KEY	null	If you receive ordinal data reports from Vungle, use this field to pass the mediation ordinal. This is an integer indicating the order in which this ad was shown in the game session (for example, if two ads were already shown in this session, and this ad from Vungle was then shown third, pass in '3'). Read more about ordinal data here.
AUTO_ROTATE_ENABLED	false	Set to true if the video ad is supposed to auto-rotate, false to follow video ad orientation

Example

HashMap<String, Object> extras = new HashMap<>();

extras.put(VungleInterstitial.SOUND_ENABLED_KEY, false);
extras.put(VungleInterstitial.ORDINAL_VIEW_COUNT_KEY, 1);
extras.put(VungleInterstitial.AUTO_ROTATE_ENABLED, true);

mMoPubInterstitial.setLocalExtras(extras);

mMoPubInterstitial.load();

Rewarded Ads

Attribute	Default Value	Description
withUserId	null	Sets the unique user ID to pass to your application to verify that this user should be rewarded for watching an incentivized ad.
withCancelDialogBody	"Closing this video early will prevent you from earning your reward. Are you sure?"	Sets the body of the confirmation dialog when skipping an incentivized ad.
withCancelDialogCloseButton	“Close Video”	Sets the 'cancel button' text of the confirmation dialog when skipping an incentivized ad.
withCancelDialogKeepWatchingButton	“Keep Watching”	Sets the 'keep watching button' text of the confirmation dialog when skipping an incentivized ad.
withCancelDialogTitle	“Close Video?”	Sets the title of the confirmation dialog when skipping an incentivized ad.
withSoundEnabled	true	Sets the starting sound state for the ad. If 'true', the audio respects device volume and sound settings. If 'false', video begins muted but user may modify.
withOrdinalViewCount	null	If you receive ordinal data reports from Vungle, use this field to pass the mediation ordinal. This is an integer indicating the order in which this ad was shown in the game session (for example, if two ads were already shown in this session, and this ad from Vungle was then shown third, pass in '3'). Read more about ordinal data here.
withAutoRotate	false	Set to true if the video ad is supposed to auto-rotate, false to follow video ad orientation

Example

VungleRewardedVideo.VungleMediationSettings vungleSettings = new VungleRewardedVideo.VungleMediationSettings.Builder()
        .withUserId("VUNGLE_USER_ID")
        .withCancelDialogBody("CUSTOM_BODY")
        .withCancelDialogCloseButton("CUSTOM_CLOSE")
        .withCancelDialogKeepWatchingButton("CUSTOM_KEEPWATCHING")
        .withCancelDialogTitle("CUSTOM_TITLE")
        .withSoundEnabled(true)
        .withOrdinalViewCount(10)
        .withAutoRotate(true)
        .build();

MoPubRewardedVideos.loadRewardedVideo(mAdUnitId, vungleSettings);

Additional Note

Android SDK - Hardware Acceleration

Hardware acceleration is enabled by default if your target API level is set to 14 or above. This option must be enabled for the SDK to properly show Dynamic Template ads. Please make sure your project does not have this option set to false.

< application android:hardwareAccelerated="true" ... >