Mediation - UnityAds
This guide shows how to add mediation through UnityAds to your IronSource integration.
Step 1: Create a UnityAds Account
Create an account with UnityAds. You can do so here.
Once your account has been verified you can log in at their partner login here.
Step 2: Create an Application and Placement in UnityAds
Follow these steps to create your UnityAds application:
https://developers.ironsrc.com/ironsource-mobile/android/unityads-mediation-guide/#step-2
Step 3: Activate UnityAds on ironSource Network SDK Setup
https://developers.ironsrc.com/ironsource-mobile/android/unityads-mediation-guide/#step-3
Step 4: Add the UnityAds 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.UnityAds
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.UnityAds.ane # UnityAds 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.
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.UnityAds
ANE includes the UnityAds SDK and the IronSource UnityAds mediation adapter. This is everything you need to get UnityAds 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
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
The following should be added to your extensions
node in your application descriptor to identify all the required ANEs in your application:
<extensions>
<extensionID>com.distriqt.Core</extensionID>
<extensionID>com.distriqt.IronSource</extensionID>
<extensionID>com.distriqt.ironsource.UnityAds</extensionID>
<extensionID>com.distriqt.playservices.Base</extensionID>
<extensionID>com.distriqt.playservices.Ads</extensionID>
<extensionID>com.distriqt.playservices.AdsIdentifier</extensionID>
<extensionID>androidx.core</extensionID>
<extensionID>com.jetbrains.kotlin</extensionID>
</extensions>
Android
Manifest Additions
Add the following to your manifest additions inside the application
tag.
<!-- UNITY ADS -->
<activity
android:name="com.unity3d.services.ads.adunit.AdUnitActivity"
android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
android:hardwareAccelerated="true"
android:theme="@android:style/Theme.NoTitleBar.Fullscreen" />
<activity
android:name="com.unity3d.services.ads.adunit.AdUnitTransparentActivity"
android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
android:hardwareAccelerated="true"
android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
<activity
android:name="com.unity3d.services.ads.adunit.AdUnitTransparentSoftwareActivity"
android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
android:hardwareAccelerated="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
<activity
android:name="com.unity3d.services.ads.adunit.AdUnitSoftwareActivity"
android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
android:hardwareAccelerated="false"
android:theme="@android:style/Theme.NoTitleBar.Fullscreen" />
iOS
Info Additions
Add the following to your InfoAdditions
node updating the usage description strings as required for your application:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSExceptionDomains</key>
<dict>
<key>localhost</key>
<dict>
<key>NSExceptionAllowsInsecureHTTPLoads</key>
<true/>
</dict>
</dict>
</dict>
<!-- iOS 14 AdNetwork -->
<key>SKAdNetworkItems</key>
<array>
<dict>
<!-- IronSource -->
<key>SKAdNetworkIdentifier</key>
<string>SU67R6K2V3.skadnetwork</string>
</dict>
<dict>
<!-- UnityAds -->
<key>SKAdNetworkIdentifier</key>
<string>4DZT52R2T5.skadnetwork</string>
</dict>
</array>
Step 5: Additional code required
There is no additional code required.