Integrating Chartboost with Mediation

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from Chartboost via mediation. It covers how to add Chartboost to an ad unit's mediation configuration, how to set up Automatic data collection, and how to integrate the Chartboost SDK and adapter into an Android app.

Supported ad formats and features

The Ad Manager mediation adapter for Chartboost has the following capabilities:

Formats
Banner
Interstitial
Rewarded
Native
Features
Adaptive banner
Automatic data collection

Requirements

• Android SDK 5.0 (API level 21) or higher

• Latest Google Mobile Ads SDK

Step 1: Set up Chartboost

Sign up for a Chartboost account and log in once your account is verified. Click the + APP button on the left sidebar. Fill out the form and click Save to add your app to Chartboost.

Then, in your Chartboost dashboard for your app, navigate to App Settings > Basic Settings to locate your App ID and App Signature.

Ad Manager requires the Chartboost User ID and User Signature for setting up your Ad Manager ad unit ID. You can find these parameters on your Chartboost dashboard by navigating to Tools > API Explorer. Your User ID and User Signature are located under the Authentication section.

Step 2: Configure mediation settings for your Ad Manager ad unit

Sign in to your Ad Manager account. Navigate to Delivery > Yield groups and click the New yield group button.

Enter a unique Name for your yield group, set the Status to Active, select your Ad Format, and set the Inventory type to Mobile App. Under the Targeting > Inventory section, select the Ad Unit ID to which you want to add mediation.

Next, click the Add yield partner button.

If you already have a Yield partner for Chartboost, you can simply select it. Otherwise, select Create a new yield partner.

Select Chartboost as the Ad network and enter a unique Name. Enable Mediation and turn on Automatic data collection, and enter the User ID and User Signature obtained in the previous section. You don't need to enter a Username and Password. Click Save when done.

Once the Yield partner is selected, choose Mobile SDK mediation as the Integration type, Android as the Platform, and Active as the Status. Enter the App ID and the App Signature obtained in the previous section. Also, enter an Ad Location (e.g. "Game Over Screen") that uniquely identifies this placement in your app and a Default CPM value.

Chartboost Ad Locations (Named Locations) are simple names representing a place in your app where you want to show an ad. Ad Manager sends requests to the location specified in the settings. Once requests are sent, Chartboost will add the location to its dashboard for reporting purposes.

Note: Ad Manager is able to estimate CPMs for the top three Ad Locations in your Chartboost app. All other locations will be represented with a blended CPM.

In the Chartboost dashboard, your Ad Locations can be revealed in the Basic Settings page by clicking on Advanced Settings. Please see the Chartboost's Named Locations guide for more details.

Click Save at the bottom of the page when done.

Note: Automatic data collection takes a few days to gather data before it can accurately calculate a Dynamic CPM value for a mediation network. Once the eCPM can be calculated, it will be automatically updated on your behalf

Using rewarded ads

In the settings for your rewarded ad unit, provide values for the reward amount and reward type. Then, to ensure you provide the same reward to the user no matter which ad network is served, check the Override reward settings from third-party ad networks when using mediation box.

If you don't apply this setting, the Chartboost adapter passes back the reward specified in the Chartboost UI.

Step 3: Import the Chartboost SDK and adapter

Android Studio integration (recommended)

Add the following Maven repository and the implementation dependencies with the latest versions of the Chartboost SDK and adapter to your app-level build.gradle file:

repositories {
    google()
    mavenCentral()
}

...
dependencies {
    implementation 'com.google.android.gms:play-services-ads:20.5.0'
    implementation 'com.google.ads.mediation:chartboost:8.3.0.0'
}
...

Manual integration

1. Download the .aar file of the latest version of the Chartboost SDK from Maven Central, and add it to your project.

2. Navigate to the Chartboost adapter artifacts on Google's Maven Repository. Select the latest version, download the Chartboost adapter's .aar file, and add it to your project.

Step 4: Additional code required

Modify AndroidManifest

Other elements

Add the following attribute to each activity in the AndroidManifest.xml file that will be showing Chartboost ads and supports different orientations:

android:configChanges="keyboardHidden|orientation|screenSize"

Lifecycle events

Per Chartboost's recommendation, Add the following code to all of your activity's lifecycle events that will be showing Chartboost ads.

Java

import com.chartboost.sdk.Chartboost;
// ...

@Override
public void onBackPressed() {
    // If an interstitial is on screen, close it.
    if (Chartboost.onBackPressed()) {
        return;
    } else {
        super.onBackPressed();
    }
}

Kotlin

import com.chartboost.sdk.Chartboost
// ...

@Override
fun onBackPressed() {
    // If an interstitial is on screen, close it.
    if (Chartboost.onBackPressed())
        return
    else
        super.onBackPressed()
}

Step 5: Test your implementation

Test ads can be enabled for your app from Chartboost's dashboard under the App Settings > Basic Settings as shown below.

Once test mode is enabled, you can request ads using the ad unit ID created earlier and receive a Chartboost test ad.

Step 6: Prepare app for production

After you are able to receive Chartboost test ads, your app will be placed on Chartboost's Publisher App Review. Once your app is approved, you can then create your Publishing Campaign to configure your app for live Chartboost ads.

Navigate to Monetization > Publishing Campaigns from the left-side menu and click Add a Campaign (or + Add Campaign at the top right corner of your dashboard if you already have other campaigns) and choose Network Publishing when prompted.

Enter a Name for your publishing campaign, select the Placement Type, and select Google Play as the Platform. If your app has been approved by Chartboost, you'll be able to select your app and apply it to this campaign. Fill out the rest of the form and click Save to finish adding the campaign.

That's it! You now have a working mediation integration with Chartboost.

Optional steps

EU consent and GDPR

Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.

The section below shows you how to enable or disable personalized ads for Chartboost.

In SDK version 8.1.0, Chartboost added the addDataUseConsent() method. The following sample code sets data use consent to NON_BEHAVIORAL. If you choose to call this method, it is recommended that you do so prior to requesting ads via the Google Mobile Ads SDK.

Java

DataUseConsent dataUseConsent = new GDPR(GDPR.GDPR_CONSENT.NON_BEHAVIORAL);
Chartboost.addDataUseConsent(context, dataUseConsent);

Kotlin

val dataUseConsent = GDPR(GDPR.GDPR_CONSENT.NON_BEHAVIORAL)
Chartboost.addDataUseConsent(context, dataUseConsent)

See Chartboost's GDPR article for more details.

Permissions

For optimal performance, Chartboost recommends adding the following optional permissions to your app's AndroidManifest.xml file:

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

Using interstitial and rewarded ads

Network-specific parameters

The Chartboost adapter supports an additional request parameter for interstitial and rewarded ads which can be passed to the adapter using the ChartboostExtrasBundleBuilder class. The ChartboostExtrasBundleBuilder includes the following method:

• setFramework(CBFramework, versionString) - Sets the framework info the app uses which allows Chartboost SDK to customize your requests for a specific framework.

Here's a code example of how to set these ad request parameters:

Java

Bundle bundle = new ChartboostAdapter.ChartboostExtrasBundleBuilder()
          .setFramework(CBFramework.CBFrameworkOther, "1.2.3")
          .build();
AdManagerAdRequest adRequest = new AdManagerAdRequest.Builder()
          .addNetworkExtrasBundle(ChartboostAdapter.class, bundle)
          .build();
adLoader.loadAd(adRequest);

Kotlin

val bundle = ChartboostAdapter.ChartboostExtrasBundleBuilder()
         .setFramework(CBFramework.CBFrameworkOther, "1.2.3")
         .build()
val adRequest = AdManagerAdRequest.Builder()
         .addNetworkExtrasBundle(ChartboostAdapter::class.java, bundle)
         .build()
adLoader.loadAd(adRequest)

Error codes

If the adapter fails to receive an ad from Chartboost, publishers can check the underlying error from the ad response using ResponseInfo.getAdapterResponse() under the following classes:

com.google.ads.mediation.chartboost.ChartboostAdapter
com.google.ads.mediation.chartboost.ChartboostMediationAdapter

Here are the codes and accompanying messages thrown by the Chartboost adapter when an ad fails to load:

Error code	Reason
0-99	Chartboost SDK returned an error. See code for more details.
101	The requested ad size does not match a Chartboost supported banner size.
102	Chartboost can only load 1 ad per location at a time.
103	Chartboost server parameters configured in the Ad Manager UI are missing/invalid.

Additional resources

• Start a Publishing Campaign provides additional details on how to set up Chartboost publishing campaigns.

Chartboost Android Mediation Adapter Changelog

Version 8.3.1.0 (In Progress)

• Verified compatibility with Chartboost SDK 8.3.1.
• Updated the adapter to use new AdError API.

Built and tested with:

• Google Mobile Ads SDK version 20.5.0.
• Chartboost SDK version 8.3.1.

Version 8.3.0.0

• Verified compatibility with Chartboost SDK 8.3.0.
• Updated the minimum required Google Mobile Ads SDK version to 20.5.0.

Built and tested with:

• Google Mobile Ads SDK version 20.5.0.
• Chartboost SDK version 8.3.0.

Version 8.2.1.0

• Verified compatibility with Chartboost SDK 8.2.1.
• Updated the minimum required Google Mobile Ads SDK version to 20.1.0.

Built and tested with:

• Google Mobile Ads SDK version 20.1.0.
• Chartboost SDK version 8.2.1.

Version 8.2.0.1

• Updated the minimum required Google Mobile Ads SDK version to 20.0.0.

Built and tested with:

• Google Mobile Ads SDK version 20.0.0.
• Chartboost SDK version 8.2.0.

Version 8.2.0.0

• Verified compatibility with Chartboost SDK 8.2.0.
• Updated the minimum required Google Mobile Ads SDK version to 19.5.0.

Built and tested with:

• Google Mobile Ads SDK version 19.5.0.
• Chartboost SDK version 8.2.0.

Version 8.1.0.0

• Verified compatibility with Chartboost SDK 8.1.0.

Built and tested with:

• Google Mobile Ads SDK version 19.2.0.
• Chartboost SDK version 8.1.0.

Version 8.0.3.2

• Added descriptive error codes and reasons for adapter load/show failures.
• Updated the minimum required Google Mobile Ads SDK version to 19.2.0.

Built and tested with:

• Google Mobile Ads SDK version 19.2.0.
• Chartboost SDK version 8.0.3.

Version 8.0.3.1

• Added support for Chartboost banner ads.

Built and tested with:

• Google Mobile Ads SDK version 19.1.0.
• Chartboost SDK version 8.0.3.

Version 8.0.3.0

• Verified compatibility with Chartboost SDK 8.0.3.
• Updated the minimum required Google Mobile Ads SDK version to 19.1.0.

Built and tested with:

• Google Mobile Ads SDK version 19.1.0.
• Chartboost SDK version 8.0.3.

Version 8.0.2.0

• Verified compatibility with Chartboost SDK 8.0.2.
• Updated the minimum required Google Mobile Ads SDK version to 19.0.1.

Built and tested with:

• Google Mobile Ads SDK version 19.0.1.
• Chartboost SDK version 8.0.2.

Version 8.0.1.0

• Verified compatibility with Chartboost SDK 8.0.1.
• Requires Chartboost SDK 8.0.1 or higher.
• Activity context is no longer required to load ads.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Chartboost SDK version 8.0.1.

Version 7.5.0.1

• Fixed a bug where Chartboost adapter failed to invoke ad events.
• Updated the minimum required Google Mobile Ads SDK version to 18.3.0.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Chartboost SDK version 7.5.0.

Version 7.5.0.0

• Verified compatibility with Chartboost SDK 7.5.0.
• Migrated the adapter to use AndroidX dependencies.
• Updated the minimum required Google Mobile Ads SDK version to 18.1.1.

Version 7.3.1.1

• Updated adapter to support new open-beta Rewarded API.
• Updated the minimum required Google Mobile Ads SDK version to 17.2.0.

Version 7.3.1.0

• Verified compatibility with Chartboost SDK 7.3.1.

Version 7.3.0.0

• Verified compatibility with Chartboost SDK 7.3.0.

Version 7.2.1.0

• Verified compatibility with Chartboost SDK 7.2.1.

Version 7.2.0.1

• Updated the adapter to invoke the onRewardedVideoComplete() ad event.

Version 7.2.0.0

• Verified compatibility with Chartboost SDK 7.2.0.

Version 7.1.0.0

• Verified compatibility with Chartboost SDK 7.1.0.

Version 7.0.1.0

• Verified compatibility with Chartboost SDK 7.0.1.
• Added support for new Chartboost error codes.
• Updated the Adapter project for Android Studio 3.0

Version 7.0.0.0

• Updated the adapter to make it compatible with Chartboost SDK 7.0.0.

Version 6.6.3.0

• Verified compatibility with Chartboost SDK 6.6.3.

Version 6.6.2.0

• Verified compatibility with Chartboost SDK 6.6.2.

Version 6.6.1.0

• Verified compatibility with Chartboost SDK 6.6.1.

Version 6.6.0.0

• Changed the version naming system to [Chartboost SDK version].[adapter patch version].
• The adapters can now be added as a compile dependency by adding the following to the build.gradle file's dependencies tag: compile 'com.google.ads.mediation:chartboost:6.6.0.0'
• Moved to distributing the adapter as an aar instead of a jar file (see README for additional instructions).

Version 1.1.0

• Removed Chartboost Ad Location from Chartboost extras. Ad Location is now specified in the AdMob console when configuring Chartboost for mediation.

Version 1.0.0

• Initial release. Supports reward-based video ads and interstitial ads.