DashboardPartnersMediation SDKMonetization SDKPublisher APIsSupport
Contact Us

Get Started on Android

Suggest Edits

Before You Begin

  1. Create and set up your Chartboost account.
  2. Download and review the Chartboost Sample App

Amazon integration uses the same SDK as Android. These integration instructions apply to games for Google Play or the Amazon App Store.

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

Setting Up Chartboost SDK

  1. Add the Chartboost repository and dependencies with the following code to your Gradle file.
repositories {
mavenCentral()
}
dependencies {
implementation 'com.chartboost:chartboost-sdk:9.1.0'}
  1. 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 Google’s instructions to integrate the Play Services Library.
    • You should then find something similar to the following two lines in your build.gradle file:
implementation "com.google.android.gms:play-services-base:$project.ext.googlePlayServicesVersion"
implementation "com.google.android.gms:play-services-ads-identifier:$project.ext.googlePlayServicesVersion"
  1. Add the following attribute to activities in the AndroidManifest.xml file if you display Chartboost ads with multiple orientations in those activities. This will help smoothen video playback during orientation changes.
android:configChanges="keyboardHidden|orientation|screenSize"
  1. Import the Chartboost SDK into any activity that uses Chartboost with the following:
import com.chartboost.sdk.Chartboost;
import com.chartboost.sdk.ads.Interstitial;
import com.chartboost.sdk.ads.Rewarded;
import com.chartboost.sdk.ads.Banner;

import com.chartboost.sdk.LoggingLevel;
import com.chartboost.sdk.Analytics;
import com.chartboost.sdk.events.CacheError;
import com.chartboost.sdk.events.CacheEvent;
import com.chartboost.sdk.events.ClickError;
import com.chartboost.sdk.events.ClickEvent;
import com.chartboost.sdk.events.DismissEvent;
import com.chartboost.sdk.events.ImpressionEvent;
import com.chartboost.sdk.events.ShowError;
import com.chartboost.sdk.events.ShowEvent;
  1. Initialize Chartboost SDK
    • startWithAppId must always be called on bootup, regardless of any other actions your app takes.
    • 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 by the Terms of Service to obtain 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.
    • startWithAppId doesn’t require Activity anymore. From version 8.0.1+, the context should be passed instead.
 Chartboost.startWithAppId(getApplicationContext(), appId, appSignature, startError -> {
            if (startError == null) {
                Toast.makeText(SelectionActivity.this.getApplicationContext(), "SDK is initialized", Toast.LENGTH_SHORT).show();
                checkKnownConsentStatus();
            } else {
                Toast.makeText(SelectionActivity.this.getApplicationContext(), "SDK initialized with error: "+startError.getCode().name(), Toast.LENGTH_SHORT).show();
            }
        });
  1. Add your app ID and app signature
    • Replace appID and appSignature with your 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:

Create interstitial object without mediation object:

Interstitial chartboostInterstitial = new Interstitial("location", new InterstitialCallback() {
@Override
public void onAdDismiss(@NonNull DismissEvent dismissEvent) {

}

@Override
public void onAdLoaded(@NonNull CacheEvent cacheEvent, @Nullable CacheError cacheError) {
// after this is successful ad can be shown
}

@Override
public void onAdRequestedToShow(@NonNull ShowEvent showEvent) {

}

@Override
public void onAdShown(@NonNull ShowEvent showEvent, @Nullable ShowError showError) {

}

@Override
public void onAdClicked(@NonNull ClickEvent clickEvent, @Nullable ClickError clickError) {

}

@Override
public void onImpressionRecorded(@NonNull ImpressionEvent impressionEvent) {

}
}, null);

Create interstitial with mediation object:

Mediation mediation = new Mediation("Mediation", "1.0.0", "1.0.0.1");
chartboostInterstitial = new Interstitial("location", callback, mediation);

Cache interstitial:

chartboostInterstitial.cache();

Show interstitial:

if (chartboostInterstitial.isCached()) { // check is cached is not mandatory
chartboostInterstitial.show();
}

📘

Note

  • Do not call showInterstitial directly after cacheInterstitial for the same location, or the SDK will fail silently.
  • Prefetched videos (in total) only take up 30-50MB, even when you are using mediation.

To Show a Rewarded Video Ad

Create a rewarded object without Mediation object:

Rewarded chartboostRewarded = new Rewarded("location", new RewardedCallback() {
@Override
public void onRewardEarned(@NonNull RewardEvent rewardEvent) {

}

@Override
public void onAdDismiss(@NonNull DismissEvent dismissEvent) {

}

@Override
public void onAdLoaded(@NonNull CacheEvent cacheEvent, @Nullable CacheError cacheError) {
// after this is successful ad can be shown
}

@Override
public void onAdRequestedToShow(@NonNull ShowEvent showEvent) {

}

@Override
public void onAdShown(@NonNull ShowEvent showEvent, @Nullable ShowError showError) {

}

@Override
public void onAdClicked(@NonNull ClickEvent clickEvent, @Nullable ClickError clickError) {

}

@Override
public void onImpressionRecorded(@NonNull ImpressionEvent impressionEvent) {

}
}, null);

Create a rewarded object with Mediation object:

Mediation mediation = new Mediation("Mediation", "1.0.0", "1.0.0.1");
chartboostRewarded = new Rewarded("start", callback, mediation);

Cache rewarded:

chartboostRewarded.cache();
  • 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.

Show rewarded:

chartboostRewarded.show();

To Show a Banner Ad:

Create a banner object without Mediation object:

Banner chartboostBanner = new Banner(context, "location", Banner.BannerSize.STANDARD, new BannerCallback() {
@Override
public void onAdLoaded(@NonNull CacheEvent cacheEvent, @Nullable CacheError cacheError) {

}

@Override
public void onAdRequestedToShow(@NonNull ShowEvent showEvent) {

}

@Override
public void onAdShown(@NonNull ShowEvent showEvent, @Nullable ShowError showError) {

}

@Override
public void onAdClicked(@NonNull ClickEvent clickEvent, @Nullable ClickError clickError) {

}

@Override
public void onImpressionRecorded(@NonNull ImpressionEvent impressionEvent) {

}
}, null);

Create a banner object with mediation:

Mediation mediation = new Mediation("Mediation", "1.0.0", "1.0.0.1");
chartboostBanner = new Banner(context, "location", Banner.BannerSize.STANDARD, callback, mediation);

Attach the banner to a holder. The banner object is extending FrameLayout and needs to be attached to the view to be displayed on the screen.

RelativeLayout bannerHolder = findViewById(R.id.example_banner_holder);
bannerHolder.addView(chartboostBanner);

CacheBanner:

chartboostBanner.cache();

Show banner:

public void onAdLoaded(CacheEvent cacheEvent, @Nullable CacheError cacheError) {
      if(cacheError != null) {
          /* Handle error */
      } else {
          chartboostBanner.show();
      }
})

Remove banner:

chartboostBanner.detach();

Public Banner Errors:

CacheError cacheError = new CacheError(CacheError.Code.INTERNAL, new Exception("banner cache error"));
cacheError.getCode();

ShowError showError = new ShowError(ShowError.Code.INTERNAL, new Exception("banner show error"));
showError.getCode();

ClickError clickError = new ClickError(ClickError.Code.INTERNAL, new Exception("banner click error"));
clickError.getCode();

📘

Note

Banner ads are not supported for Amazon integrations.

Testing Your SDK Integration

  1. Run your project on an Android device.
  2. Use Test Mode to see if test ads show up.

Why can’t I see ads in my game?

Checking Your SDK Integration Status via Dashboard

  1. In your dashboard Apps Overview page, select the app that you're integrating with Chartboost SDK. You should be redirected to its App Settings.
  2. If your App Status has never been set to live, then the SDK icon will not be displayed.
    1. Set your app live in the application store.
    2. Change your App Status to "My app is live in the application store".
    3. Connect Your App by searching your app name, store ID, or store URL.
  3. The SDK icon is displayed underneath your app’s icon and above App ID.
    • If the SDK icon is green, then our servers successfully received a bootup call from our SDK using your app ID.
    • If the SDK icon is grey, then your integration setup failed. Double-check your setup or reach out to our support team for assistance.

SDK Configuration Methods

These methods allow you to access Chartboost SDK functionality and settings.

/**
* Set the Chartboost SDK logging level.
* @param level The logging level.
* @return true if was set successfully, false otherwise
*/
fun setLoggingLevel(level: LoggingLevel)

Updated 8 days ago