Chartboost Mediation Integration Guide

This guide will instruct you step-by-step on how to set Chartboost 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 a Chartboost Account

  1. Create an account with Chartboost. You can do so here.
  2. Once your account has been verified you can login at their partner login here.

Step 2. Create an Application in Chartboost

Already set up your application(s) at Chartboost? Skip to here.

First Time Setup Process
If this is your first time setting up a Chartboost account, continue below.

  1. When you log in for the first time, select ‘Start making money!
    Chartboost integration with Supersonic Mediation - 01
  2. Define Your App
    Chartboost will automatically try to identify your Applications in the Appstore based on the company name you provide in the sign-up process. If this process is successful, simply select the applications you want to run ironSource’s Mediation on.
    If this process doesn’t work immediately, you have two options:

    1. Search for your Company manually:
      Chartboost integration with Supersonic Mediation - 02
    2. If your apps aren’t published on any Appstore yet, you can enter details manually:
      Chartboost integration with Supersonic Mediation - 03
      Note: You will need a unique Chartboost application per platform (iOS + Android) just like you do with your ironSource account.
    3. After you defined the Applications, select the relevant Apps and click ‘Add Selected (x of x)‘:
      Chartboost integration with Supersonic Mediation - 04
  3. Now you must select the ads you want to serve in your app.
    1. If interested in serving Chartboost Rewarded Video Ads on the ironSource Mediation platform, select ‘Rewarded Video Ads‘ and select ‘Create Campaign(s)‘:
      Chartboost integration with Supersonic Mediation - 05
    2. If interested in serving Chartboost Interstitial Ads on the ironSource Mediation platform,Select ‘Static Interstitial Ads‘ and select ‘Create Campaign(s)‘:
      Chartboost IS Mediation Interstitial Ads
  4. You will be re-directed to the below page where you will find a summary of your newly created Apps.
    You will specifically find both the ‘App ID‘ and the ‘App Signature‘ here. These parameters should be entered into your ironSource Admin account under the ‘Network Setup‘ Module.
    Chartboost integration with Supersonic Mediation - 10
  5. If interested in Chartboost’s Rewarded Video on the ironSource Mediation platform, you will need to turn OFF Chartboost’s pre/post-roll video messaging. Navigate to your app, select ‘Basic Settings‘ ➣ ‘Rewarded Video‘ ➣ ‘Advanced‘ and you will see two checkboxes. Make sure they are unchecked and select ‘Save‘:
    Chartboost integration with Supersonic Mediation - 11

Once you have completed the above process successfully, continue here.

Registered User Process
If you have previously set up your Chartboost account and you’re simply adding new applications to use on ironSource‘s Mediation platform, follow this section.
Is this your first time setting up your application(s) on Chartboost? Start here.
  1. Once you login, select ‘Dashboard‘ ➣ ‘Publishing‘ ➣ ‘Add App‘:Chartboost integration with Supersonic Mediation - 08
  2. Define the details of your application:
    1. Platform – iOS or Android.
    2. App Nickname – Used to represent your app in the Chartboost Reporting UI.
    3. Orientation – Select ‘Landscape’ or ‘Portrait’.
    4. Test Mode – Select ‘Disabled’.Once finished select ‘Save’:
      Chartboost integration with Supersonic Mediation - 09
      Note: You will need a unique Chartboost application per platform (iOS + Android) just like you do with your ironSource account.
  3. You will be re-directed to the below page where you will find a summary of your newly created Apps.
    You will find both the ‘App ID‘ and the ‘App Signature‘ here. These parameters should be entered into your ironSource Admin account under the ‘Network Setup‘ Module.
    Chartboost integration with Supersonic Mediation - 10
  4. If interested in Chartboost’s Rewarded Video on the ironSource Mediation platform, you will need to turn OFF Chartboost’s pre/post-roll video messaging. Navigate to your app, select ‘Basic Settings‘ ➣ ‘Rewarded Video‘ ➣ ‘Advanced‘ and you will see two checkboxes. Make sure they are unchecked and select ‘Save‘:
    Chartboost integration with Supersonic Mediation - 11

 

Step 3. Create a Chartboost Publishing Campaign

In order to serve Chartboost’s ad inventory in your app through the ironSource Mediation platform, you must create a publishing campaign on Chartboost.

  1. Within your Chartboost dashboard, click Add a Campaign in the bottom-left corner and then click Network Publishing.
    Supersonic IS Mediation Chartboost Network Publishing
  2. In the Simple Settings section, indicate the type of ad you wish to serve (Rewarded Video or Static Interstitial)  in the Ad Type drop-down.
    Note: You must create two different campaigns if you want to serve both Rewarded Video and Interstitial Ads through the ironSource Mediation platform.
  3. Click Save.
    Note: Campaigns may take up to 20 minutes to go live.

    Publishing Campaign Targeting Options
    If you’d like to define targeting options for your application, follow the instructions on Chartboost.

Step 4. Activate Chartboost on ironSource SDK Networks Module

There are 4 pieces of Data from the Chartboost account which need to be inserted into your ironSource Network Setup Module in order for Chartboost to work correctly in connection with ironSource:

App ID This is the unique identifier of your Application in Chartboost’s system.
App Signature This is the unique signature used to validate Ad Requests to your specific Chartboost Application.
User ID This is a unique identifier for your Chartboost account, which allows your ironSource Mediation Platform to import performance data from your Chartboost account to use in reporting & optimization.
User Signature  This is a unique identifier for your Chartboost account to verify reporting requests made by ironSource on your behalf.

Once you obtain this information, you must configure Chartboost’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of Chartboost’s ad inventory and reporting data on ironSource’s Mediation platform.

    1. App ID & App Signature

      Navigate back to ‘Dashboard‘ ➣ ‘App Settings‘ ➣ ‘Basic Settings‘ and you fill the ‘App ID‘ and ‘App Signature‘ listed:Chartboost integration with Supersonic Mediation - 12

    2. User ID & User Signature

      Navigate back to ‘Dashboard‘ ➣ ‘Overview / Advertising‘ and select ‘API Explorer‘ from the ‘Tools‘ drop-down:
      Chartboost integration with Supersonic Mediation - 013
      On the following page you will find both the ‘User ID‘ & the ‘User Signature’ listed:
      Chartboost integration with Supersonic Mediation - 14

Configure Chartboost’s Parameters into ironSource Account

Once you have all these parameters, log in to your ironSource account.

  • Go to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘Network Setup‘.ironsource-platform-mediation-network-setup
  • Select Chartboost from the list of available Ad Networks and enter the Chartboost ‘User ID’ and ‘User Signature‘ in the relevant fields.
    ironsource-platform-account-settings-cb
  • Select the app which you’d like to run ironSource‘s Mediation on with Chartboost.
    ironsource-platform-select-app-cb
  • Go to Chartboost from the list of available Ad Networks and click on the Define icon.
    ironsource-platform-define-cb
  • Enter the Chartboost ‘App ID‘, ‘App Signature‘, ‘User ID’ and ‘User Signature‘ in the relevant fields. Set status to Active and click ‘Save’.ironsource-platform-app-settings-cb
  • You will then see Chartboost as Active for the ad units selected on your Mediation Dashboard.
    ironsource-platform-mediation-active-chartboost
  • 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 5. Add the Chartboost 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).
    repositories {
    maven {
    url "https://dl.bintray.com/ironsource-mobile/android-adapters"
    }
    }
  2. Add the adapter’s Maven name to your build.gradle script of your app module.
    dependencies {
        compile 'com.ironsource.adapters:chartboostadapter:3.2.0@jar'
    }

 Manual Download

  1. Download the Chartboost Adapter:
    Add the Chartboost Adapter to your build. You can find the latest Chartboost Adapter here.
    Important! The Chartboost Adapter also contains the Chartboost jar. You DON’T need to additionally add the Chartboost jar directly.
  2. Add the Chartboost Adapter to your project:
    After you download the Adapter; drop the ChartboostAdapter jar into the libs folder in your Android Project.
    Supersonic Drop Jar into Libs
  3. Make sure you add the following to your Gradle build file under the dependencies section:

    compile files('libs/chartboostadapter:3.2.0@jar')

Step 6. Update AndroidManifest.xml

Manifest Permissions:

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

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

<activity
android:name="com.chartboost.sdk.CBImpressionActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"
android:configChanges="keyboardHidden|orientation|screenSize"
android:excludeFromRecents="true"
android:hardwareAccelerated="true"/>

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(true);

    When set to TRUE, 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 Chartboost Ads through the ironSource Mediation platform!


What’s Next?
To leverage additional ad networks through ironSource Mediation, integrate the adapters and follow our integration guides.