Integrate InMobi 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 InMobi using mediation, covering waterfall integrations. It covers how to add InMobi to an ad unit's mediation configuration, and how to integrate the InMobi SDK and adapter into an Android app.

Supported integrations and ad formats

The Google Ad Manager mediation adapter for InMobi has the following capabilities:

Integration
Bidding
Waterfall
Formats
Banner
Interstitial
Rewarded
Native

Requirements

  • Android API level 19 or higher
  • Latest Google Mobile Ads SDK

Step 1: Set up InMobi

Sign up or log in to your InMobi account.

Add an app

To add your app to the InMobi dashboard, click Inventory > Inventory Settings.

Click Add Inventory and select the Mobile App channel from the dropdown menu.

Start typing your published app store URL in the search bar and select the app from the auto-populated results. Click Continue.

If your app in not published, click Link manually and enter the required details. Click Continue.

Review the App & Website Compliance settings and then click Save and Create Placements.

Placements

After you set up your inventory, the system redirects you to the placement creation workflow.

Select Banner as the type and click Add a placement. Then enter a Placement Name. Click the Create Placement button when done.

Interstitial

Select Interstitial as the type and click Add a placement. Then enter a Placement Name. Click the Create Placement button when done.

Rewarded

Select Rewarded as the type and click Add a placement. Then enter a Placement Name. Click the Create Placement button when done.

Native

Select Native as the type and click Add a placement. Then 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 Ad Manager ad unit.

Account ID

Your InMobi account ID is available under Finance > Payment Settings > Payment Information.

API Key

Go to My Account > Account Settings. Navigate to the API Key tab and click Generate API Key.

Select the email of the user the key is required for and click Generate API Key. A file containing the API key and username/login name will be generated.

Only the publisher admin of the account will be able to generate an API key for all users. If you have forgotten the previously generated API key, reset your API key by hovering over your mail on the API Key tab.

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 InMobi, you can simply select it. Otherwise, select Create a new yield partner.

Select InMobi as the Ad network and enter a unique Name. Enable Mediation and turn on Automatic data collection, and enter your API Key obtained in the previous step into the API Key field. Next, enter your Username and 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 Account ID and the Placement ID obtained in the previous section and a Default CPM value.

Click Save at the bottom of the page when done.

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 Override reward settings from third-party ad networks when using mediation box.

If you don't apply this setting, the InMobi adapter passes back the reward specified in the InMobi dashboard when creating the placement.

Step 3: Import the InMobi SDK and adapter

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

repositories {
    google()
    mavenCentral()
}

...
dependencies {
    implementation 'com.google.android.gms:play-services-ads:21.3.0'
    implementation 'com.google.ads.mediation:inmobi:10.1.2.0'
}
...

Manual integration

  1. Download the InMobi Android SDK and extract the InMobiSDK.aar file under the libs folder and add it to your project.

  2. Navigate to the InMobi adapter artifacts on Google's Maven Repository. Select the latest version, download the InMobi adapter's .aar file, and add it to your project.

  3. InMobi also requires other dependencies to be included. Please refer to InMobi's documentation for additional details.

Step 4: Additional code required

No additional code is required for InMobi integration.

Step 5: Test your implementation

Enable Test Mode for your placement on all live impressions or certain test devices only.

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 version 7.1.0.0, the InMobi adapter added the InMobiConsent class that lets you pass consent information to InMobi. The following sample code calls updateGDPRConsent() on the InMobiConsent class. 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.inmobi.sdk.InMobiSdk;
import com.google.ads.mediation.inmobi.InMobiConsent;
// ...

JSONObject consentObject = new JSONObject();
try {
  consentObject.put(InMobiSdk.IM_GDPR_CONSENT_AVAILABLE, true);
  consentObject.put("gdpr", "1");
} catch (JSONException exception) {
  exception.printStackTrace();
}

InMobiConsent.updateGDPRConsent(consentObject);

Kotlin

import com.inmobi.sdk.InMobiSdk
import com.google.ads.mediation.inmobi.InMobiConsent
// ...

val consentObject = JSONObject()
try {
  consentObject.put(InMobiSdk.IM_GDPR_CONSENT_AVAILABLE, true)
  consentObject.put("gdpr", "1")
} catch (exception: JSONException) {
  exception.printStackTrace()
}

InMobiConsent.updateGDPRConsent(consentObject)

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

Add InMobi to GDPR ad partners list

Follow the steps in GDPR settings to add InMobi to the GDPR ad partners list in the Ad Manager 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.

See InMobi's CCPA documentation for guidelines on how to enable CCPA settings for InMobi.

Permissions

For optimal performance, InMobi recommends adding the following optional permissions to your app's AndroidManifest.xml file.

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />

Network-specific parameters

The InMobi adapter supports additional request parameters that can be passed to the adapter as an Android Bundle. The adapter looks for the following keys in the bundle:

Request parameters and values
InMobiNetworkKeys.AGE_GROUP
The user's age group.
InMobiNetworkValues.BELOW_18
InMobiNetworkValues.BETWEEN_18_AND_24
InMobiNetworkValues.BETWEEN_25_AND_29
InMobiNetworkValues.BETWEEN_30_AND_34
InMobiNetworkValues.BETWEEN_35_AND_44
InMobiNetworkValues.BETWEEN_45_AND_54
InMobiNetworkValues.BETWEEN_55_AND_65
InMobiNetworkValues.ABOVE_65
InMobiNetworkKeys.EDUCATION
The user's education level.
InMobiNetworkValues.EDUCATION_HIGHSCHOOLORLESS
InMobiNetworkValues.EDUCATION_COLLEGEORGRADUATE
InMobiNetworkValues.EDUCATION_POSTGRADUATEORABOVE
InMobiNetworkKeys.AGE String. The age of the user
InMobiNetworkKeys.POSTAL_CODE String. The user's postal code (usually a five-digit number)
InMobiNetworkKeys.AREA_CODE String. The user's area code (part of the telephone number)
InMobiNetworkKeys.LANGUAGE String. The user's native language (if known).
InMobiNetworkKeys.CITY String. The user's city
InMobiNetworkKeys.STATE String. The user's state
InMobiNetworkKeys.COUNTRY String. The user's country
InMobiNetworkKeys.LOGLEVEL
Sets the Log level for InMobi SDK.
InMobiNetworkValues.LOGLEVEL_NONE
InMobiNetworkValues.LOGLEVEL_DEBUG
InMobiNetworkValues.LOGLEVEL_ERROR

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

Java

Bundle extras = new Bundle();
extras.putString(InMobiNetworkKeys.AGE_GROUP, InMobiNetworkValues.BETWEEN_35_AND_54);
extras.putString(InMobiNetworkKeys.AREA_CODE, "12345");
...
AdManagerAdRequest request = new AdManagerAdRequest.Builder()
        .addNetworkExtrasBundle(InMobiAdapter.class, extras)
        .build();

Kotlin

val extras = Bundle()
extras.putString(InMobiNetworkKeys.AGE_GROUP, InMobiNetworkValues.BETWEEN_35_AND_54)
extras.putString(InMobiNetworkKeys.AREA_CODE, "12345")
...
val request = AdManagerAdRequest.Builder()
        .addNetworkExtrasBundle(InMobiAdapter.class, extras)
        .build()

Using native ads

Ad rendering

The InMobi adapter returns its native ads as NativeAd objects. It populates the following fields for a NativeAd.

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

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

Impression and click tracking

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

Error codes

If the adapter fails to receive an ad from InMobi, publishers can check the underlying error from the ad response using ResponseInfo.getAdapterResponse() under the following classes:

com.google.ads.mediation.inmobi.InMobiAdapter
com.google.ads.mediation.inmobi.InMobiMediationAdapter

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

Error code Reason
0-99 InMobi SDK Errors. See code for more details.
100 InMobi server parameters configured in the Ad Manager UI are missing/invalid.
101 Failed to initialize the InMobi SDK.
102 The requested ad size does not match an InMobi supported banner size.
103 Ad request is not a unified native ad request.
104 Attempted to request an InMobi ad without initializing the InMobi SDK. This should in theory never happen since the adapter initializes the InMobi SDK prior to requesting InMobi ads.
105 InMobi's ad is not yet ready to be shown.
106 InMobi failed to display an ad.
107 InMobi returned a native ad that is missing a required asset.
108 InMobi's native ad image assets contain a malformed URL.
109 The adapter failed to download InMobi's native ad image assets.

InMobi Android Mediation Adapter Changelog

Version 10.1.2.0

  • Verified compatibility with InMobi SDK version 10.1.2.

Built and tested with:

  • Google Mobile Ads SDK version 21.3.0.
  • InMobi SDK version 10.1.2.

Version 10.1.1.0

  • Verified compatibility with InMobi SDK version 10.1.1.

Built and tested with:

  • Google Mobile Ads SDK version 21.3.0.
  • InMobi SDK version 10.1.1.

Version 10.0.9.0

  • Verified compatibility with InMobi SDK version 10.0.9.
  • Updated the minimum required Google Mobile Ads SDK version to 21.3.0.

Built and tested with:

  • Google Mobile Ads SDK version 21.3.0.
  • InMobi SDK version 10.0.9.

Version 10.0.8.0

  • Verified compatibility with InMobi SDK version 10.0.8.
  • Updated the minimum required Google Mobile Ads SDK version to 21.2.0.

Built and tested with:

  • Google Mobile Ads SDK version 21.2.0.
  • InMobi SDK version 10.0.8.

Version 10.0.7.0

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

Version 10.0.6.0

  • Verified compatibility with InMobi SDK version 10.0.6.

Built and tested with:

  • Google Mobile Ads SDK version 20.6.0.
  • InMobi SDK version 10.0.6.

Version 10.0.5.0

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

Version 10.0.3.0

  • Verified compatibility with InMobi SDK version 10.0.3.

Built and tested with:

  • Google Mobile Ads SDK version 20.5.0.
  • InMobi SDK version 10.0.3.

Version 10.0.2.0

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

Version 10.0.1.0

  • Verified compatibility with InMobi SDK version 10.0.1.
  • Updated the minimum required Google Mobile Ads SDK version to 20.4.0.

Built and tested with:

  • Google Mobile Ads SDK version 20.4.0.
  • InMobi SDK version 10.0.1.

Version 9.2.1.0

  • Verified compatibility with InMobi SDK version 9.2.1.
  • Updated the minimum required Google Mobile Ads SDK version to 20.3.0.

Built and tested with:

  • Google Mobile Ads SDK version 20.3.0.
  • InMobi SDK version 9.2.1.

Version 9.2.0.0

  • Verified compatibility with InMobi SDK version 9.2.0.
  • Updated the minimum required Google Mobile Ads SDK version to 20.2.0.
  • Fixed incorrect error messages.

Built and tested with:

  • Google Mobile Ads SDK version 20.2.0.
  • InMobi SDK version 9.2.0.

Version 9.1.9.0

  • Verified compatibility with InMobi SDK version 9.1.9.
  • Updated the minimum required Google Mobile Ads SDK version to 20.1.0.

Built and tested with:

  • Google Mobile Ads SDK version 20.1.0.
  • InMobi SDK version 9.1.9.

Version 9.1.7.0

  • Verified compatibility with InMobi SDK version 9.1.7.
  • Updated the minimum required Google Mobile Ads SDK version to 19.8.0.

Built and tested with:

  • Google Mobile Ads SDK version 19.8.0.
  • InMobi SDK version 9.1.7.

Version 9.1.6.0

  • Verified compatibility with InMobi SDK version 9.1.6.
  • Updated the minimum required Google Mobile Ads SDK version to 19.7.0.
  • Adapter now overrides impression tracking and uses InMobi's impression definition.
  • Adapter no longer reads gender and birthday targeting parameters, which are deprecated in the Google Mobile Ads SDK version 19.7.0.
  • Migrated to AndroidX

Built and tested with:

  • Google Mobile Ads SDK version 19.7.0.
  • InMobi SDK version 9.1.6.

Version 9.1.1.0

  • Verified compatibility with InMobi SDK version 9.1.1.
  • Updated the minimum required Google Mobile Ads SDK version to 19.5.0.
  • Added descriptive error codes and reasons for adapter load/show failures.

Built and tested with:

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

Version 9.1.0.0

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

Version 9.0.9.0

  • Verified compatibility with InMobi SDK version 9.0.9.

Built and tested with:

  • Google Mobile Ads SDK version 19.3.0.
  • InMobi SDK version 9.0.9.

Version 9.0.8.0

  • Removed support for the deprecated NativeAppInstallAd format. Apps should request unified native ads.
  • Updated the minimum required Google Mobile Ads SDK version to 19.3.0.
  • Verified compatibility with InMobi SDK version 9.0.8.

Built and tested with:

  • Google Mobile Ads SDK version 19.3.0.
  • InMobi SDK version 9.0.8.

Version 9.0.7.1

  • Fixed an issue where the adapter did not keep InMobi SDK's initialization state properly.
  • 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.
  • InMobi SDK version 9.0.7.

Version 9.0.7.0

  • Verified compatibility with InMobi SDK version 9.0.7.
  • Updated the adapter to support inline adaptive banner requests.
  • Adapter now includes proguard configuration as suggested by InMobi's guidelines.

Built and tested with:

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

Version 9.0.6.0

  • Verified compatibility with InMobi SDK version 9.0.6.
  • Native ads: Fixed a bug that causes the primaryView of InMobi to disappear while scrolling in native feed integration.
  • Native ads: Fixed a bug that causes the primaryView of InMobi not being positioned center inside the mediaView.

Built and tested with:

  • Google Mobile Ads SDK version 19.1.0.
  • InMobi SDK version 9.0.6.

Version 9.0.5.0

  • Verified compatibility with InMobi SDK version 9.0.5.

Built and tested with:

  • Google Mobile Ads SDK version 19.1.0.
  • InMobi SDK version 9.0.5.

Version 9.0.4.0

  • Updated the minimum required Google Mobile Ads SDK version to 19.1.0.

Built and tested with:

  • Google Mobile Ads SDK version 19.1.0.
  • InMobi SDK version 9.0.4.

Version 9.0.2.0

  • Verified compatibility with InMobi SDK version 9.0.2.
  • Updated the minimum required Google Mobile Ads SDK version to 18.3.0.
  • Removed bidding capability for banner, interstitial, and rewarded formats.
  • Fixed a bug that causes a crash when trying to render a native ad.

Built and tested with

  • Google Mobile Ads SDK version 18.3.0.
  • InMobi SDK version 9.0.2.

Version 7.3.0.1

  • Native ads now leverage the unified native ads mediation API.

Built and tested with

  • Google Mobile Ads SDK version 18.2.0.
  • InMobi SDK version 7.3.0.

Version 7.3.0.0

  • Verified compatibility with InMobi SDK version 7.3.0.
  • Updated the minimum required Google Mobile Ads SDK version to 18.2.0.

Version 7.2.9.0

  • Added bidding capability to the adapter for banner, interstitial and rewarded ads.
  • Verified compatibility with InMobi SDK version 7.2.9.
  • Updated the minimum required Google Mobile Ads SDK version to 18.1.1.

Version 7.2.7.0

  • Verified compatibility with InMobi SDK version 7.2.7.

Version 7.2.2.2

  • Added support for flexible banner ad sizes.

Version 7.2.2.1

  • Updated adapter to support new open-beta Rewarded API.
  • Updated the minimum required Google Mobile Ads SDK version to 17.2.0.

Version 7.2.2.0

  • Verified compatibility with InMobi SDK version 7.2.2.

Version 7.2.1.0

  • Verified compatibility with InMobi SDK version 7.2.1.

Version 7.2.0.0

  • Verified compatibility with InMobi SDK version 7.2.0.

Version 7.1.1.1

  • Updated the adapter to invoke the onRewardedVideoComplete ad event.

Version 7.1.1.0

  • Verified compatibility with InMobi SDK version 7.1.1.

Version 7.1.0.0

  • Added InMobiConsent class which provides updateGDPRConsent() and getConsentObj() methods.
  • Verified compatibility with InMobi SDK version 7.1.0.

Version 7.0.4.0

  • Verified compatibility with InMobi SDK version 7.0.4.

Version 7.0.2.0

  • Verified compatibility with InMobi SDK version 7.0.2.

Version 7.0.1.0

  • Updated the adapter to make it compatible with InMobi SDK version 7.0.1.
  • Added support for native video ads.
  • For native ads, a media view is always returned by the adapter. The adapter no longer returns an image asset, instead the media view will display an image for static native ads.
  • Updated the adapter project for Android Studio 3.0.

Version 6.2.4.0

  • Verified compatibility with InMobi SDK version 6.2.4.

Version 6.2.3.0

  • Changed the version naming system to [InMobi SDK version].[adapter patch version].

Earlier versions

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