Chartboost integration
Integrate Chartboost with Unity LevelPlay on iOS. This guide covers account setup, app configuration, ad location creation, campaign setup, parameter retrieval, activation in Unity Dashboard, adapter integration, and COPPA configuration.
읽는 시간 3분최근 업데이트: 2일 전
This guide explains how to integrate Chartboost with Unity LevelPlay on iOS. It covers the full process from account setup to integrating the Chartboost adapter and SDK into your project.
Topic | Description |
|---|---|
| Create and set up your account | Sign up to Chartboost and complete account, payment, notification, and user settings. |
| Add your app to the dashboard | Register each app in the Chartboost dashboard and configure formats and COPPA status. |
| Create ad location | Define bidding ad locations per format to control where Chartboost ads serve in your app. |
| Create a campaign | Set up publishing campaigns for rewarded and interstitial ads with your desired targeting. |
| Retrieve required parameters | Collect App ID, App Signature, User ID, User Signature, and Location IDs for LevelPlay setup. |
| Activate Chartboost | Enter Chartboost credentials in the Unity Dashboard and verify reporting API connectivity. |
| Add the Chartboost adapter | Integrate the Chartboost adapter and SDK into your iOS project via CocoaPods or manual setup. |
| Configure COPPA behavior | Set Chartboost COPPA metadata to match your app's child-directed status. |
Prerequisites
Before activating Chartboost in Unity LevelPlay, ensure that you meet the following prerequisites for your app and project:- Your app integrates Rewarded Video, Interstitial, or Banner ads.
- Your project includes the LevelPlay SDK.
- Your app is compatible with iOS 11 or newer.
Create and set up your Chartboost account
Create and configure your Chartboost account so you can add your app, set payment details, and prepare ad locations for mediation with Unity LevelPlay.- Sign up for a Chartboost account.
- Create and verify your Chartboost account through email verification.
- Sign in to the Chartboost Dashboard and set up your account by following these steps:
- Adding payment details - ensure that Chartboost knows where to send your earnings.
- Configuring notification settings.
- Adding additional users as needed.
Add your app in the Chartboost dashboard
Register your app in the Chartboost dashboard to start configuring SDK integration and campaign settings. If this is your first time using Chartboost, follow the steps in First-time setup. Otherwise, skip ahead to Adding an app as a registered Chartboost user. Note: You must create a unique Chartboost app entry for each platform you support.First-time setup
When you log in to the Chartboost Dashboard for the first time:- Select Start making money!
- Chartboost attempts to detect your live apps automatically. If your app is not detected, choose one of the following:
- Search your company manually
- Add your app manually (if your apps are not yet published)
- Select the app you want to add, then select Add Selected.
- Select the ad types you want to serve (Rewarded Video Ads / Static Interstitial Ads), then select Create Campaign.
Adding an app as a registered Chartboost user
If you already have a Chartboost account and you're adding a new app:- Go to Dashboard > Publishing > Add App.
- Enter the app details:
- Platform: Select the operating system your app runs on (iOS or Android).
- App nickname: Enter a display name to identify the app in the dashboard.
- Orientation: Choose the default screen orientation your app supports.
- Test mode settings: Enable test mode to serve test ads during setup and QA.
- Save the app to retrieve the App ID and App Signature.
Disable pre/post-roll messaging for rewarded video
If you serve Chartboost rewarded video through LevelPlay, disable Chartboost's pre-roll and post-roll messaging:- In the Chartboost dashboard, open your app.
- Go to Basic Settings > Rewarded Video > Advanced.
- Uncheck both pre-roll and post-roll messaging options.
- Select Save.
Create ad locations
Ad locations define where and when Chartboost shows ads in your app. You create and manage ad locations in the Chartboost Dashboard, and you can add up to 100 unique location names per app and location type. For detailed steps on creating and managing ad locations, refer to the Chartboost Ad Locations documentation. Ad location names are case-sensitive and must follow these rules:- Maximum of 80 characters
- Upper or lower case letters allowed
- Numbers 0–9 allowed
- Allowed special characters:
$ & - _ , + / \ - Spaces are not allowed
Create a Chartboost publishing campaign
For interstitial and rewarded ads, create a publishing campaign in the Chartboost Dashboard:- In the Chartboost Dashboard, select Add a Campaign > Network Publishing.
- Choose Rewarded Video or Static Interstitial.
- Create separate campaigns if you serve both formats.
- Configure targeting as needed (for example, geo, device, or user targeting).
- Save the campaign. Note that it can take up to 20 minutes to go live.
Retrieve required parameters
Unity LevelPlay requires the following Chartboost parameters to allow Unity LevelPlay to send ad requests to Chartboost and import reporting data:- App ID
- App Signature
- Location ID
- User ID
- User Signature
Where to find these parameters
Use the following dashboard paths to locate each parameter:- App ID and App Signature: Dashboard > App Settings > Basic Settings
- User ID and User Signature: Tools > API Explorer
Activate Chartboost in the Unity dashboard
After you configure your app and campaigns in Chartboost and retrieve the required parameters, activate Chartboost in Unity LevelPlay:- Sign in to the Unity Dashboard.
- Go to Grow > LevelPlay > Setup > SDK Networks.
- From the list of networks, select Chartboost.
- Enter User ID and User Signature.
- Select your app then select Setup.
- Enter the App ID, App Signature, and Location ID (location identifier) for each relevant ad unit.
- Run Reporting API verification. If it fails, update any incorrect values and retry until the status shows Verified.
Add the Chartboost adapter to your iOS project
To integrate the Chartboost SDK with Unity LevelPlay in your iOS app, you can add the Chartboost adapter to your project using CocoaPods or install it manually.Using CocoaPods
To add the Chartboost adapter using CocoaPods:- Open your Podfile.
-
Add the following line of code:
pod 'IronSourceChartboostAdapter', '4.3.23.0'
-
Run to install the adapter.
pod install
Manual installation
Use the following steps to manually install and configure the Chartboost SDK.- Download the Chartboost Adapter and Chartboost SDK. Important: The Chartboost adapter does not include the Chartboost SDK. Download and add the Chartboost SDK to your project as well.
- Add both the Chartboost Adapter and SDK to your Xcode project.
-
In your Xcode build settings, ensure:
- The Base SDK is set to iOS 7.0 or later.
- The armv6 architecture is not included.
Verify your ad network integration
Use the LevelPlay Integration Helper to verify that the Unity LevelPlay SDK, the Chartboost SDK, and the Chartboost adapter are integrated correctly. In development builds, enable the adapter debug logs by calling the following method before initializing the Unity LevelPlay SDK:Note: Adapter debug logs are supported for SDK versions 6.5.2 and up. Before releasing your app, remove this call.[IronSource setAdaptersDebug:YES];
Configure Chartboost COPPA behavior
Chartboost requires you to indicate whether your app is child-directed. User-level COPPA support requires ironSource SDK 7.3.0 and Chartboost iOS adapter 4.3.14 or later. In your app's code, before you initialize the Unity LevelPlay SDK, configure whether your app is child-directed for Chartboost by setting theCHARTBOOST_COPPANot child-directed:[IronSource setMetaDataWithKey:@"CHARTBOOST_COPPA" value:@"YES"];
You must also specify COPPA settings when you add the app in the Chartboost Dashboard. Ensure that your in-app metadata and Chartboost dashboard settings are consistent with your app's actual audience. For more details, refer to Chartboost's COPPA documentation.[IronSource setMetaDataWithKey:@"CHARTBOOST_COPPA" value:@"NO"];