Cómo integrar Chartboost con la mediación

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 AdMob mediation adapter for Chartboost has the following capabilities:

Integration
Bidding
Waterfall
Formats
Banner
Interstitial
Rewarded
Native

Requirements

• iOS deployment target of 11.0 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.

AdMob requires the Chartboost User ID and User Signature for setting up your AdMob 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 AdMob ad unit

You need to add Chartboost to the mediation configuration for your ad unit. First sign in to your AdMob account.

Next, navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add Chartboost as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units, which will open up the ad unit selection overlay.

Associate this mediation group with your existing AdMob ad unit. Then click Done.

You should now see the ad units card populated with the ad units you selected.

Add Chartboost as an ad source

In the Ad Sources card, select Add Ad Network. Then select Chartboost.

Enable the Optimize switch. Enter your User ID and User Signature obtained in the previous section to set up ad source optimization for Chartboost. Then enter an eCPM value for Chartboost and click Continue.

Note: You only need to set up ad source optimization once per network.

If you already have a mapping for Chartboost, you can simply select it. Otherwise, click Add mapping.

Next, enter a Mapping Name, 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. Then click Done.

Chartboost Ad Locations (Named Locations) are simple names representing a place in your app where you want to show an ad. AdMob 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: AdMob 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.

Finally, click Done to add Chartboost as an ad source, and then click Save.

Note: Ad source optimization takes a few days to gather data to accurately calculate eCPM for a mediation network. In the meantime, the ad source optimization status will be PENDING, so you must manually set an eCPM value for the network. Once the eCPM can be calculated, ad source optimization will automatically start updating the eCPM 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 Apply to all networks in Mediation groups box.

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

For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the Chartboost SDK and adapter

Using CocoaPods (recommended)

• 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: Additional code required

Project settings

Set Allow Non-modular Includes in Framework Modules to YES under Build Settings of your target.

Add value -ObjC in Other Linker Flags under your project’s Build Settings for both Debug and Release.

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 iOS 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

Important: Please verify you have Account Management permission to complete configuration for EU Consent and GDPR, CCPA, and User Messaging Platform. To learn more please see the following new user roles article.

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.

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.

Add Chartboost to GDPR ad partners list

Follow the steps in GDPR settings to add Chartboost to the GDPR ad partners list in the AdMob UI.

CCPA

The California Consumer Privacy Act (CCPA) requires giving California state residents 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 CCPA preparation 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 with CCPA.

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 AdMob 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.

Additional resources

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

Chartboost iOS Mediation Adapter Changelog

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.