Integrate InMobi with mediation

This guide shows you how to use the Google Mobile Ads SDK to load and display ads from InMobi using mediation, covering both waterfall and bidding integrations. It covers how to add InMobi to an ad unit's mediation configuration, and how to integrate the InMobi SDK and adapter into a Unity app.

Supported integrations and ad formats

Integration
Bidding  1
Waterfall
Formats
Banner
Interstitial
Rewarded

1 Bidding integration is in open beta.

Requirements

  • Latest Google Mobile Ads SDK
  • Unity 4 or higher
  • [For bidding]: To integrate all supported ad formats in bidding, use Google Mobile Ads mediation plugin for InMobi 4.5.0 or higher (latest version recommended)
  • To deploy on Android
    • Android API level 21 or higher
  • To deploy on iOS
    • iOS deployment target of 10.0 or higher
  • A working Unity project configured with Google Mobile Ads SDK. See Get Started for details.
  • Complete the mediation Get started guide

Step 1: Set up configurations in InMobi UI

Sign up for an InMobi account. When creating an account, leave the Use InMobi SSP with Google Open Bidding option unchecked.

Once your account is verified, log in.

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 drop-down 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.

Bidding

Select the type of ad unit. The enter a Placement Name, select On and Google Open Bidding for Audience Bidding and Partner respectively, and fill out the rest of the form. Click Create Placement when done.

Waterfall

Select the type of ad unit. Then enter a Placement Name, select Off for Audience Bidding, and fill out the rest of the form. Click Create Placement 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.

Account ID

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

Locate InMobi Reporting API Key

Bidding

This step isn't required for bidding integrations.

Waterfall

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

Turn on test mode

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

Step 2: Set up InMobi demand in AdMob UI

Configure mediation settings for your ad unit

Android

For instructions, see step 2 in the guide for Android.

iOS

For instructions, see step 2 in the guide for iOS.

Add InMobi to GDPR and US state regulations ad partners list

Follow the steps in GDPR settings and US state regulations settings to add InMobi to the GDPR and US state regulations ad partners list in the AdMob UI.

Step 3: Import the InMobi SDK and adapter

OpenUPM-CLI

If you have OpenUPM-CLI installed, you can install the Google Mobile Ads InMobi Mediation Plugin for Unity to your project by running the following command from your project's root directory:

openupm add com.google.ads.mobile.mediation.inmobi

OpenUPM

In your Unity project editor, select Edit > Project Settings > Package Manager to open the Unity Package Manager Settings.

Under the Scoped Registries tab, add OpenUPM as a scoped registry with the following details:

  • Name: OpenUPM
  • URL: https://package.openupm.com
  • Scope(s): com.google

OpenUPM Details

Then, navigate to Window > Package Manager to open the Unity Package Manager and select My Registries from the drop-down menu.

Unity Registries

Select the Google Mobile Ads InMobi Mediation package and click Install.

Install from OpenUPM

Unity Package

Download the latest version of Google Mobile Ads mediation plugin for InMobi from the download link in the Changelog and extract the GoogleMobileAdsInMobiMediation.unitypackage from the zip file.

In your Unity project editor, select Assets > Import Package > Custom Package and find the GoogleMobileAdsInMobiMediation.unitypackage file you downloaded. Make sure that all the files are selected and click Import.

Import from Unity

Then, select Assets > External Dependency Manager > Android Resolver > Force Resolve. The External Dependency Manager library will perform dependency resolution from scratch and copy the declared dependencies into the Assets/Plugins/Android directory of your Unity app.

Force Resolve

Step 4: Implement privacy settings on InMobi SDK

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 Google Mobile Ads mediation plugin for InMobi version 2.1.0 added the InMobi.UpdateGDPRConsent() method that lets you pass consent information to InMobi. The following sample code shows how to pass consent information to the InMobi SDK. If you choose to call this method, we recommend that you do so prior to requesting ads with the Google Mobile Ads SDK.

using GoogleMobileAds.Api.Mediation.InMobi;
using System.Collections.Generic;
// ...

Dictionary<string, string> consentObject = new Dictionary<string, string>();
consentObject.Add("gdpr_consent_available", "true");
consentObject.Add("gdpr", "1");

InMobi.UpdateGDPRConsent(consentObject);

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

US states privacy laws

U.S. states privacy laws require giving users 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 U.S. states privacy laws compliance 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.

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

Step 5: Add required additional code

Android

No additional code is required InMobi integration.

iOS

SKAdNetwork integration

Follow InMobi's documentation to add the SKAdNetwork identifiers to your project's Info.plist file.

Step 6: Test your implementation

Enable test ads

Make sure you register your test device for AdMob and enable test mode in InMobi UI.

Verify test ads

To verify that you are receiving test ads from InMobi, enable single ad source testing in ad inspector using the InMobi (Bidding) and InMobi (Waterfall) ad source(s).

Optional steps

Android

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" />

You may optionally add these permissions to the Plugins/Android/GoogleMobileAdsInMobiMediation/AndroidManifest.xml file.

iOS

No additional steps required for iOS integration.

Error codes

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

Android

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

iOS

GADMAdapterInMobi
GADMediationAdapterInMobi

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

Android

Error code Reason
0-99 InMobi SDK Errors. See code for more details.
100 InMobi server parameters configured in the AdMob 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.

iOS

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 Unity Mediation Plugin Changelog

Version 4.7.0

Version 4.6.7

Version 4.6.6

Version 4.6.5

Version 4.6.4

Version 4.6.3

Version 4.6.2

Version 4.6.1

Version 4.6.0

Version 4.5.1

Version 4.5.0

Version 4.4.1

Version 4.4.0

Version 4.3.3

Version 4.3.0

Version 4.2.2

Version 4.2.1

Version 4.2.0

Version 4.1.0

Version 4.0.4

Version 4.0.3

Version 4.0.2

Version 4.0.1

Version 4.0.0

Version 3.2.0

Version 3.1.2

Version 3.1.1

Version 3.1.0

Version 3.0.3

Version 3.0.2

Version 3.0.1

Version 3.0.0

Version 2.4.0

Version 2.3.0

  • Supports Android adapter version 7.2.9.0.
  • Supports iOS adapter version 7.3.2.0.

Version 2.2.2

  • Updated the plugin to support the new Rewarded API.
  • Supports Android adapter version 7.2.7.0.
  • Supports iOS adapter version 7.2.7.0.

Version 2.2.1

  • Supports Android adapter version 7.2.2.0.
  • Supports iOS adapter version 7.2.4.0.

Version 2.2.0

  • Supports Android adapter version 7.2.1.0.
  • Supports iOS adapter version 7.2.0.0.

Version 2.1.2

  • Supports Android adapter version 7.1.1.1.
  • Supports iOS adapter version 7.1.2.0.

Version 2.1.1

  • Supports Android adapter version 7.1.1.1.
  • Supports iOS adapter version 7.1.1.2.

Version 2.1.0

  • Supports Android adapter version 7.1.0.0.
  • Supports iOS adapter version 7.1.1.1.
  • Added the InMobi.UpdateGDPRConsent() method.

Version 2.0.0

  • Supports Android adapter version 7.0.4.0.
  • Supports iOS adapter version 7.1.1.0.

Version 1.0.0

  • First release!
  • Supports Android adapter version 6.2.4.0.
  • Supports iOS adapter version 6.2.1.0.