Android SDK Integration

Before you start We support Android Operating Systems Version 4.1 (API level 16) and up.

The download, use and access to the SDK is subject to the ironSource Mobile SDK Publisher Online Terms & Conditions. If you do not agree to the terms of ironSource Mobile SDK Publisher Online Terms & Conditions, do not download, access, or use the SDK, or the underlying services.

Step 1. Add the ironSource SDK to Your Project

Important! If you’re building your app using Target SDK Level 30, make sure to use ironSource SDK Version 6.18.0+.

As of ironSource SDK Version 6.16.0, ironSource SDK will be released as AAR.
Please make sure that you update the dependency section according to the information below.
Please note that Manifest Activities are included in the AAR. 

ironSource supports both Gradle dependencies and manual download mechanisms to integrate our SDK:

Gradle

  1. Add the following to your app’s build.gradle file inside repositories section:
    repositories {
        maven {
            url "https://dl.bintray.com/ironsource-mobile/android-sdk"
       }
    }
  2. Then add the following to the dependencies section:
    Please note that as of ironSource SDK Version 6.16.0 ironSource SDK will be released as AAR.
dependencies {
    implementation 'com.ironsource.sdk:mediationsdk:7.0.3.1' 
}

Manual Download

  1. Download Android SDK Version 7.0.3.1
  2. Import the .AAR file as a library project.
  3. If using Android Studio, download the ironSource .AAR file and add as a dependency to your own module.
  4. Go to FileNewNew ModuleImport .AAR and navigate to the location where the ironSource .AAR file has been downloaded.
  5. Note: ironSource Manifest Activities are included in the AAR.
  6. Make sure you add the following to your build.gradle file under the dependencies section:
implementation files('libs/mediationsdk-7.0.3.1')

ironSource Mediation Demo App

The Integration Demo application demonstrate how to integrate the ironSource Mediation in your app.

Download Android Demo Application

Optional: JAR Integration

If you are using mediationsdk_xxx.jar in your project, you can still use the same configuration.  

  1. Rename the new mediationsdk-xxx.aar to mediationsdk-xxx.zip. 
  2. Extract the classes.jar
  3. rename it to mediationsdk_xxx.jar. 

Step 2. Update AndroidManifest.xml

To update your AndroidManifest.xml, please complete the following steps:

  1. Manifest Permissions

    Add the following permissions to your AndroidManifest.xml file inside the manifest tag but outside the <application> tag:

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  2.  Manifest Activities

    Add the following activities inside the <application> tag in your AndroidManifest:

    <activity
                android:name="com.ironsource.sdk.controller.ControllerActivity"
                android:configChanges="orientation|screenSize"
                android:hardwareAccelerated="true" />
    <activity
                android:name="com.ironsource.sdk.controller.InterstitialActivity"
                android:configChanges="orientation|screenSize"
                android:hardwareAccelerated="true"
                android:theme="@android:style/Theme.Translucent" />
    <activity
                android:name="com.ironsource.sdk.controller.OpenUrlActivity"
                android:configChanges="orientation|screenSize"
                android:hardwareAccelerated="true"
                android:theme="@android:style/Theme.Translucent" />
  3. Google Advertising ID

    Add the Play Services dependencies into the dependencies block:

    dependencies {
        implementation fileTree(dir: 'libs', include: ['*.jar'])
        implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
        implementation 'com.google.android.gms:play-services-basement:17.1.1'
    }
    Note: ironSource SDK requires google play services basement and google play services identifier, while other networks may also require additional google play services.
Amazon devices do not utilize Google Play Services. If you are building for the Amazon platform, skip the above step.

Step 3. Override Your Activity Lifecycle Methods

Application Lifecycle
Override the onPause(), onResume() methods in each of your activities to call the corresponding ironSource methods as follows:

protected void onResume() {
        super.onResume();
        IronSource.onResume(this);
    }
protected void onPause() {
        super.onPause();
        IronSource.onPause(this);
    }

Step 4. Set the Listeners

The ironSource SDK fires several events to inform you of your ad unit activity. To receive these events, register to the listener of the ad units you set up on the ironSource platform.

Make sure you set the listeners before initializing the SDK, to avoid any loss of information.

  • For Rewarded Video
    IronSource.setRewardedVideoListener(mRewardedVideoListener);
  • For Interstitial
    IronSource.setInterstitialListener(mInterstitialListener);
  • For Offerwall
    IronSource.setOfferwallListener(mOfferwallListener);

Step 5. Initialize the SDK

Important! ironSource supports optional SDK settings such as UserID and Segments that must be configured before you initialize the SDK. See our guide on Advanced SDK Settings for setup instructions.
If you’re serving the Offerwall ad unit or using server-to-server callbacks to reward your users with our rewarded ad units, you must set the UserID.

Init the SDK

The SDK can be initialized in two ways:

  1. We recommend this approach as it will fetch the specific ad units you define in the adUnits parameter. Ad unit is a string array.
    /**
    *Ad Units should be in the type of IronSource.Ad_Unit.AdUnitName, example 
    */
    IronSource.init(this, appKey, IronSource.AD_UNIT.OFFERWALL, IronSource.AD_UNIT.INTERSTITIAL, IronSource.AD_UNIT.REWARDED_VIDEO, IronSource.AD_UNIT.BANNER);

    When using this init approach, you can now initialize each ad unit separately at different touchpoints in your app flow in one session.

    //Rewarded Video
    IronSource.init(this, appKey, IronSource.AD_UNIT.REWARDED_VIDEO);
    //Init Interstitial 
    IronSource.init(this, appKey, IronSource.AD_UNIT.INTERSTITIAL); 
    //Init Offerwall
    IronSource.init(this, appKey, IronSource.AD_UNIT.OFFERWALL) 
    //Init Banner
    IronSource.init(this, appKey,IronSource.AD_UNIT.BANNER);
  2. Alternatively, you can init the SDK as detailed below and the SDK will init the ad units you’ve configured on the ironSource platform:
    IronSource.init(this, appKey);

For ProGuard Users Only

If you are using ProGuard with the ironSource SDK, you must add the following code to your ProGuard file (Android Studio: proguard-rules.pro or Eclipse: proguard-project.txt):

-keepclassmembers class com.ironsource.sdk.controller.IronSourceWebView$JSInterface {
    public *;
}
-keepclassmembers class * implements android.os.Parcelable {
    public static final android.os.Parcelable$Creator *;
}
-keep public class com.google.android.gms.ads.** {
   public *;
}
-keep class com.ironsource.adapters.** { *;
}
-dontwarn com.ironsource.mediationsdk.**
-dontwarn com.ironsource.adapters.**
-keepattributes JavascriptInterface
-keepclassmembers class * {
    @android.webkit.JavascriptInterface <methods>;
}

Step 6. Verify Your Integration

The ironSource SDK provides an easy way to verify that your Rewarded Video Mediation integration was completed successfully. To verify your ironSource SDK integration as well as any additional Ad Networks you have implemented, simply add this method to your project:

IntegrationHelper.validateIntegration(activity);

For more details on the ironSource Integration Verification tool navigate to this article.

Done! You just integrated the ironSource SDK in your app. 
You are now ready to start working with ironSource’s Ad Units and Mediation Tools.


What’s Next?
  1. Follow our integration guides and implement our Ad Units:
    Rewarded Video
    Interstitial
    Offerwall
    Banner Mediation
  2. Interested in Mediation? Integrate our Rewarded Video, Interstitial or Banner Ads in your app and follow our Mediation articles.
  3. Verify your integration with the Integration Helper.
You can read this article in: