Integrating InMobi with Mediation

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

It covers how to add InMobi to an ad unit's mediation configuration, how to set up Ad Network Optimization (ANO), and how to integrate the InMobi SDK and adapter into an iOS app.

Supported formats and features

The Google AdMob mediation adapter for InMobi has the following capabilities:

Formats
Banners
Interstitials
Rewarded Video
Rewarded Video (new APIs)
Native Advanced
Features
Smart Banners
Ad Network Optimization (ANO)
Native Video

Requirements

• iOS deployment target of 8.0 or higher

• Latest Google Mobile Ads SDK

Step 1: Set up InMobi

Sign up or log in to your InMobi account.

Add an app

Click the Add an App button to add your app to InMobi.

Enter your app's URL and click the Look Up button. Otherwise click Have an app that isn't yet published?

Enter the name of your app and choose iOS as the Platform. Select whether or not your app is COPPA compliant and click Add App when done.

Placements

InMobi requires you to create a placement before you finish adding your app.

Note: To add a placement to an existing app, open your app details page by clicking on your app's name in the InMobi dashboard and navigate to the Placements tab located in the left navigation bar. Then click the Add Placement button.

Banner

Select BANNER as the type and enter a Placement Name. Click the Create Placement button when done.

Once the placement is created, its details are shown. Take note of the Placement ID, which will be used for setting up your AdMob ad unit.

Interstitial

Select INTERSTITIAL as the type and enter a Placement Name for your placement. Click the Create Placement button when done.

Once the placement is created, the placement details are are shown. Take note of the Placement ID, which will be used for setting up your AdMob ad unit.

Rewarded Video

Select REWARDED VIDEO as the type and enter a Placement Name for your placement. Click the Create Placement button when done.

Once the placement is created, its details are are shown. Take note of the Placement ID, which will be used later to set up your AdMob ad unit. Enter values for Key and Value for the reward details.

Note: The reward value specified here is forwarded by the adapter unless reward values are overridden on the AdMob UI.

Native

Select NATIVE CONTENT as the type and enter a Placement Name for your placement. Click the Create Placement button when done.

Once the placement is created, its details are are shown. Take note of the Placement ID, which will be used later to set up your AdMob ad unit. Select either PREROLL, STREAM, or SPLASH as the Native Ad Layout style and click Customize.

The FEED Native Ad Layout does not contain some of the assets that are required by Google Mobile Ads SDK and the adapter would fail the ad request if one of the required assets is missing.

Note: The Native Ad Layout styles displayed here are just suggestions. You can still customize the layout of your native ad in code.

Select the desired size for Screenshots (main image), then click Save.

---

Account ID

Now that the placement has been created, click Proceed to Integration, then click Done.

Next, you will get your Account ID, which can be found by clicking on your email address (located in the top-right corner of your InMobi dashboard).

In addition to your Account ID and Placement ID you need a secret key provided by InMobi. Contact the InMobi support team to obtain your key.

Step 2: Configure mediation settings for your AdMob ad unit

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

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

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

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

In the Ad Sources card, select Add Ad Network.

Select InMobi and enable the Optimize switch. Enter your Login name and the Secret key obtained in the previous section to set up ANO for InMobi. Then enter an eCPM value for inmobi and click Continue.

Note: You only need to set up ANO once per network.

Enter the Account ID and the Placement ID obtained in the previous section.

• For InMobi SDK 5.0 and later - Use Account ID and Placement ID.

Note: Ad network optimization takes a few days to gather data to accurately calculate eCPM for a mediation network. In the meantime, the ANO status will be PENDING, so you must manually set an eCPM value for the network. Once the eCPM can be calculated, ANO will automatically start updating the eCPM on your behalf.

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 Apply to all networks in Mediation groups box.

If you don't apply this setting, the InMobi adapter passes back the reward specified in the InMobi dashboard when creating the placement. For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the InMobi SDK and adapter

Using CocoaPods (recommended)

• Add the following line to your project's Podfile:

  pod 'GoogleMobileAdsMediationInMobi'
  

• From the command line run:

  pod install --repo-update

Manual integration

• Download the latest version of the InMobi iOS SDK and link InMobiSDK.framework in your project.

Note: Note: It is recommended to use the latest 7.x version of the InMobi SDK instead of 8.x.

• Download the latest version of the InMobi adapter, and link InMobiAdapter.framework in your project.
• Add the following Frameworks to your project
  • libsqlite3.0.tbd
  • libz.tbd
  • WebKit.framework

Project settings

Add -ObjC flag to the Other Linker Flags under Application Target > Build Settings.

Step 4: Additional code required

No additional code is required for InMobi integration.

Step 5: Test your implementation

To enable test ads for a placement, go to your app's details page by clicking on your app's name in the InMobi dashboard and navigate to the Placements tab located in the left navigation bar. Select the placement for which you want to enable test ads and click on the Diagnostics section to expand it.

You can choose either Global ON or Selective ON as the Test Mode. If you select Selective ON, you need to add a test device. Make sure that InMobi Test Ad is selected as the Test ad.

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 InMobi.

In version 7.1.1.0, the InMobi adapter added the GADMInMobiConsent class that allows you to pass consent information to InMobi. The following sample code calls updateGDPRConsent: on the GADMInMobiConsent class. If you choose to call this method, it is recommended that you do so prior to requesting ads via the Google Mobile Ads SDK.

Note: Your app must reference both the InMobi adapter 7.1.1.0 or higher and the InMobi SDK 7.1.1 or higher to use the code below.

#import <InMobiAdapter/InMobiAdapter.h>
...

NSMutableDictionary *consentObject = [[NSMutableDictionary alloc] init];
[consentObject setObject:@"1" forKey:@"gdpr"];
[consentObject setObject:@"true" forKey:IM_GDPR_CONSENT_AVAILABLE];

[GADMInMobiConsent updateGDPRConsent:consentObject];

See InMobi's GDPR implementation details for more information about the possible keys and values that InMobi accepts in this consent object.

Network-specific parameters

The InMobi adapter supports additional request parameters that can be passed to the adapter using the GADInMobiExtras class. GADInMobiExtras includes the following properties common for all supported ad formats:

Request parameters and values
setAgeGroup The user's age group.	kIMSDKAgeGroupBelow18 kIMSDKAgeGroupBetween18And24 kIMSDKAgeGroupBetween25And29 kIMSDKAgeGroupBetween30And34 kIMSDKAgeGroupBetween35And44 kIMSDKAgeGroupBetween45And54 kIMSDKAgeGroupBetween55And64 kIMSDKAgeGroupAbove65
setEducationType The education level of the user.	kIMSDKEducationHighSchoolOrLess kIMSDKEducationCollegeOrGraduate kIMSDKEducationPostGraduateOrAbove
setLogLevel	kIMSDKLogLevelNone kIMSDKLogLevelError kIMSDKLogLevelDebug
setAge	Integer. The user's age.
setYearOfbirth	Integer. The user's year of birth.
setPostalCode	String. The user's postal code. Usually a five-digit number.
setAreaCode	String. The user's telephone area code (part of the phone number).
setLanguage	String. The user's native language (if known).
setLoginId	String. A login ID in the publisher's domain.
setSessionId	String. A session ID in the publisher's domain.
setLocationWithCityStateCountry	String. Location with city, state, and country as parameters.
setKeywords	String. Any contextually relevant keywords to be passed in the ad request.
setInterests	String. Any contextually relevant strings to be passed in the ad request.
setAdditionalParameters	Dictionary. Any additional values to be passed in the ad request.

Here's a code example of how to set these ad request parameters:

Swift

let request = GADRequest()
let extras = GADInMobiExtras()
extras.ageGroup = kIMSDKAgeGroupBetween35And54
extras.areaCode = "12345"
...
request.registerAdNetworkExtras(extras)

Objective-C

GADRequest *request = [GADRequest request];
GADInMobiExtras *extras = [[GADInMobiExtras alloc] init];
extras.ageGroup = kIMSDKAgeGroupBetween35And54;
extras.areaCode = @"12345";
...
[request registerAdNetworkExtras:extras];

Using native ads

Ad rendering

The InMobi adapter returns its native ads as GADUnifiedNativeAd objects. It populates the fields described in Native ads field descriptions for a GADNUnifiedNativeAd.

Field	Assets always included by InMobi adapter
Headline
Image
Body
App icon
Call to action
Star rating
Store
Price

Impression and click tracking

Clicks are detected by the Google Mobile Ads SDK and are forwarded to InMobi, so click reporting will be in sync.

The Google Mobile Ads SDK uses the InMobi SDK's callbacks for impression tracking, so the reports on both dashboards should match up with few to no discrepancies.

Media views

InMobi does not provide an image asset for any native ads (video or static). For non-video ads, InMobi's SDK populates its media view with an image asset instead. To avoid potential null pointer errors, the InMobi adapter automatically creates a blank GADNativeAdImage and includes it in the images asset array that's part of the ad object received by the app.

Publishers mediating to InMobi are encouraged to avoid using the image assets directly, and instead use GADMediaView in their UI. Ads loaded via the InMobi adapter will always provide a media view, which will automatically display video assets for ads that contain them and an image asset for ads that don't.

Error codes

If the adapter fails to receive an ad from InMobi, publishers can check the underlying error from the ad response using GADResponseInfo.adNetworkInfoArray under the following classes:

GADMAdapterInMobi
GADMediationAdapterInMobi

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

Error code	Reason
101	InMobi server parameters configured in the AdMob UI are missing/invalid.
102	InMobi Adapter does not support the ad format being requested.
103	An InMobi ad is already loaded for this network configuration.
Other	InMobi SDK returned an error. See IMRequestStatus.h for more details.

InMobi iOS Mediation Adapter Changelog

Version 9.1.1.0

• Verified compatibility with InMobi SDK 9.1.1.
• Now requires Google Mobile Ads SDK version 7.68.0 or higher.

Built and tested with

• Google Mobile Ads SDK version 7.68.0.
• InMobi SDK version 9.1.1.

Version 9.1.0.0

• Verified compatibility with InMobi SDK 9.1.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.
• InMobi SDK version 9.1.0.

Version 9.0.7.2

• Rewarded ads no longer default to coppa=0 when child directed treatment is unspecified.

Built and tested with

• Google Mobile Ads SDK version 7.61.0.
• InMobi SDK version 9.0.7.

Version 9.0.7.1

• Now requires Google Mobile Ads SDK version 7.61.0 or higher.
• Added standardized adapter error codes and messages.

Built and tested with

• Google Mobile Ads SDK version 7.61.0.
• InMobi SDK version 9.0.7.

Version 9.0.7.0

• Verified compatibility with InMobi SDK 9.0.7.

Built and tested with

• Google Mobile Ads SDK version 7.60.0.
• InMobi SDK version 9.0.7.

Version 9.0.6.0

• Verified compatibility with InMobi SDK 9.0.6.
• Updated InMobi iOS adapter CocoaPod dependency to use InMobiSDK/Core.
• Now requires Google Mobile Ads SDK version 7.60.0 or higher.

Built and tested with

• Google Mobile Ads SDK version 7.60.0
• InMobi SDK version 9.0.6

Version 9.0.4.0

• Verified compatibility with InMobi SDK 9.0.4.
• Adapter now fails early when InMobi SDK initialization fails.
• Removed support for the i386 architecture.

Built and tested with

• Google Mobile Ads SDK version 7.57.0
• InMobi SDK version 9.0.4

Version 9.0.0.0

• Verified compatibility with InMobi SDK 9.0.0.
• Removed open bidding capability for banner, interstitial, and rewarded formats.

Built and tested with

• Google Mobile Ads SDK version 7.53.1
• InMobi SDK version 9.0.0

Version 7.4.0.0

• Verified compatibility with InMobi SDK 7.4.0.

Version 7.3.2.1

• Fixed an issue where the adapter fails to initialize due to invalid mediation configurations.

Version 7.3.2.0

• Verified compatibility with InMobi SDK 7.3.2.
• Added open bidding capability to the adapter for banner, interstitial and rewarded ad formats.

Version 7.3.0.0

• Verified compatibility with InMobi SDK 7.3.0.
• Removed support for Native Content and App Install ad requests. Apps must use the Unified Native Ads API to request native ads.
• Now requires Google Mobile Ads SDK version 7.46.0 or higher.

Version 7.2.7.0

• Verified compatibility with InMobi SDK 7.2.7.
• Updated the adapter to use the new rewarded API.
• Now requires Google Mobile Ads SDK version 7.42.2 or higher.
• Added support for flexible banner ad sizes.

Version 7.2.4.0

• Verified compatibility with InMobi SDK 7.2.4.

Version 7.2.1.0

• Verified compatibility with InMobi SDK 7.2.1.

Version 7.2.0.0

• Verified compatibility with InMobi SDK 7.2.0.

Version 7.1.2.0

• Verified compatibility with InMobi SDK 7.1.2.

Version 7.1.1.2

• Added adapterDidCompletePlayingRewardBasedVideoAd: callback to the adapter.

Version 7.1.1.1

• Added the GADInMobiConsent class which provides updateGDPRConsent and getConsent methods.

Version 7.1.1.0

• Verified compatibility with InMobi SDK 7.1.1.

Version 7.1.0.0

• Verified compatibility with InMobi SDK 7.1.0.

Version 7.0.4.1

• Fixed an issue causing duplicate symbol errors when the adapter was used with those of other networks.

Version 7.0.4.0

• Updated the adapter to make it compatibility with InMobi SDK 7.0.4.
• Added support for native video ads.
• InMobi's SDK does not provide images for ads containing video assets. To avoid potential NullPointerExceptions, when the adapter receives one of these ads it will automatically create a blank NativeAd.Image and include it in the images asset array in the ad object received by the app. Publishers using this adapter are encouraged to avoid using the image assets directly when mediating to InMobi, and instead use GADMediaView in their UI. GADMediaView will automatically display video assets for ads that contain them, and an image asset for ads that don't.

Version 6.2.1.0

• Verified compatibility with inMobi SDK 6.2.1

Earlier versions

• Support for banners, interstitials, rewarded video and native ad formats.