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 a Unity app.
Supported ad formats and features
Formats | |
---|---|
Banners | |
Interstitials | |
Rewarded video | |
Rewarded video (new APIs) | |
Features | |
Smart banners | |
Ad Network Optimization (ANO) |
Requirements
- Unity 4 or higher
- Latest Google Mobile Ads SDK
- To deploy on Android
- Android API level 16 or higher
- To deploy on iOS
- iOS deployment target of 8.0 or higher
- A working Unity project configured with Google Mobile Ads SDK. See Get Started for details.
Step 1: Set up InMobi
First, sign up or log in to your InMobi account.
Add an app
Click the + Add an App button to add your app to InMobi. If your app supports both Android and iOS platforms, you need to add each one of them separately.
If your app is already published, enter its URL and click the Look Up button. Otherwise click Have an app that isn't yet published?
Choose your platform to view the unpublished app information screen.
Android
iOS
Enter the name of your unpublished app and choose the platform your app supports. Select whether or not your app is COPPA compliant and click Add App when done.
Create a placement
InMobi requires you to create a placement before you finish adding your app.
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 later to set 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, its details are shown. Take note of the Placement ID, which will be used later to set 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 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 in the reward details section and click Done.
Now that the placement has been created, click Proceed to Integration, then click Done.
Next, you will get your Account ID.
Your Account ID can be located by clicking on your email address (located in the top right corner of your InMobi dashboard).
In addition to your Account ID and your Placement ID, you need a Secret Key provided by InMobi. Contact the InMobi support team to obtain your key.
For InMobi SDK versions lower than 5
If you're using a version of the InMobi SDK lower than 5.0.0, you need an App ID instead of the Account ID and Placement ID to set up AdMob ad units for InMobi mediation.
To get your App ID, Open your app's Configuration page by clicking on your app's name in the InMobi dashboard home page.
Your App ID is located under the app name at the top of the page.
Android
iOS
Step 2: Configure AdMob ad unit
First, sign in to your AdMob account. Next, follow the instructions below to create an AdMob ad unit and configure it to mediate to InMobi. If you plan to deploy your Unity app to both Android and iOS, you'll need to run through both the Android and iOS sections to create an AdMob ad unit for each platform.
AdMob UI Android
Navigate to the Mediation tab. If you have an existing mediation group you would 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.
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.
Notice that the ad units card is now 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.
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.
For InMobi SDK versions prior to 5.0 - Use App ID (leave Account ID and Placement ID blank).
AdMob UI iOS
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.
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.
Notice that the ad units card is now 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, check the authorization checkbox, and click Continue.
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.
For InMobi SDK versions prior to 5.0 - Use App ID (leave Account ID and Placement ID blank).
Using rewarded video ads
In the settings for your rewarded video ad unit, check the Apply to all networks in Mediation groups box so that you provide the same reward to the user no matter which ad network is served.
If you don't check 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, refer to Create an ad unit.
Step 3: Import the InMobi SDK and adapter
Download the latest version of the Google Mobile Ads mediation plugin for
InMobi
and extract GoogleMobileAdsInMobiMediation.unitypackage
from the zip
file.
In your Unity project editor, select Assets > Import Package > Custom
Package and select the GoogleMobileAdsInMobiMediation.unitypackage
file you
downloaded. Make sure that all the files are selected and click Import.
Then, select Assets > Play Services Resolver > Android Resolver >
Force Resolve. The Unity Play Services Resolver library will perfrom
dependency resolution from scratch and copy the declared dependencies into the
Assets/Plugins/Android
directory of your Unity app.
Step 4: Add required additional code
No additional code 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.
Android
iOS
You can either choose Global ON or Selective ON as the Test Mode. If you selected Selective ON, you need to add a test device. Make sure that InMobi Test Ad is selected as the Test ad.
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.
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 how to enable or disable personalized ads for InMobi.
The Google Mobile Ads mediation plugin for InMobi
version 2.1.0 added the InMobi.UpdateGDPRConsent()
method, allowing you to
pass consent to InMobi. The following sample code shows how to pass consent
information to the InMobi SDK. If you choose to call this method, it is
recommended that you do so prior to requesting ads via 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);
Visit InMobi's GDPR implementation details for more information about the possible keys and values that InMobi accepts in this consent object. Also refer to InMobi's GDPR Guide for Publishers for more information.
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 3.1.1
- Supports InMobi Android adapter version 9.1.1.0.
- Supports InMobi iOS adapter version 9.1.1.0.
Version 3.1.0
- Supports InMobi Android adapter version 9.1.0.0.
- Supports InMobi iOS adapter version 9.1.0.0.
Version 3.0.3
- Supports InMobi Android adapter version 9.0.7.1.
- Supports InMobi iOS adapter version 9.0.7.2.
Version 3.0.2
- Supports InMobi Android adapter version 9.0.7.0.
- Supports InMobi iOS adapter version 9.0.7.0.
Version 3.0.1
- Supports InMobi Android adapter version 9.0.6.0.
- Supports InMobi iOS adapter version 9.0.7.0.
Version 3.0.0
- Supports InMobi Android adapter version 9.0.4.0.
- Supports InMobi iOS adapter version 9.0.4.0.
Version 2.4.0
- Supports InMobi Android adapter version 7.3.0.1.
- Supports InMobi iOS adapter version 7.4.0.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.