Chartboost Integration Guide

This guide will instruct you step-by-step on how to set Chartboost live as an Ad Network on Unity LevelPlay.

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.

1. When you log in for the first time, select ‘Start making money!’
   
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:
      
   2. If your apps aren’t published on any Appstore yet, you can enter details manually:
      
      
      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)‘:
      
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 Unity LevelPlay platform, select ‘Rewarded Video Ads‘ and select ‘Create Campaign(s)‘:
      
   2. If interested in serving Chartboost Interstitial Ads on the ironSource Mediation platform,Select ‘Static Interstitial Ads‘ and select ‘Create Campaign(s)‘:
      
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.
   
5. If interested in Chartboost’s Rewarded Video on Unity LevelPlay, 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‘:
   

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

1. Once you login, select ‘Dashboard‘ ➣ ‘Publishing‘ ➣ ‘Add App‘:
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’:
      
      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.
   
4. If interested in Chartboost’s Rewarded Video on Unity LevelPlay, 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‘:
   
5. If interested in Chartboost’s Rewarded Video on Unity LevelPlay, 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‘.
6. If you’re interested to use a Banner, you do not need to define Banner Publishing Campaign on the Chartboost Dashboard. The banner ads are delivered through Chartboost Exchange, and you only need to call on them via the SDK.

Step 3. Create a Chartboost Publishing Campaign

In order to serve Chartboost’s ad inventory in your app through Unity LevelPlay, 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.
   
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 Unity LevelPlay.
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 5 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:

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.

Retrive Chartboost’s Parameters from Chartboost Platform:

1. 1. App ID & App SignatureNavigate back to ‘Dashboard‘ ➣ ‘App Settings‘ ➣ ‘Basic Settings‘ and you fill the ‘App ID‘ and ‘App Signature‘ listed:
      
   2. User ID & User SignatureNavigate to ‘Tools‘ and select ‘API Explorer‘ from the drop-down:
      

Configure Chartboost’s Parameters into ironSource Account:

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

• Go to ‘Monetize‘ ➣ ‘Setup‘ ➣ ‘SDK networks‘ and click on ‘manage networks‘:
  
• Select Chartboost from the list of available Ad Networks and enter the Chartboost ‘User ID’ and ‘User Signature‘ in the relevant fields:
  
• Select the app which you’d like to run ironSource‘s Mediation on with Chartboost and click on the Setup button next to Chartboost network:
  
• Enter the Chartboost ‘App ID‘, ‘App Signature‘, and ‘location’ ‘User ID’ in the relevant fields:
  
• 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 SDK 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.

   repositories {
       mavenCentral()
       maven {
           url "https://android-sdk.is.com/"
       }
   }

2. Add the adapter’s Maven name to your build.gradle script of your app module.
   

   implementation 'com.ironsource.adapters:chartboostadapter:4.3.18'
   implementation 'com.chartboost:chartboost-sdk:9.8.2'
   

 Manual Download

1. Download the Chartboost Adapter and SDK:
   Add the Chartboost Adapter to your build. You can find the latest Chartboost files here.
   Important! The Chartboost Adapter does not contain the Chartboost SDK. You need to additionally add the Chartboost SDK directly.
2. Add the Chartboost Adapter to your project:
   After you download the Adapter; drop the ChartboostAdapter into the libs folder in your Android Project.
   
3. Make sure you add the following to your Gradle build file under the dependencies section:
   

   implementation 'com.ironsource.adapters:chartboostadapter:4.3.18'
   implementation 'com.chartboost:chartboost-sdk:9.8.2'
   

   
   

For Proguard Users Only
If you are using ProGuard with the Chartboost adapter, you must add the following code to your ProGuard configuration (Android Studio: proguard-rules.pro or Eclipse: proguard-project.txt):

-keep class com.chartboost.** { *; }

Step 6. Update AndroidManifest.xml

As of Chartboost Android adapter version 4.3.3+ (Android SDK Version 6.17.0), Chartboost adapter will be released as AAR. Only if you intend to keep your Jar integration, please add the manifest.

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" />

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"/>

Step 7. Chartboost Additional Settings

User-level COPPA

Chartboost requires that if an app is child directed, a value of true or false must be set to define proper behavior. ironSource’s mediation lets publishers communicate Chartboost User-level COPPA settings directly to the Chartboost network. This feature is enabled using ironSource SDK 7.2.4, Chartboost Android Adapter 4.3.9.

Use the following syntax, to set the Chartboost Chartboost_COPPA flag with the parameter True, and report that this is child directed:

IronSource.setMetaData("Chartboost_Coppa","true");

Use the following syntax, to set the Chartboost Chartboost_COPPA flag with the parameter False, to report this is not child directed:

IronSource.setMetaData("Chartboost_Coppa","false");

Learn more about Chartboost COPPA requirements here. 

Done!

You are now all set to deliver Chartboost Ads through Unity LevelPlay!