AdColony Mediation Integration Guide

This guide instructs you step-by-step on how to set AdColony live as an Ad Network on the ironSource Mediation platform.

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.

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

 

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 in the relevant fields.
    ironsource-platform-app-settings-adc-ios
  • 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

iOS

 ironSource supports both Cocoapods and Manual download mechanisms.

Download the AdColony Adapter with Cocoapods

To integrate the AdColony SDK with Cocoapods, enter the following line in your podfile and you’re good to go!

pod 'IronSourceAdColonyAdapter','3.2.2.1'

Download the AdColony Adapter Manually

  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 SDK. You DON’T need to add the SDK directly.
  2. Add the AdColony frameworks to your Project:
    After you download the Adapter, drop the Adapter framework into your Xcode Project, i.e. drop ISAdColonyAdapter.framework into your Xcode project.
  3. Open Target ➣ Build Settings ➣ Architectures and confirm that your Xcode Project uses Base SDK version 7.0 or greater and that it does not use armv6 architecture.

Step 5. Configure Additional Settings

  1. Add Linker Flag

    Add a separate linker flag to Target ➣ Build Settings ➣ Linking ➣ Other Linker Flags:
    -fobjc-arc

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

    adcolony-supported-orientations

  3. Configure App Transport Security (ATS) Settings & URL Schemes

    1. You can choose to disable or enable ATS on your application by setting the following configurations:
      1. Disable ATS
        Disable ATS by adding the following key to your info.plist file:

        <key>NSAppTransportSecurity</key>
        <dict>
           <key>NSAllowsArbitraryLoads</key>
           <true/>
        </dict>
      2. Enable ATS
        If you want to keep ATS enabled, add the following keys to your info.plist file:

        <key>NSAppTransportSecurity</key>
        <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
        <key>NSAllowsLocalNetworking</key>  
        <true/>
        <key>NSAllowsArbitraryLoadsInWebContent</key>
        <true/>
        </dict>
    2. Next, add the following entry to your app’s plist for URL scheme support:
      <key>LSApplicationQueriesSchemes</key>
          <array>
              <string>fb</string>
              <string>instagram</string>
              <string>tumblr</string>
              <string>twitter</string>
          </array>
  4. Configure Privacy Controls

    If your app is compatible with iOS 10, make sure to configure the below Privacy Controls:

    <key>NSCalendarsUsageDescription</key>
    <string>Adding events</string>
    <key>NSPhotoLibraryUsageDescription</key>
    <string>Taking selfies</string>
    <key>NSCameraUsageDescription</key>
    <string>Taking selfies</string>
    <key>NSMotionUsageDescription </key>
    <string>Interactive ad controls</string>

    Read more about these configurations here.

Verify Your Ad-Network Integration

  • Verify your ad network integration with our Integration Helper. The ironSource SDK provides a tool to ensure you’ve successfully integrated our SDK as well as any additional network adapters.
  • Manage the debug logs for your integrated mediation ad networks with this boolean
    [IronSource setAdaptersDebug:YES];

    When set to YES, this line of code will enable debug logs to help you troubleshoot issues with all of your mediation ad networks. Remove this code before your app goes live with our ad units! Supported for SDK versions 6.5.2 and up. 

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.