AdColony Mediation Integration Guide
This guide instructs you step-by-step on how to set AdColony live as an Ad Network on the Unity LevelPlay Mediation platform.
Before you start Make sure you have correctly integratedStep 1. Create an AdColony Account
- Create an account with AdColony. You can do so here.
- Once your account has been verified, you can log in to their partner login here.
Step 2. Create an Application and Ad Zone in AdColony
To gain access to AdColony’s inventory within Unity LevelPlay Mediation platform, you must first add your app and set up Ad Zones in your AdColony account.
- Add Your App
- Log into your AdColony account and select ‘Setup New App’:
- Define the settings of your app:
- Platform – iOS or Android
- App URL – Add the AppStore or Google Play URL of your application. If your app is not live yet, you can also enter a temporary name manually.
- COPPA – Select if your app is targeted to users under the age of 13 for COPPA compliancy.
- Ad Settings – You can customize which Ad Categories you want to utilize.Once you’ve entered all your information, select ‘Create’ to finish.Note: You will need a unique AdColony application per platform (iOS + Android), just the same as in your ironSource account.
- Create an Ad Zone
Once your application has been added, you can create an Ad Zone. In AdColony’s system Ad Zones are Placements to which AdColony delivers ads. This will be the placement in your app where you have configured the Rewarded Video, Interstitial or Banner to trigger.- Select ‘Setup New Ad Zone’
- Create the Ad Zone settings:
- Rewarded Video:
Zone is active? ‘Yes’
Zone Type: ‘Value Exchange/V4VC’
Client Side Only: ‘Yes‘
When finished, hit ‘Create’.
- Interstitial:
Zone is active? ‘Yes’
Zone Type: ‘Preroll/ Interstitial’
House Ads: ‘None’
Development: ‘No’When finished, hit ‘Create’.
- Banner:
Zone is active? ‘Yes’
Ad Zone Size: ‘Banner’
Development: ‘No’
When finished, hit ‘Create’.
- Rewarded Video:
- Select ‘Setup New Ad Zone’
Step 3. Activate AdColony in the SDK Networks Setup Module
There are a few parameters from your AdColony account which need to be inserted into your SDK Network Setup Module on the Unity LevelPlay platform in order for AdColony to work correctly in connection with Unity LevelPlay:
App ID | This is the unique identifier of your application in AdColony’s system. |
Zone ID | This is the unique zone which AdColony will deliver ads to. |
Read-Only API Key | This is a unique identifier for your AdColony account, which allows the Unity LevelPlay MediationMediation Platform to import performance data from your AdColony account to use in reporting & optimization. |
Client Options (Android Apps Only) | This is a string to declare your App Version and App Store so AdColony may optimize according to this data. |
Once you obtain this information, you must configure AdColony’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of AdColony’s ad inventory and reporting data on the Unity LevelPlay Mediation Mediation platform.
- App ID
Navigate back to the ‘Apps‘ tab and you will locate the ‘AdColony App ID‘.
- Zone ID
Navigate to ‘Monetization’ ➣ Select the ‘App’ you created ➣ Then select the ‘Zone‘ you created and you will be directed to the below page, where you will find the ‘Zone ID‘.
- Read-Only API Key
Select the Drop-down menu on the top right of their dashboard, and you will find the ‘Account Settings’ link.
On the settings page you will find the ‘Read-Only API Key’.
- Client Options (Android Apps Only)
Quoted from AdColony documentation:
“A String containing your app version, and the origin store (example: version:1.1,store:google). Please note that if you are integrating into an Amazon app you will need to replace ‘google‘ with ‘amazon‘ in the client_options String.”
Configure AdColony’s Parameters into ironSource Account
- Once you have all of these parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘SDK Networks‘.
- Select AdColony from the list of Available Ad Networks and enter the AdColony ‘API Key‘. Click ‘Save‘.
- AdColony will then be enabled in the Available Ad Networks table.
- Make sure to define the app on which you’d like to run Unity LevelPlay’s mediation with AdColony. Go to the AdColony row on the Setup list of Ad Networks and click on the ‘Define‘ icon.
- Insert the ‘App ID‘ and the ‘Zone ID‘ for Rewarded Video and/or Interstitial in the relevant fields.
- Set status to Active and click ‘Save’. You will then see AdColony as Active for Mediation on your Setup Dashboard.
- New! Verify your integration with the Reporting API; this column will check your integration through the Reporting API and return three possible responses: Verified, Failed and No Response. Double check your integration and the information you entered above; then click ‘Retry‘ until you see ‘Verified’.
Step 4. Add the AdColony Adapter to Your Build
Unity Integration Manager (Recommended)
Once you’ve completed SDK integration, you can download AdColony Adapter, using the Unity Integration Manager.
In your Unity Development platform, go to ironSource > Integration Manager
If you already have the latest version of the adapters, the action button will be changed to “Updated”, and will be disabled.
Android (Manual Resolve)
To apply your changes, make sure you use the “Resolve” process. This will download all relevant artifacts, according to your choices. For detailed information see instructions here.
For Proguard Users Only – Android
If you are using ProGuard with the AdColony adapter, you must add the following code to your ProGuard configuration (Android Studio: proguard-rules.pro or Eclipse: proguard-project.txt):
# For communication with AdColony's WebView -keepclassmembers class * { @android.webkit.JavascriptInterface <methods>; } # Keep ADCNative class members unobfuscated -keepclassmembers class com.adcolony.sdk.ADCNative** { *; }
Android Plugin Manual Integration
- Download the AdColony Adapter for Android:
Download AdColony adapter and AdColony SDK (AAR) from here. - Add the AdColony files to your Unity project:
Import the files into Assets/Plugins/Android/.
To accommodate changes in Unity version 5.5, the ironSource Plugin version 6.7.1 requires Android Manifests to be added separately for the Plugin and mediation adapter. If you are updating your plugin or currently running on 6.7.1, make sure to add the manifest activities noted in the Android documentation.
iOS Plugin Manual Integration
- Download the AdColony iOS Adapter:
Download AdColony adapter and from here. - Add the AdColony files to your Unity project:
Import AdColony adapter file into Assets/Plugins/iOS. - Configure Supported Orientations
In order for your app to work in conjunction with the AdColony SDK, your app must support all orientations globally. To do this, select all possible orientations under the General tab of your Xcode target:
- Configure App Transport Security (ATS) Settings & URL Schemes
- You can choose to disable or enable ATS on your application by setting the following configurations:
- Disable ATS
Disable ATS by adding the following key to your app descriptor XML:<key>NSAppTransportSecurity</key> <dict> <key>NSAllowsArbitraryLoads</key> <true/> </dict>
- Enable ATS
If you want to keep ATS enabled, add the following keys to your app descriptor XML:<key>NSAppTransportSecurity</key> <dict> <key>NSAllowsArbitraryLoads</key> <true/> <key>NSAllowsLocalNetworking</key> <true/> <key>NSAllowsArbitraryLoadsInWebContent</key> <true/> </dict>
- Disable ATS
- Next, add the following entry to your app descriptor XML for URL scheme support:
<key>LSApplicationQueriesSchemes</key> <array> <string>fb</string> <string>instagram</string> <string>tumblr</string> <string>twitter</string> </array> </key>
- You can choose to disable or enable ATS on your application by setting the following configurations:
Our Unity Plugin adds the necessary frameworks automatically to your Xcode project.
iOS10 Support (Optional)
If your app is compatible with iOS 10, make sure to configure the below Privacy Controls:
<key>NSPhotoLibraryUsageDescription</key> <string>Taking selfies</string> <key>NSCameraUsageDescription</key> <string>Taking selfies</string> <key>NSMotionUsageDescription </key> <string>Interactive ad controls</string>
Step 5. Additional Steps
COPPA
Unity LevelPlay’s mediation platform lets publishers communicate AdColony Child-directed settings directly to the AdColony network.
This feature is enabled using ironSource SDK 7.1.0+, AdColony Unity Adapter 4.3.10+.
Use the following syntax, to set AdColonyAppOptions.COPPA with the parameter true:
IronSource.Agent.setMetaData("AdColony_COPPA","true");
Use the following syntax, to set AdColonyAppOptions.COPPA with the parameter false:
IronSource.Agent.setMetaData("AdColony_COPPA","false");
To learn more about Child-directed settings Under AdColony network visit here.
here.
Google Families Policy & DFF
Unity LevelPlay’s mediation platform lets publishers communicate AdColony DFF-Compliance mode directly to the AdColony network.
This feature is enabled using ironSource SDK 7.2.1+, AdColony Unity Adapter 4.3.16+.
Use the following syntax, to prevent access to the AAID:
IronSource.Agent.setMetaData("AdColony_APP_Child_Directed","true");
To learn more about Google Families Policy support under AdColony network visit here.
here.
Done!
You are now all set to deliver AdColony Ads within your application!
What’s Next?
To add additional mediation Ad networks, integrate the ironSource adapters and follow our integration guides.