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 Ad Network Optimization (ANO), and how to integrate the Vungle SDK and adapter into an iOS app.
Supported formats and features
The AdMob mediation adapter for Vungle has the following capabilities:
Formats | |
---|---|
Banner | |
Interstitial | |
Rewarded | |
Native | |
Features | |
Adaptive banner | |
Ad network optimization (ANO) |
Requirements
- iOS deployment target of 10.0 or higher
- 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, 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 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:
Banner
Select Banner, enter your desired Placement Name 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.
300x250 Banner
Select MREC, enter your desired Placement Name 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.
Interstitial
Select Interstitial, enter your desired Placement Name 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
Select Rewarded, enter your desired Placement Name 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 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 ANO 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 version 4.x or older of the Vungle SDK, the Placement Reference ID can be any value.

Using 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.
Step 3: Import the Vungle SDK and adapter
Using CocoaPods (recommended)
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 Vungle adapter from the download link in the Changelog and link
VungleAdapter.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: Add required code
Vungle requires a list of all the placements that will be used within your app
to be passed to their SDK for initialization. You can provide the list of
placements to the adapter using the VungleAdNetworkExtras
class's
allPlacements
property. The following code example shows how to use this class.
GADRequest *request = [GADRequest request];
VungleAdNetworkExtras *extras = [[VungleAdNetworkExtras alloc] init];
NSMutableArray *placements = [[NSMutableArray
alloc]initWithObjects:@"PLACEMENT_ID_1", @"PLACEMENT_ID_2", nil];
extras.allPlacements = placements;
[request registerAdNetworkExtras:extras];
[_interstitial loadRequest:request];
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
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.
The section below shows you how to enable or disable personalized ads for Vungle.
In version 6.2.0.2, the Vungle adapter added the VungleRouterConsent
class
that allows you to pass consent to Vungle. The following sample code sets the
consent status to VungleConsentAccepted
. 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 <VungleSDK/VungleSDK.h>
#import <VungleAdapter/VungleAdapter.h>
...
[VungleRouterConsent updateConsentStatus:VungleConsentAccepted];
You can also check the current consent status for Vungle using the following code:
[VungleRouterConsent getConsentStatus];
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 VungleAdNetworkExtras
class. This class includes the
following properties:
muted
- Sets whether or not to enable sound when playing video ads.
userId
- A string representing Vungle’s Incentivized User ID.
ordinal
- An Integer indicating the order in which this ad was shown in the game session.
flexViewAutoDismissSeconds
- An Integer to make Flex view ads dismiss automatically after the sepecified number of seconds.
playingPlacement
- A String representing Vungle's placement ID.
allPlacements
- An Array consisting of all the Placement ID's in the app (not required for apps implementing Vungle SDK 6.2.0 or higher).
Here's a code example of how to create an ad request that sets these parameters:
Swift
#import "VungleAdapter.h"
//...
let request = GADRequest()
let extras = VungleAdNetworkExtras()
extras.muted = true
extras.userId = "test-user"
//...
request.register(extras)
Objective-C
#import <VungleAdapter/VungleAdapter.h>
//...
GADRequest *request = [GADRequest request];
VungleAdNetworkExtras *extras = [[VungleAdNetworkExtras alloc] init];
extras.muted = YES;
extras.userId = @"test_user";
//...
[request registerAdNetworkExtras:extras];
Error codes
If the adapter fails to receive an ad from Vungle, 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 Vungle 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 | Vungle server parameters configured in the AdMob 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 Vungle 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. |
Vungle iOS Mediation Adapter Changelog
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
andadapterWillPresentFullScreenModal
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 inVungleAdNetworkExtras
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 intoplayAd
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 toupdateConsentStatus:consentMessageVersion:
inVungleRouterConsent
class.
Version 6.2.0.3
- Added
adapterDidCompletePlayingRewardBasedVideoAd:
callback to the adapter.
Version 6.2.0.2
- Added
VungleRouterConsent
class which containsupdateConsentStatus
andgetConsentStatus
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.