- Before you begin
- Add Chartboost repository and dependencies to your Gradle file
- Adding the Google Play Services library
- Adding to Android Manifest
- Supporting orientation changes
- Importing Chartboost SDK
- Initializing Chartboost SDK
- Adding your app ID and app signature
- Showing a static or video interstitial ad
- Showing a rewarded video ad
- Showing a banner ad
- Using ProGuard
- Testing your integration
- Checking the SDK icon in the dashboard
- More SDK features
- Overriding activity lifecycle methods
![]() |
Before you begin: |
- Have you signed up for a Chartboost account?
- Did you add an app to your dashboard?
- Amazon integration uses the same SDK as Android. These integration instructions apply to games for Google Play or the Amazon App Store.
- Chartboost Sample App is available here.
- If your game is built in Unity, we strongly recommend using our Unity plugin for Android. If you prefer to use the Android SDK with your own Unity adapter, use this method to make sure ads show up within your game.
Publishers should call the
addDataUseConsent
API from the Chartboost SDK and pass in the appropriate value for whether consent exists, does not exist, or is unknown. Publishers are required as part of Terms of Service to obtain the consent from their users before Chartboost will process any personal data and pass it to the Chartboost SDK via the above method. This method should be called before startWithAppId
.Learn more about privacy methods here.
![]() |
Requirements and Optional Permissions |
- The Chartboost SDK requires API level 21 (Android OS 5) or higher.
- The Chartboost Android SDK requires the use of AndroidX.
- Required permission:
android.permission.INTERNET
- Required permission:
android.permission.ACCESS_NETWORK_STATE
- Optional (but recommended) permission:
android.permission.READ_PHONE_STATE
Allows the SDK to handle calls that interrupt video playback.
![]() |
Add Chartboost repository and dependencies to your Gradle file. |
- To integrate Chartboost, add this code to your Android Gradle file:
![]() |
Add the Google Play Services Library as a dependency of your project. When you use our latest SDK, you will need “play-services-base” and “play-services-ads-identifier”. |
- The Google Play Services library has its own set of integration instructions, including additions to your Android Manifest and ProGuard configuration.
- Follow these setup instructions from Google.
- After following Google’s instructions to integrate the Play Services Library you should find something similar to the following two lines in your build.gradle file:
![]() |
Add the following entry in your AndroidManifest.xml file. |
For complex integrations that don’t include
CBImpressionActivity
, any activities that show Chartboost ads must have the value android:hardwareAccelerated="true"
in their activity entry on the Android Manifest, or video might not display properly.![]() |
If you display Chartboost ads in any activity that supports different orientations, add the following attribute to those activities in AndroidManifest.xml. |
This helps smoothen video playback during orientation changes.
![]() |
Import the Chartboost SDK into any activity that uses Chartboost. |
- If you’re using additional SDK features, you’ll want to import these activities:
![]() |
Initialize Chartboost SDK |
startWithAppId
doesn’t require Activity anymore. From version 8.0.1+ context should be passed instead.
PRO TIP: Watch for an
Exception: Initialization error
message. This indicates that the SDK was not initialized properly.PRO TIP: If you’re using the Android SDK with your own Unity adapter, you must report Unity as the framework immediately after
startWithAppId
using the method Chartboost.setFramework(CBFramework.CBFrameworkUnity, unityVersion);
. Replace unityVersion
with the value returned by this Unity function.startWithAppId
must always be called during hard and soft bootups within the first few seconds of your app launching, regardless of any other actions or user interaction within your app.Publishers should call the
addDataUseConsent
API from the Chartboost SDK and pass in the appropriate value for whether consent exists, does not exist, or is unknown. Publishers are required as part of Terms of Service to obtain the consent from their users before Chartboost will process any personal data and pass it to the Chartboost SDK via the above method. This method should be called before startWithAppId
.![]() |
Add your app ID and app signature. |
- Replace
appID
andappSignature
with your app ID and app signature. - Where can I find my app ID and app signature?
Chartboost App ID is a unique App identifier in our systems, therefore it is required to use a different Chartboost App ID per each app.
![]() |
To show a static or video interstitial ad: |
- You can use the
CBLocation
interface class to get a list of default location constants as well as define your own. Once a location is used, it will be added to your dashboard, where you can customize its settings. - For customized control over how ads behave in your game, the Chartboost SDK also offers more features such as caching, delegate methods, and named locations.
- Learn more about Chartboost video ads ▶
Do not call
showInterstitial
directly after cacheInterstitial
for the same location, or the SDK will fail silently.We strongly recommend that you cache your interstitials before showing them. Learn more about caching ▶
Prefetched videos (in total) only take up 30-50MB, even when you are using mediation.
![]() |
To show a rewarded video ad: |
- For customized control over how ads behave in your game, the Chartboost SDK also offers more features such as caching, delegate methods, and named locations.
- Learn more about Chartboost video ads ▶
We strongly recommend that you cache your interstitials before showing them. Learn more about caching ▶
Prefetched videos (in total) only take up 30-50MB, even when you are using mediation.
![]() |
To show a banner ad: |
Banner ads are not supported for Amazon integrations.
To make the banner ad show, first create it (detailed here), and then call the delegate method.
By default, a banner will automatically update its content on its own. The refresh default rate is 30s.
Banners by auto-cache after shown if
setAutomaticallyRefreshesContent
is set to true
. Otherwise, you can change the value of setAutomaticallyRefreshesContent
to false
to not automatically cache banner ads.![]() |
If you’re using ProGuard, add the following to your proguard-rules.pro: |