Mediation - AdMob
This guide shows how to add mediation through AdMob to your IronSource integration.
Step 1: Create an AdMob Account
To access AdMob’s ad inventory through ironSource‘s Mediation platform, you must create an account with AdMob. You can do so here.
We recommend to adjust the time zone of your AdMob’s account to UTC to align with the ironSource dashboard. This will ensure accurate reporting. More info here.
Step 2: Create an Application and Ad Zone in Admob
Next, you must add your app and set up Ad Zones in your Admob account.
https://developers.ironsrc.com/ironsource-mobile/android/admob-mediation-guide/#step-2
Step 3: Activate AdMob in Your ironSource Network Setup Module
Serving Admob’s ads through the ironSource Mediation platform has never been this easy. Sign in to your Google account when setting up Admob on the ironSource SDK Networks Setup and we’ll retrieve all the necessary parameters to run Admob’s Interstitials, Rewarded Video and Banners for you!
See the following guide for more information:
https://developers.ironsrc.com/ironsource-mobile/android/admob-mediation-guide/#step-3
Step 4: Add the AdMob Adapter to Your Build
The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (apm
). We highly recommend using apm
, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).
However you can choose to install it manually, as you would have done in the past.
Add the Extension
- APM
- Manual
Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.
If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.
Setup APM
Install APM
If you haven't installed apm
follow the install guide on airsdk.dev.
Setup an APM project
You will need an APM project for your application.
There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:
apm init
Check your github token
We use github to secure our extensions so you must have created a github personal access token and configured apm
to use it.
To do this create a token using this guide from github and then set it in your apm config using:
apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX
If you don't do this correctly you may find the install will fail.
Install the extension
Install the extension by running:
apm install com.distriqt.ironsource.AdMob
This will download and install the extension, required assets, and all dependencies.
Once complete apm
will have created something like the following file structure:
.
|____ ane
| |____ com.distriqt.IronSource.ane # IronSource extension
| |____ com.distriqt.ironsource.AdMob.ane # AdMob mediation extension
| |____ [dependencies]
|____ apm_packages # cache directory - ignore
|____ project.apm # apm project file
- Add the
ane
directory to your IDE. See the tutorials located here on adding an extension to your IDE.
We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using apm
that these updates will be pulled into your build automatically.
- You will need to set the AdMob application identifier values for your application. Call the following to step through the configuration values for this extension:
apm project config set com.distriqt.ironsource.AdMob
The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using apm
. Using apm
will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.
The com.distriqt.ironsource.AdMob
ANE includes the IronSource AdMob mediation adapter. This is everything you need to get AdMob mediation working in your application.
To add the ANE download it from the repository and add it to your application:
More information on adding ANEs in this tutorial
Dependencies
Android Support
The Android Support libraries encompass the Android Support, Android X and common Google libraries.
These libraries are specific to Android. There are no issues including these on all platforms, they are just required for Android.
This extension requires the following extensions:
androidx.appcompat
androidx.browser
androidx.core
androidx.constraintlayout
androidx.vectordrawable
androidx.room
androidx.work
com.google.guava
com.google.code.gson
You can access these extensions here: https://github.com/distriqt/ANE-AndroidSupport.
Note: if you have been using the older
com.distriqt.androidsupport.*
(Android Support) extensions you should remove these extensions and replace it with theandroidx
extensions listed above. This is the new version of the android support libraries and moving forward all our extensions will require AndroidX.
Google Play Services
This extension requires usage of certain aspects of the Google Play Services client library. The client library is available as a series of extensions that you add into your applications packaging options. Each separate extension provides a component(s) from the Play Services client library and are used by different extensions. These client libraries aren't packaged with this extension as they are used by multiple ANEs and separating them will avoid conflicts, allowing you to use multiple extensions in the one application.
This extension requires the following Google Play Services:
You must include the above native extensions in your application along with this extension, and you need to ensure they are packaged with your application.
You can access the Google Play Services client library extensions here: https://github.com/distriqt/ANE-GooglePlayServices.
Note: The Google Play Services and Android Support ANEs are only required on Android devices. There are no issues packaging these extensions with all platforms as there are default implementations available which will allow your code to package without errors however if you are only building an iOS application feel free to remove the Google Play Services and Android Support ANEs from your application.
Application Descriptor
- APM
- Manual
Updating your application descriptor will insert the required extensionID
's and generate the manifest and info additions for your application.
You update your application descriptor by running:
apm generate app-descriptor src/MyApp-app.xml
Change the path (src/MyApp-app.xml
) to point to your application descriptor.
This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from apm
.
You should backup your application descriptor before running this command to ensure you don't lose any information.
If you need to insert custom data into these sections see the guides for Android and iOS
Extension IDs
Add the extension id to your application descriptor:
<extensions>
<extensionID>com.distriqt.Core</extensionID>
<extensionID>com.distriqt.IronSource</extensionID>
<extensionID>com.distriqt.ironsource.AdMob</extensionID>
<extensionID>com.distriqt.playservices.Base</extensionID>
<extensionID>com.distriqt.playservices.Ads</extensionID>
<extensionID>com.distriqt.playservices.AppSet</extensionID>
<extensionID>com.distriqt.playservices.AdsIdentifier</extensionID>
<extensionID>androidx.core</extensionID>
<extensionID>androidx.constraintlayout</extensionID>
<extensionID>androidx.browser</extensionID>
<extensionID>androidx.vectordrawable</extensionID>
<extensionID>androidx.work</extensionID>
<extensionID>androidx.room</extensionID>
<extensionID>com.google.guava</extensionID>
<extensionID>com.google.code.gson</extensionID>
<extensionID>com.jetbrains.kotlin</extensionID>
</extensions>
Android
Manifest Additions
Add the following to your manifest additions in your application descriptor.
Ensure you replace:
APPLICATION_PACKAGE
with your AIR application's Java package name, something likeair.com.distriqt.test
. Generally this is your AIR application id prefixed byair.
unless you have specified no air flair in your build options.- Make sure you add the
com.google.android.gms.ads.APPLICATION_ID
meta-data
tag with a string value of your AdMob app ID into the application node. You can find your App ID in the AdMob UI. i.e. replaceca-app-pub-AAAAAAAAAAAAAAAA~XXXXXXXXXX
in the additions below.
Also we suggest you enable hardware acceleration so videos are displayed correctly (i.e. the android:hardwareAccelerated="true"
attribute on your android application
tag).
<manifest android:installLocation="auto">
<uses-sdk android:minSdkVersion="21" android:targetSdkVersion="34" />
<permission android:name="APPLICATION_PACKAGE.DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION"
android:protectionLevel="signature" />
<uses-permission android:name="APPLICATION_PACKAGE.DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION" />
<!-- Include required permissions for Google Mobile Ads to run -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="com.google.android.gms.permission.AD_ID" />
<uses-permission android:name="android.permission.ACCESS_ADSERVICES_AD_ID" />
<uses-permission android:name="android.permission.ACCESS_ADSERVICES_ATTRIBUTION" />
<uses-permission android:name="android.permission.ACCESS_ADSERVICES_TOPICS" />
<!-- Android package visibility setting -->
<queries>
<!-- For browser content -->
<intent>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="https" />
</intent>
<!-- End of browser content -->
<!-- For CustomTabsService -->
<intent>
<action android:name="android.support.customtabs.action.CustomTabsService" />
</intent>
<!-- End of CustomTabsService -->
</queries>
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission
android:name="com.google.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE" />
<!-- Required by older versions of Google Play services to create IID tokens -->
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<application android:appComponentFactory="androidx.core.app.CoreComponentFactory"
android:hardwareAccelerated="true">
<meta-data android:name="com.google.android.gms.ads.APPLICATION_ID"
android:value="APPLICATION_ID" />
<service android:name="androidx.room.MultiInstanceInvalidationService"
android:directBootAware="true" android:exported="false" />
<provider android:name="androidx.startup.InitializationProvider"
android:authorities="APPLICATION_PACKAGE.androidx-startup" android:exported="false">
<meta-data android:name="androidx.lifecycle.ProcessLifecycleInitializer"
android:value="androidx.startup" />
<meta-data android:name="androidx.work.WorkManagerInitializer"
android:value="androidx.startup" />
</provider>
<!-- Include the AdActivity and InAppPurchaseActivity configChanges and themes. -->
<activity android:name="com.google.android.gms.ads.AdActivity"
android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
android:exported="false" android:theme="@android:style/Theme.Translucent" />
<provider android:name="com.google.android.gms.ads.MobileAdsInitProvider"
android:authorities="APPLICATION_PACKAGE.mobileadsinitprovider" android:exported="false"
android:initOrder="100" />
<service android:name="com.google.android.gms.ads.AdService" android:enabled="true"
android:exported="false" />
<activity android:name="com.google.android.gms.ads.OutOfContextTestingActivity"
android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
android:exported="false" />
<activity android:name="com.google.android.gms.ads.NotificationHandlerActivity"
android:excludeFromRecents="true" android:exported="false"
android:launchMode="singleTask" android:taskAffinity=""
android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<receiver android:name="com.google.android.gms.measurement.AppMeasurementReceiver"
android:enabled="true" android:exported="false" />
<service android:name="com.google.android.gms.measurement.AppMeasurementService"
android:enabled="true" android:exported="false" />
<service android:name="com.google.android.gms.measurement.AppMeasurementJobService"
android:enabled="true" android:exported="false"
android:permission="android.permission.BIND_JOB_SERVICE" />
<meta-data android:name="com.google.android.gms.version"
android:value="@integer/google_play_services_version" />
<activity android:name="com.google.android.gms.common.api.GoogleApiActivity"
android:exported="false" android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<service android:name="com.google.firebase.components.ComponentDiscoveryService"
android:exported="false">
<meta-data
android:name="com.google.firebase.components:com.google.firebase.analytics.connector.internal.AnalyticsConnectorRegistrar"
android:value="com.google.firebase.components.ComponentRegistrar" />
</service>
<service android:name="androidx.work.impl.background.systemalarm.SystemAlarmService"
android:directBootAware="false"
android:enabled="@bool/enable_system_alarm_service_default" android:exported="false" />
<service android:name="androidx.work.impl.background.systemjob.SystemJobService"
android:directBootAware="false"
android:enabled="@bool/enable_system_job_service_default" android:exported="true"
android:permission="android.permission.BIND_JOB_SERVICE" />
<service android:name="androidx.work.impl.foreground.SystemForegroundService"
android:directBootAware="false"
android:enabled="@bool/enable_system_foreground_service_default"
android:exported="false" />
<receiver android:name="androidx.work.impl.utils.ForceStopRunnable$BroadcastReceiver"
android:directBootAware="false" android:enabled="true" android:exported="false" />
<receiver
android:name="androidx.work.impl.background.systemalarm.ConstraintProxy$BatteryChargingProxy"
android:directBootAware="false" android:enabled="false" android:exported="false">
<intent-filter>
<action android:name="android.intent.action.ACTION_POWER_CONNECTED" />
<action android:name="android.intent.action.ACTION_POWER_DISCONNECTED" />
</intent-filter>
</receiver>
<receiver
android:name="androidx.work.impl.background.systemalarm.ConstraintProxy$BatteryNotLowProxy"
android:directBootAware="false" android:enabled="false" android:exported="false">
<intent-filter>
<action android:name="android.intent.action.BATTERY_OKAY" />
<action android:name="android.intent.action.BATTERY_LOW" />
</intent-filter>
</receiver>
<receiver
android:name="androidx.work.impl.background.systemalarm.ConstraintProxy$StorageNotLowProxy"
android:directBootAware="false" android:enabled="false" android:exported="false">
<intent-filter>
<action android:name="android.intent.action.DEVICE_STORAGE_LOW" />
<action android:name="android.intent.action.DEVICE_STORAGE_OK" />
</intent-filter>
</receiver>
<receiver
android:name="androidx.work.impl.background.systemalarm.ConstraintProxy$NetworkStateProxy"
android:directBootAware="false" android:enabled="false" android:exported="false">
<intent-filter>
<action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
</intent-filter>
</receiver>
<receiver android:name="androidx.work.impl.background.systemalarm.RescheduleReceiver"
android:directBootAware="false" android:enabled="false" android:exported="false">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
<action android:name="android.intent.action.TIME_SET" />
<action android:name="android.intent.action.TIMEZONE_CHANGED" />
</intent-filter>
</receiver>
<receiver
android:name="androidx.work.impl.background.systemalarm.ConstraintProxyUpdateReceiver"
android:directBootAware="false"
android:enabled="@bool/enable_system_alarm_service_default" android:exported="false">
<intent-filter>
<action android:name="androidx.work.impl.background.systemalarm.UpdateProxies" />
</intent-filter>
</receiver>
<receiver android:name="androidx.work.impl.diagnostics.DiagnosticsReceiver"
android:directBootAware="false" android:enabled="true" android:exported="true"
android:permission="android.permission.DUMP">
<intent-filter>
<action android:name="androidx.work.diagnostics.REQUEST_DIAGNOSTICS" />
</intent-filter>
</receiver>
</application>
</manifest>
iOS
Info Additions
Add the following to your InfoAdditions
node updating the usage description strings as required for your application:
You need to ensure you set the
GADApplicationIdentifier
for your AdMob application, replacingca-app-pub-XXXXXXXXXXXXXXXX~YYYYYYYYYY
in the additions below.
<key>GADApplicationIdentifier</key>
<string>ca-app-pub-XXXXXXXXXXXXXXXX~YYYYYYYYYY</string>
<!-- iOS 14 AdNetwork -->
<key>SKAdNetworkItems</key>
<array>
<dict>
<!-- IronSource -->
<key>SKAdNetworkIdentifier</key>
<string>SU67R6K2V3.skadnetwork</string>
</dict>
<dict>
<!-- AdMob -->
<key>SKAdNetworkIdentifier</key>
<string>cstr6suwn9.skadnetwork</string>
</dict>
</array>
Step 5: Additional code required
There is no additional code required.