Unity Plugin Integration

Step 1. Add the ironSource Unity package to your project

Follow these steps to add the IronSource Unity Package to your project:

1. Download Unity Plugin Version 7.2.5.1
2. Make sure your Unity project is opened and import the Unity package.
3. Double-click on the extracted file; the different files will be populated automatically as shown below:
   

Unity LevelPlay demo app

The Integration Demo application demonstrates how to integrate Unity LevelPlay mediation in your app

Download Unity Demo Application

Step 2. Unity Integration Manager – Recommended 

The ironSource Integration Manager tool is based on Google External Dependency Manager for Unity (formerly Play Services Resolver). It will enable you to download the latest versions of ironSource SDK and adapters directly from your Unity development platform. 

Pre-requisites

• Unity Developer Version 2017.2 or above
• For iOS – Cocoapods applied

Manage SDK versions

Once you’ve updated your Unity package for the new SDK and Integration Manager, you’ll be able to view the ironSource sub-menu in the Unity menu bar.

To upgrade your SDK or Adapter versions:

• Go to ironSource > Integration Manager
• Choose “Install” or “Update”

If you already have the latest version of ironSource SDK or Adapters, the action button will be changed to “Updated”, and will be disabled.

Android

To apply your changes, make sure you use the “Resolve” process. This will download all relevant artifacts, according to your choices.

Manual resolve
Go to: Assets → Play Services Resolver → Android → Resolve

 This action should be performed after each change in the ironSource Integration Manager.

If you’re using Automatic Resolve, all updates will be performed when closing the Integration Manager window.

For Gradle users 

Using ironSource Integration Manager for Unity, you will be able to avoid downloading the Android artifacts into your project. Instead, the artifacts will be added to your gradle file during the compilation. 

To enable this process, follow these steps: 

1. Go to: Assets → Play Services Resolver → Android → Settings 
2. Select “Patch mainTemplate.gradle”
3. Save your changes, by pressing “OK”

iOS

Make sure that Cocoapods is installed:

Go to: Assets → Play Service Resolver → iOS Resolver → Install Cocoapods

Step 3. Additional settings for iOS

Add Ad-Support.framework to your Xcode project

Our Unity Plugin usually adds all the required frameworks automatically. In some cases, the AdSupport.framework can’t be added automatically using Unity 5.6. Verify if the framework has been added and in the case it has not been added automatically, make sure to add it manually.

SKAdNetwork support

To enable the display of ironSource network ads while using SDK 7+, make sure to include the ironSource ad network ID in your app property list file (Info.plist). 

1. Select Info.plist in the Project navigator in Xcode
2. Click the Add button (+) beside a key in the property list editor and press Return
3. Type the key name SKAdNetworkItems
4. Choose Array from the pop-up menu in the Type column
5. Create a dictionary item, and below it a single sting item  
6. Enter Key name SKAdNetworkIdentifier, and the key value:

   su67r6k2v3.skadnetwork

   You can also add SKAdNetworkIdentifier  to your Info.plist, by using this code:

<key>SKAdNetworkItems</key>
<array>
   <dict>
      <key>SKAdNetworkIdentifier</key>
      <string>su67r6k2v3.skadnetwork</string>
   </dict>
</array>

For more information on editing the property list, see the Xcode documentation.

Universal SKAN Reporting

To receive copies of winning install-validation postbacks from all of the demand sources for your advertised app, add the NSAdvertisingAttributionReportEndpoint key in your app’s Info.plist.

1. Select Info.plist in the Project navigator in Xcode
2. Click the Add button (+) beside a key in the property list editor and press Return
3. Type the key name NSAdvertisingAttributionReportEndpoint
4. Choose String from the pop-up menu in the Type column
5. Type the URL: https://postbacks-is.com 

Learn more about Universal SKAN reporting here.

App transport security settings

To ensure uninterrupted support for ironSource ad delivery across all mediation networks, it’s important to make the following changes in your info.plist:

• Add in a dictionary called ‘NSAppTransportSecurity‘. Make sure you add this dictionary on the ‘Top Level Key‘.
•  Inside this dictionary, add a Boolean called ‘NSAllowsArbitraryLoads‘ and set it to YES.
  
• Make sure that your info.plist does not contain any other exceptions besides ‘NSAllowsArbitraryLoads‘, as this might create a conflict.
• Find more information on ATS here.

Step 4. Additional setup for Android

Apps updating their target API level to 31 (Android 12) will need to declare a Google Play services normal permission in the manifest file as follows:

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Read more about Google Advertising ID changes here.

Unity 2020 Requirements

If you are using Unity 2020+, add the following gradle properties to android/gradle.properties:

android.enableDexingArtifactTransform=false

Step 5. Manual integration

As an alternative to Unity Integration Manager, you can manually integrate ironSource SDK.

Android manual integration

1. Download Android SDK Version 7.2.5
2. Copy .aar file to /Assets/Plugins/Android

Google identifier permissions

ironSource SDK requires  google play services Basement and google play services Identifier, while other networks may also require additional google play services.
Add the Play Services dependencies into the dependencies block, to allow GAID and APP Set ID information to be retrieved.

dependencies { 
    implementation fileTree(dir: 'libs', include: ['*.jar']) 
    implementation 'com.google.android.gms:play-services-appset:16.0.0' 
    implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0' 
    implementation 'com.google.android.gms:play-services-basement:17.1.1' 
}

Learn more about Google’s app set id here.

iOS manual integration

1. Download iOS SDK Version 7.2.5.1
2. Unzip the file and add IronSource.framework into /Assets/Plugins/iOS

Step 6. Initialize the ad units

Application State

First, you’ll need to pass the state of the application by executing the following event function during the Application Lifecycle.

Call onApplicationPause in each of the Unity Scenes:

void OnApplicationPause(bool isPaused) {                 
  IronSource.Agent.onApplicationPause(isPaused);
}

Init the plugin and ad units

You can initialize the plugin in two ways. We recommend the first method as it will fetch the specific ad units you define.

1. This method will init the specific ad units mentioned in the adUnits parameter:

   IronSource.Agent.init (YOUR_APP_KEY, IronSourceAdUnits.REWARDED_VIDEO, IronSourceAdUnits.INTERSTITIAL, IronSourceAdUnits.OFFERWALL, IronSourceAdUnits.BANNER);
   

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

   //For Rewarded Video
   IronSource.Agent.init (YOUR_APP_KEY, IronSourceAdUnits.REWARDED_VIDEO);
   //For Interstitial
   IronSource.Agent.init (YOUR_APP_KEY, IronSourceAdUnits.INTERSTITIAL);
   //For Offerwall
   IronSource.Agent.init (YOUR_APP_KEY, IronSourceAdUnits.OFFERWALL);
   //For Banners
   IronSource.Agent.init (YOUR_APP_KEY, IronSourceAdUnits.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.Agent.init (YOUR_APP_KEY);

 ironSource Init Complete Listener          

The ironSource SDK fires postback to inform you that the ironSource SDK was initialized successfully, for ironSource SDK 7.2.1+ . This listener will provide you an indication that the initialization process was completed, and you can start loading ads. The callback will be sent once per session, and will indicate the first initialization of the SDK. 

IronSourceEvents.onSdkInitializationCompletedEvent += SdkInitializationCompletedEvent;
private void SdkInitializationCompletedEvent(){}

Step 7. 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:

IronSource.Agent.validateIntegration();

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

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.** { *;
}
-keep class com.ironsource.unity.androidbridge.** { *;
}
-dontwarn com.ironsource.mediationsdk.**
-dontwarn com.ironsource.adapters.**
-keepattributes JavascriptInterface
-keepclassmembers class * {
    @android.webkit.JavascriptInterface <methods>;
}

Done!
You’re now ready to start working with ironSource’s ad units and mediation tools.