Integrate Chartboost with Mediation

This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Chartboost using mediation, covering waterfall integrations. It covers how to add Chartboost to an ad unit's mediation configuration, and how to integrate the Chartboost SDK and adapter into an iOS app.

Supported integrations and ad formats

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

Integration
Bidding
Waterfall
Formats
Banner
Interstitial
Rewarded
Native

Requirements

  • iOS deployment target of 12.0 or higher

Step 1: Set up configurations in Chartboost UI

Sign up for a Chartboost account and log in once your account is verified. Then, navigate to the Apps management tab.

Chartboost apps dashboard

Click the Add new app button to create your app.

Apps Management

Fill out the rest of the form and click the Add App button to finalize your app.

New app form

After your app is created, you will be directed to its dashboard. Take note of the App ID and App Signature of your app.

App settings

Ad Manager requires the Chartboost User ID and User Signature for setting up your Ad Manager ad unit ID. You can find these parameters by clicking Chartboost mediation on the Chartboost UI.

Chartboost mediation dashboard

Navigate to the Resources > API Explorer tab and take note of your User ID and User Signature located under the Authentication section.

Chartboost api explorer

Turn on test mode

You can enable test mode on your app by navigating to the Apps management tab from the Chartboost UI, selecting your app from the list and clicking on Edit app settings.

Edit app settings

From your app's settings, you can toggle Test mode on your app.

Chartboost test mode

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

After you are able to receive Chartboost test ads, your app will be placed on Chartboost's Publisher App Review. In order for monetization on Chartboost to work, the publisher app review will need to be approved by Chartboost.

Step 2: Set up Chartboost demand in Ad Manager UI

Configure mediation settings for your 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 under Inventory and Mobile application 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 select it. Otherwise, select Create a new yield partner.

Select Chartboost as the Ad network, enter a unique Name and enable Mediation.

Turn on Automatic data collection, and enter the User ID and User Signature obtained in the previous section.

Once the Yield partner is selected, choose Mobile SDK Mediation as the Integration type, iOS as the Platform, and Active as the Status. Enter the App ID, App Signature and Ad Location obtained in the previous section. Then, enter 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 UI for reporting purposes.

In the Chartboost UI, your Ad Locations can be revealed in the Basic Settings page by clicking on Advanced Settings. See the Chartboost Named Locations guide for more details.

Click Save at the bottom of the page when done.

Add Chartboost to GDPR and US state regulations ad partners list

Follow the steps in GDPR settings and US state regulations settings to add Chartboost to the GDPR and US state regulations ad partners list in the Ad Manager UI.

Step 3: Import the Chartboost SDK and adapter

  • Add the following line to your project's Podfile:

    pod 'GoogleMobileAdsMediationChartboost'
    
  • From the command line run:

    pod install --repo-update
    

Manual integration

  • Download the latest version of the Chartboost SDK, and link Chartboost.framework and CHAMoatMobileAppKit.framework in your project.

  • Download the latest version of the Chartboost adapter from the download link in Changelog and link ChartboostAdapter.framework in your project.

  • Add the following frameworks to your project:

    • StoreKit
    • Foundation
    • CoreGraphics
    • WebKit
    • AVFoundation
    • UIKit

Step 4: Implement privacy settings on Chartboost SDK

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.

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

Swift

let dataUseConsent = CHBDataUseConsent.GDPR(CHBDataUseConsent.GDPR.Consent.nonBehavioral)
Chartboost.addDataUseConsent(dataUseConsent)

Objective-C

CHBGDPRDataUseConsent *dataUseConsent = [CHBGDPRDataUseConsent gdprConsent:CHBGDPRConsentNonBehavioral];
[Chartboost addDataUseConsent:dataUseConsent];

See Chartboost's GDPR article and their iOS Privacy Methods for more details and the values that can be provided in each method.

US states privacy laws

U.S. states privacy laws require giving users the right to opt out of the "sale" of their "personal information" (as the law defines those terms), with the opt-out offered via a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The U.S. states privacy laws compliance guide offers the ability to enable restricted data processing for Google ad serving, but Google is unable to apply this setting to each ad network in your mediation chain. Therefore, you must identify each ad network in your mediation chain that may participate in the sale of personal information and follow guidance from each of those networks to ensure compliance.

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

Swift

let dataUseConsent = CHBDataUseConsent.CCPA(CHBDataUseConsent.CCPA.Consent.optInSale)
Chartboost.addDataUseConsent(dataUseConsent)

Objective-C

CHBCCPADataUseConsent *dataUseConsent = [CHBCCPADataUseConsent ccpaConsent:CHBCCPAConsentOptInSale];
[Chartboost addDataUseConsent:dataUseConsent];

See Chartboost's CCPA article and their iOS Privacy Methods for more details and the values that can be provided in each method.

Error codes

If the adapter fails to receive an ad from Chartboost, you can check the underlying error from the ad response using GADResponseInfo.adNetworkInfoArray under the following classes:

GADMAdapterChartboost
GADMediationAdapterChartboost

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

Error code Reason
101 Chartboost server parameters configured in the Ad Manager UI are missing/invalid.
102 The Chartboost SDK returned an initialization error.
103 The Chartboost ad is not cached at show time.
104 The requested ad size does not match a Chartboost supported banner size.
105 Device's OS version is lower than Chartboost SDK's minimum supported OS version.
200-299 Chartboost SDK cache errors. See code for more details.
300-399 Chartboost SDK show errors. See code for more details.
400-499 Chartboost SDK click errors. See code for more details.

Chartboost iOS Mediation Adapter Changelog

Next version

  • Now requires minimum iOS version 12.0.
  • Now requires Google Mobile Ads SDK version 11.0 or higher.
  • Included Info.plist in the frameworks in ChartboostAdapter.xcframework.

Version 9.6.0.0

  • Verified compatibility with Chartboost SDK version 9.6.0.
  • Replaced the deprecated method GADMobileAds.sharedInstance.sdkVersion with GADMobileAds.sharedInstance.versionNumber.
  • Added GADMediationInterstitialAd implementation.

Built and tested with:

  • Google Mobile Ads SDK version 10.14.0.
  • Chartboost SDK version 9.6.0.

Version 9.5.1.0

  • Verified compatibility with Chartboost SDK version 9.5.1.

Built and tested with:

  • Google Mobile Ads SDK version 10.12.0.
  • Chartboost SDK version 9.5.1.

Version 9.4.0.0

  • Verified compatibility with Chartboost SDK version 9.4.0.

Built and tested with:

  • Google Mobile Ads SDK version 10.7.0.
  • Chartboost SDK version 9.4.0.

Version 9.3.1.0

  • Verified compatibility with Chartboost SDK version 9.3.1.

Built and tested with:

  • Google Mobile Ads SDK version 10.7.0.
  • Chartboost SDK version 9.3.1.

Version 9.3.0.0

  • Verified compatibility with Chartboost SDK version 9.3.0.
  • Now requires minimum iOS version 11.0.
  • Now requires Google Mobile Ads SDK version 10.4.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 10.4.0.
  • Chartboost SDK version 9.3.0.

Version 9.2.0.0

  • Removed GADMChartboostExtras import in ChartboostAdapter header file.
  • Verified compatibility with Chartboost SDK version 9.2.0.
  • Now requires Google Mobile Ads SDK version 10.0.0 or higher.
  • Removed support for the armv7 architecture.
  • Now requires minimum iOS version of 11.0.

Built and tested with:

  • Google Mobile Ads SDK version 10.0.0.
  • Chartboost SDK version 9.2.0.

Version 9.1.0.0

  • Verified compatibility with Chartboost SDK version 9.1.0.

Built and tested with:

  • Google Mobile Ads SDK version 9.11.0.
  • Chartboost SDK version 9.1.0.

Version 9.0.0.0

  • Verified compatibility with Chartboost SDK version 9.0.0.
  • Verified compatibility with Google Mobile Ads SDK version 9.10.0.
  • Updated the adapter to use the didRewardUser API.
  • Now requires Google Mobile Ads SDK version 9.8.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 9.10.0.
  • Chartboost SDK version 9.0.0.

Version 8.5.0.2

  • Verified compatibility with Google Mobile Ads SDK version 9.0.0.
  • Now requires Google Mobile Ads SDK version 9.0.0 or higher.

Built and tested with:

  • Google Mobile Ads SDK version 9.0.0.
  • Chartboost SDK version 8.5.0.

Version 8.5.0.1.0

  • Verified compatibility with Chartboost SDK 8.5.0 that refers to version 8.5.0.1 in CocoaPods.

Built and tested with

  • Google Mobile Ads SDK version 8.13.0.
  • Chartboost SDK version 8.5.0.

Version 8.5.0.0

  • Verified compatibility with Chartboost SDK 8.5.0.

Built and tested with

  • Google Mobile Ads SDK version 8.12.0.
  • Chartboost SDK version 8.5.0.

Version 8.4.2.0

  • Verified compatibility with Chartboost SDK 8.4.2.

Built and tested with

  • Google Mobile Ads SDK version 8.6.0.
  • Chartboost SDK version 8.4.2.

Version 8.4.1.1

  • Relaxed dependency to Google Mobile Ads SDK version 8.0.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 8.4.0.
  • Chartboost SDK version 8.4.1.

Version 8.4.1.0

  • Verified compatibility with Chartboost SDK 8.4.1.
  • Now requires Google Mobile Ads SDK version 8.1.0 or higher.

Built and tested with

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

Version 8.4.0.1

  • Added standardized adapter error codes and messages.
  • Updated the adapter to use the .xcframework format.
  • Now requires Google Mobile Ads SDK version 8.0.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 8.0.0.
  • Chartboost SDK version 8.4.0.

Version 8.4.0.0

  • Verified compatibility with Chartboost SDK 8.4.0.
  • Now requires Google Mobile Ads SDK version 7.68.0 or higher.

Built and tested with

  • Google Mobile Ads SDK version 7.68.0.
  • Chartboost SDK version 8.4.0.

Version 8.3.1.0

  • Verified compatibility with Chartboost SDK 8.3.1.
  • Now requires Google Mobile Ads SDK version 7.66.0 or higher.
  • Now requires minimum iOS version of 10.0.
  • Updated the adapter to support adaptive banner requests.

Built and tested with

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

Version 8.2.1.0

  • Verified compatibility with Chartboost SDK 8.2.1.
  • Now requires Google Mobile Ads SDK version 7.64.0 or higher.
  • Now requires minimum iOS version of 9.0.

Built and tested with

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

Version 8.2.0.0

  • Verified compatibility with Chartboost SDK 8.2.0.
  • Now requires Google Mobile Ads SDK version 7.61.0 or higher.

Built and tested with

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

Version 8.1.0.1

  • Updated the minimum required Google Mobile Ads SDK version to 7.60.0.
  • Updated the adapter to use Chartboost's new API and removed deprecated APIs.
  • Adapter now supports loading multiple ads of the same format using the same Chartboost location.
  • If the reward is not overridden in the AdMob or Ad Manager UI, the reward value for rewarded ads is now the value specified in the Chartboost UI instead of 0.

Built and tested with

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

Version 8.1.0.0

  • Verified compatibility with Chartboost SDK 8.1.0.
  • Updated the minimum required Google Mobile Ads SDK version to 7.59.0.
  • Removed support for the i386 architecture.

Built and tested with

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

Version 8.0.4.0

  • Verified compatibility with Chartboost SDK 8.0.4.

Built and tested with

  • Google Mobile Ads SDK version 7.52.0.
  • Chartboost SDK version 8.0.4.

Version 8.0.1.1

  • Fixed an issue where requesting banner ads returns no fills.

Version 8.0.1.0

  • Verified compatibility with Chartboost SDK 8.0.1.
  • Added support to request banner ads.

Version 7.5.0.1

  • Added code to correctly initialize the Chartboost SDK.

Version 7.5.0.0

  • Verified compatibility with Chartboost SDK 7.5.0.
  • Updated the adapter to use the new rewarded API.
  • Updated the adapter to handle multiple interstitial requests.
  • Now requires Google Mobile Ads SDK version 7.42.2 or higher.

Version 7.3.0.0

  • Verified compatibility with Chartboost SDK 7.3.0.

Version 7.2.0.1

  • Added adapterDidCompletePlayingRewardBasedVideoAd: callback to the adapter.

Version 7.2.0.0

  • Verified compatibility with Chartboost SDK 7.2.0.

Version 7.1.2.0

  • Verified compatibility with Chartboost SDK 7.1.2.

Version 7.1.1.0

  • Verified compatibility with Chartboost SDK 7.1.1.

Version 7.1.0.0

  • Verified compatibility with Chartboost SDK 7.1.0.

Version 7.0.4.0

  • Verified compatibility with Chartboost SDK 7.0.4.

Version 7.0.3.0

  • Verified compatibility with Chartboost SDK 7.0.3.

Version 7.0.2.0

  • Verified compatibility with Chartboost SDK 7.0.2.
  • Added support for two new Chartboost error codes.

Version 7.0.1.0

  • Verified compatibility with Chartboost SDK 7.0.1.

Version 7.0.0.0

  • Verified compatibility with Chartboost SDK 7.0.0.

Version 6.6.3.0

  • Verified compatibility with Chartboost SDK 6.6.3.
  • Removed the support for 'armv7s' architecture.
  • Fixed a bug where publishers faced a compilation issue in Swift when importing ChartboostAdapter.framework as a module which was importing non-modular Chartboost SDK.

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

  • Verified compatibility with Chartboost SDK 6.6.0.

Version 6.5.2.1

  • Enabled bitcode support.
  • Now distributing Chartboost adapter as a framework.
  • To import ChartboostAdapter.framework in your project, make sure to set Allow Non-modular Includes in Framework Modules to YES under Build Settings of your target.

Version 6.5.2.0

  • Changed the version naming system to [Chartboost SDK version].[adapter patch version].
  • Updated the minimum required Chartboost SDK to v6.5.1.
  • Updated the minimum required Google Mobile Ads SDK to v7.10.1.
  • Fixed a bug to support multiple Chartboost ad locations.
  • Apps now get the interstitialWillDismissScreen: callback when the interstitial ad is about to dismiss.
  • Apps now get the rewardBasedVideoAdDidOpen: callback when a reward-based video ad is opened.

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.