AdMob | Android

Getting Started with Android Integration

Integrating and monetizing InMobi SDK with AdMob is easy. Please refer to this guide for integration instructions.

You have access to the following ad types from InMobi via AdMob mediation:

  • Banner
  • Interstitial (Static Interstitial and Full-screen Video Ads)
  • Rewarded Interstitial
  • Native

Before you begin setting up InMobi as an ad source on AdMob dashboard, it’s important that you create an InMobi account, register your app, configure placements and complete the payment information. You can learn more about it here.

If you have completed the above steps, then you are all good to begin setting up InMobi as an ad source on AdMob. Let’s begin!

Step 1: Configuring InMobi as an Ad Source on AdMob Dashboard

Logon to your AdMob account and navigate to the specific ad-unit that you want to monetize via the InMobi SDK. Under mediation, navigate to “ad-sources” (if you have integrated solely with AdMob, the number of ad sources will be one).

  1. Select new ad network and add InMobi as ad source

  2. In the Network Settings page for InMobi, insert your InMobi account ID and placement ID.

    Your account ID is available in your InMobi account as illustrated in the screenshot below.

    Your Placement ID is present under the placement section in the InMobi dashboard, as illustrated in the screenshot below.

  3. Setting up Ad network optimization: For automatic eCPM optimization, the publisher must provide his/her InMobi reporting API credentials in the AdMob UI. If you want to find your API credentials, go to Account settings->API Key-> Generate Key. Reach out to InMobi support in case you face any issues.


Step 1.1. Setting up Rewarded Interstitials
  • You can configure the reward either on AdMob’s dashboard or on InMobi’s dashboard.

  • To configure the same on InMobi’s dashboard, choose “Use third-party ad network settings”.

  • Fill in the key-value pair for the reward details, which the InMobi SDK will honour once the user completes watching the video. AdMob will, in turn, pass this back in the reward callback. For example, you could fill in the following reward details:

Key = Coins, Value = 1000

Note: While setting up the rewards on InMobi dashboard, please make sure the reward value is in the form of Integer.


Step 1.2. Setting up Native Ads

When creating a native content placement type on the InMobi dashboard to support a native ad unit on AdMob’s dashboard, ensure you don’t change the key names on the InMobi dashboard. This is to ensure that the InMobi integration works seamlessly on native ad formats.

Remember:

  • InMobi Adapter doesn’t honor shouldRequestMultipleImages flag for Native Ads in AdMob SDK.
  • InMobi Adapter also doesn’t honor getImageOrientation/preferredImageOrientation flag in AdMob SDK.

Step 2: Adding the SDK to your Project

Option 1: Pulling the Latest SDK via JCenter

If you are using Gradle to build your Android applications, you can pull the latest version of the SDK from JCenter as described below:

  1. Include JCenter in your top-level build.gradle file
    allprojects {
        repositories {
            jcenter()
        }
    }
    			
  2. Add the following line to the dependencies element in your application module’s build.gradle.
    implementation 'com.inmobi.monetization:inmobi-ads:9.0.7'
    			
  3. Sync your Gradle project to ensure that the dependency is downloaded by the build system.
Option 2: Adding the SDK Library to your Application Project

Alternately, you can download the latest version of InMobi’s SDK here and copy the library to your application module’s libs/ directory.

To add the library to your project’s dependencies, add this line to the dependencies element in your module’s build.gradle:

implementation fileTree(dir: 'libs', include: ['*.aar'])
		

Step 2: Adding and Verifying the Dependencies

To monetize with the InMobi Ad SDK, you must add the following dependencies to your application module build.gradle:

Google Play Services

The InMobi SDK for Android needs the Google Play Services library to enable better ad targeting via the Google Play Advertising ID. Additionally, the SDK also uses the Google Play Services for getting a location fix, should the user consent to collecting their location.

To add the Google Play Services client library to your application:

  1. Add the following lines to the application module’s dependency element:
    implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
    implementation 'com.google.android.gms:play-services-location:17.0.0'
    			
  2. Sync your Gradle project to ensure that the dependencies are included.
Chrome Custom Tab

This is required to redirect the users to URLs outside InMobi WebView. To add the Chrome Custom library to your application:

  1. Add the following line to the application module's dependency element in the Gradle build script:
    implementation 'com.android.support:customtabs:28.0.0'
    			
  2. Sync your Gradle project to ensure dependencies are included.

Note: Failure to include Chrome Custom Tab dependency in your application gradle scripts will cause ad requests to fail, thus affecting monetization of your app with the InMobi SDK.

Picasso Library

The InMobi SDK for Android uses the popular Picasso library for loading the ad assets. To add the Picasso library to your application:

  1. Add the following line to the application module’s dependency element in the gradle build script.
    implementation 'com.squareup.picasso:picasso:2.71828'
    			
  2. Sync your Gradle project to ensure that the dependencies are included.

Note: Failure to include Picasso dependency in your application gradle scripts will cause interstitial ad requests to fail, thus affecting monetization of your app with the InMobi SDK.

Support Library

For supporting paged scroll of a deck of images or ads, you must use support-v4 library.

To do so, add the following line to the application module’s dependency element in the Gradle build script.

implementation 'com.android.support:support-v4:28.0.0'
		
RecyclerView

For supporting free scroll of a deck of images or ads, you must use RecyclerView.

To do so, add the following line to the application module’s dependency element in the Gradle build script.

implementation 'com.android.support:recyclerview-v7:27.1.0'
		

Note: Failure to include RecyclerView dependency in your application gradle scripts will cause interstitial ad requests to fail, thus affecting monetization of your app with the InMobi SDK.

Miscellaneous

At times, including the InMobi SDK may cause the 64K limit on methods that can be packaged in an Android dex file to be breached. This can happen if, for example, your app packs a lot of features for your users and includes substantive code to realize this.

If this happens, you can use the multidex support library to enable building your app correctly. To do this:

  1. Modify the defaultConfig mark your application as multidex enabled:
        defaultConfig {
                applicationId "com.inmobi.samples"
                minSdkVersion 15
                targetSdkVersion 29 
                versionCode 1
                versionName "1.0.0"
                multiDexEnabled true // add this to enable multi-dex
            }
    			
  2. Add the following line to the dependencies element in your application module’s build script.
                implementation 'com.android.support:multidex:1.0.3'
    			

Note: Now that you have added the dependencies, your app's build.gradle at this point will look like as shown below:

		android {
		  defaultConfig { 
		  }
		  buildTypes {
		    ...
		  }
		  sourceSets {
		    main {
		    }
		  }
		}
		repositories {
		  ...
		}
		dependencies {
			implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
			implementation 'com.google.android.gms:play-services-location:17.0.0'
			implementation 'com.android.support:customtabs:28.0.0'
			implementation 'com.squareup.picasso:picasso:2.71828'
			implementation 'com.android.support:support-v4:28.0.0'
			implementation 'com.android.support:recyclerview-v7:27.1.0'
		}
		

Step 2.1: Additional Configurations

Granting Permissions

It is highly recommended that you include ACCESS_FINE_LOCATION to enable better ad targeting. This is not a mandatory permission; however, including it will enable accurate ad targeting.

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

For further improved targeting, you can add the ACCESS_WIFI_STATE and CHANGE_WIFI_STATE permissions to the manifest.

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

Hardware acceleration allows you to display HTML5 video ads. To do this, add hardwareAccelerated:true element to the application tag.

<application
    ...
    android:hardwareAccelerated="true"
    ...
>
		
Proguard Configuration

Proguarding helps to remove unused symbols and reduce the final application footprint. The following proguard directives should be added to your application’s proguard configuration file:

-keepattributes SourceFile,LineNumberTable
-keep class com.inmobi.** { *; }
-keep public class com.google.android.gms.**
-dontwarn com.google.android.gms.**
-dontwarn com.squareup.picasso.**
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient{
     public *;
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info{
     public *;
}
# skip the Picasso library classes
-keep class com.squareup.picasso.** {*;}
-dontwarn com.squareup.okhttp.**
# skip Moat classes
-keep class com.moat.** {*;}
-dontwarn com.moat.**
# skip IAB classes
-keep class com.iab.** {*;}
-dontwarn com.iab.**
		

Important Prerequisites:

Let’s pause for some checks before we begin initializing the SDK:

Checkpoint 1: Preparing Your App for Android 10

InMobi SDK is compatible with Android 10 (API level 29), the latest version of the Android platform.

On Android P onwards, apps make connections over HTTPS by default. Though InMobi supports the adoption of HTTPS, the current setup requires our demand partners to support HTTPS as well. The publisher can change their settings to HTTP if it has an impact on the revenue potential.

Checkpoint 2: Preparing Your App for AndroidX

InMobi SDK is compatible with AndroidX (JetPack) library. In case your app uses the AndroidX library, then follow the standard guidelines by Google for migration by adding both the flags in build file.

android.useAndroidX=true
android.enableJetifier=true
		

It is highly recommended upgrading Android Gradle plugin version to 4.1 or greater to avoid known issues in the jetifier which is fixed in the latest Gradle plugin version. To upgrade Android gradle plugin version please refer to Android developer documentation.

Step 2.3: Adding the InMobi Adapter to Your Project

Download the adapter from here. Add the InMobi adapter to your Android Studio project.

Code Steps

The code steps remain the same as they are for regular AdMob integration for fetching and loading an ad. Use the AdMob account ID to initialize the AdMob SDK and AdMob “ad unit id” to request and fetch an ad.

Step 2.4 Passing user consent information to InMobi SDK

The publishers monetizing in EEA region will have to pass user consent to InMobi SDK. The publishers can use consent gathering mechanism of their choice (like Consent SDK ), and they will have to pass on this consent information to InMobi. To pass consent information, the publisher has to call: InMobiConsent.updateGDPRConsent( consentObj )

The consentObj will be a JSON object with the following keys:

Key

Type

Inference

gdpr_consent String A consent string is a series of numbers, which identifies the consent status of an Ad tech Vendor.

The string must follow the IAB contracts as mentioned here.

The key, gdpr_consent can be accessed via string constant IM_GDPR_CONSENT_IAB.

gdpr_consent_available

boolean

"true": Publisher has provided consent to collect and use user’s data.

"false": Publisher has not provided consent to collect and use user’s data.

Any value other than “true” and “false” is invalid and will be treated as value not provided by publisher, i.e. empty value.

The key, gdpr_consent_available can be accessed via string constant IM_GDPR_CONSENT_AVAILABLE.

gdpr

Number

Whether or not the request is subjected to GDPR regulations, deviation from the set values (0 = No, 1 = Yes ), indicate an unknown entity.

More Information

The latest documentation and code samples for the AdMob SDK are available here.

Step 3: Testing the Integration

To ensure AdMob SDK relays the ad request to InMobi for testing, you can do the following.

  1. Set manual Ad network optimization for every network including AdMob. Uncheck the “Ad network optimization” checkbox.
  2. Set manual eCPM floors for all networks keeping the eCPM floor for InMobi higher than other networks, this will ensure that the ad request gets relayed to InMobi for testing. In the example below, InMobi floor is set to $5 and AdMob is set to $0.01.

After performing the steps mentioned above, you can test and relay the requests to InMobi SDK for ad loads.


Step 3.1 Enabling Key SDK Logs

You can enable key SDK logs by adding the following line to your Activity where you are integrating the ad-units.

InMobiSdk.setLogLevel(LogLevel.DEBUG);
		

You can also leverage feedback available on the diagnostics tab on the ad unit and ad request if you have enabled “Test Mode” on InMobi portal.

<

Step 4: Advanced Configurations

Providing Location and Demographics Data

Recommended: If your app collects location from the user, we recommend passing it up, as impressions with location signal have higher revenue potential. InMobi SDK will automatically pass the location signals if available in the app. If you use location in your app, but would like to disable passing location signals to InMobi, then TURN OFF the “Location Automation” for your property on the InMobi dashboard.

Otherwise: You can pass the location signals in the mediation ad request object by calling the setLocation() API of MediationAdRequest class of the Admob SDK.

InMobi supports passing the following user demographic parameters:

Key Name

Value

Description

InMobiNetworkKeys.AGE_GROUP

InMobiNetworkValues.ABOVE_55,

InMobiNetworkValues.BELOW_18,

InMobiNetworkValues.BETWEEN_18_AND_20,

InMobiNetworkValues.BETWEEN_25_AND_34,

InMobiNetworkValues.BETWEEN_35_AND_54,

InMobiNetworkValues.BETWEEN_21_AND_24

The age group of the user

InMobiNetworkKeys.EDUCATION

InMobiNetworkValues.EDUCATION_HIGHSCHOOLORLESS,

InMobiNetworkValues.EDUCATION_COLLEGEORGRADUATE,

InMobiNetworkValues.EDUCATION_POSTGRADUATEORABOVE

The education level

  • High school, or less
  • College, or graduate
  • Postgraduate, or above

InMobiNetworkKeys.AGE

Any String

The age of the user

InMobiNetworkKeys.INTERESTS

Any String

Any additional relevant description of the user, or their preferences, separated by commas. Valid acceptable values are mentioned below

InMobiNetworkKeys.POSTAL_CODE

Any String

The postal code (usually a 5 digit number)

InMobiNetworkKeys.AREA_CODE

Any String

The area code (part of the telephone number)

InMobiNetworkKeys.LANGUAGE

Any String

The native language of the user (if known)

InMobiNetworkKeys.CITY

Any String

City

InMobiNetworkKeys.STATE

Any String

State

InMobiNetworkKeys.COUNTRY

Any String

Country

InMobiNetworkKeys.LOGLEVEL

InMobiNetworkValues.LOGLEVEL_NONE,

InMobiNetworkValues.LOGLEVEL_DEBUG,

InMobiNetworkValues.LOGLEVEL_ERROR

Log level for InMobi SDK