AdColony Mediation Integration Guide for SDK 6.4 and Below

This guide will instruct you step-by-step on how to set AdColony live as an Ad Network on the ironSource Mediation platform. The integration process is completed in a few simple steps:

  1. Create an AdColony Account
  2. Create an Application and Ad Zone in AdColony
  3. Activate AdColony in Your ironSource Network Setup Module
  4. Add the AdColony Adapter to Your Build
  5. Update AndroidManifest.xml

Before You Start

Make sure you have correctly integrated ironSource’s Rewarded Video or Interstitial into your application. 

Step 1. Create an AdColony Account

  1. Create an account with AdColony. You can do so here.
  2. 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 ironSource’s Mediation platform, you must first add your app and set up Ad Zones in your AdColony account.

  1. Add Your App
    1. Log into your AdColony account and select ‘Setup New App’:AdColony integration with Supersonic Mediation - 01
    2. Define the settings of your app:
      1. Platform – iOS or Android
      2. 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.
      3. COPPA – Select if your app is targeted to users under the age of 13 for COPPA compliancy.
      4. Ad Settings – You can customize which Ad Categories you want to utilize.Once you’ve entered all your information, select ‘Create’ to finish.AdColony integration with Supersonic Mediation - 02
        Note: You will need a unique AdColony application per platform (iOS + Android),  just the same as in your ironSource account.
  2.  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 ironSource Rewarded Video or Interstitial to trigger.

    1. Select ‘Setup New Ad Zone’
      AdColony integration with Supersonic Mediation - 03
    2. Create the Ad Zone settings:
      1. Rewarded Video:
        Zone is active? ‘Yes’
        Zone Type: ‘Value Exchange/V4VC’ 
        Client Side Only: ‘Yes
        AdColony integration with Supersonic Mediation - 04When finished, hit ‘Create’.
        AdColony integration with Supersonic Mediation - 05
      2. Interstitial:
        Zone is active? ‘Yes’
        Zone Type:Preroll/ Interstitial’
        House Ads:None’
        Development:No’
        Supersonic AC Ad Zone SettingsWhen finished, hit ‘Create’
        .
        AdColony integration with Supersonic Mediation - 05

Step 3. Activate AdColony in Your ironSource Network Setup Module

There are a few pieces parameters from your AdColony account which need to be inserted into your ironSource Network Setup Module in order for AdColony to work correctly in connection with ironSource:

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 ironSource Mediation 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 ironSource Mediation platform.

  1. App ID
    Navigate back to the ‘Apps‘ tab and you will locate the ‘AdColony App ID‘.
    AdColony integration with Supersonic Mediation - 06
  2. 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‘.
    AdColony integration with Supersonic Mediation - 06B
  3. Read-Only API Key
    Select the Drop-down menu on the top right of their dashboard, and you will find the ‘Account Settings’ link.
    AdColony integration with Supersonic Mediation - 07On the settings page you will find the ‘Read-Only API Key’.
    AdColony integration with Supersonic Mediation - 08
  4. 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‘.
    ironsource-platform-mediation-network-setup
  • Select AdColony from the list of Available Ad Networks and enter the AdColony ‘API Key‘. Click ‘Save‘.
    ironsource-mediation-platform-activate-adcolony
  •  AdColony will then be enabled in the Available Ad Networks table.
    ironsource-mediation-platform-adcolony-activated
  • Make sure to define the app on which you’d like to run ironSource’s Interstitial Mediation with AdColony. Go to the AdColony row on the Setup list of Ad Networks and click on the ‘Define‘ icon.ironsource-mediation-platform-define-ac
  • Insert the App ID‘ and the ‘Zone ID‘ for Rewarded Video and/or Interstitial and ‘Client Options‘ in the relevant fields.
    ironsource-platform-app-settings-adc-android
  • Set status to Active and click ‘Save’. You will then see AdColony as Active for Mediation on your Setup Dashboard.
    ironsource-platform-activated-setup-adc
  • 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

Android

 ironSource supports both Gradle dependencies and manual download mechanisms.

Gradle:

  1. Make sure the following Maven URL exist in your build.gradle script of your app module (should appear only once for all the adapters). Add the adapter’s Maven name to your build.gradle script of your app module.
    repositories {
        maven {
            url "https://adcolony.bintray.com/AdColony"
        }
        maven {
            url "https://dl.bintray.com/supersonic/android-adapters"
        }
  2. Add the adapter’s Maven name to your build.gradle script of your app module.
    dependencies {                                                                                            compile 'com.supersonic.adapters:adcolonyadapter:2.1.5@jar'
    compile 'com.adcolony:sdk:3.0.4'
    }

Manual download:

  1. Download the AdColony Adapter:
    Add the AdColony Adapter to your build. You can find the latest AdColony Adapter here.
    Important! The AdColony Adapter also contains the AdColony jar. You DON’T need to additionally add the AdColony jar directly.
  2. Add the AdColony Adapter to your Project:
    After you download the Adapter; drop the AdColonyAdapter jar into the libs folder in your Android Project.
    AdColony integration with Supersonic Mediation - 10
  3. Make sure you add the following to your Gradle build file under the dependencies section:

    compile fileTree(dir: 'libs', include: ['*.jar'])
  4. Download the AdColony .AAR file
    Note:
    If using Android Studio: Download the AdColony .AAR file and add as a dependency to your own module.
    If using Eclipse: Import the .AAR file as a library project.
  5. In Android Studio go to FileNewNew ModuleImport .AAR.
    Navigate to the location where the AdColony .AAR file has been downloaded.
    android-studio-aar-integration

Step 5. Update AndroidManifest.xml

 Manifest Permissions
Add the following permissions before the <application> tag on your manifest:

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

Manifest Activities
Add the following activities inside the <application> tag on your manifest:

<activity android:name="com.adcolony.sdk.AdColonyInterstitialActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:hardwareAccelerated="true"/>
<activity android:name="com.adcolony.sdk.AdColonyAdViewActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:hardwareAccelerated="true"/>

Verify Your Ad-Network Integration

The ironSource SDK provides an easy way to verify that your mediation integration was completed successfully. To verify your ironSource and any additional Ad Networks’ integration, follow this document.

 

Done!
You are now all set to deliver AdColony Ads within your application!


What’s Next?

To add additional Ad networks, follow the integration guides on our Supported Ad Networks list.