repositories {
maven {
name "Chartboost Mediation’s maven repo"
url "https://cboost.jfrog.io/artifactory/chartboost-mediation"
}
}
dependencies {
implementation 'com.chartboost:chartboost-mediation-sdk:4.0.0'
}
repositories {
maven {
name "Chartboost Mediation's maven repo"
url "https://cboost.jfrog.io/artifactory/chartboost-mediation"
}
maven {
name "Chartboost Core's maven repo"
url "https://cboost.jfrog.io/artifactory/chartboost-core"
}
}
dependencies {
implementation("com.chartboost:chartboost-core-sdk:1.1.0")
implementation("com.chartboost:chartboost-mediation-sdk:5.4.0")
}
// Create a listener
val heliumSdkListener = object : HeliumSdk.HeliumSdkListener { error -> {
error?.let {
Log.d(TAG, "Helium SDK failed to initialize. Reason: ${it.message}")
} ?: run {
// SDK Initialized with no errors.
Log.d(TAG, "Helium SDK Initialized successfully")
}
}
// Put the partner id in this map for network kill switch
val skippedPartnerIds = mutableSetOf<String>()
// skippedPartnerIds.add("chartboost") // for example
HeliumSdk.start(context, myHeliumAppId, myHeliumAppSignature,HeliumInitializationOptions(skippedPartnerIds), heliumSdkListener)
// Prepare a set of partner IDs that should not be initialized
ChartboostMediationSdk.setPreinitializationConfiguration(
ChartboostMediationPreinitializationConfiguration(
skippedPartnerIds = YOUR_SET_OF_PARTNER_IDS_TO_SKIP
),
)
// Create a usercentrics module (or any other consent management platform module)
val usercentrics = UsercentricsAdapter()
// Create a module listener
val listener = object : ModuleObserver {
override fun onModuleInitializationCompleted(result: ModuleInitializationResult) {
// Use this to action off of a specific module initialization
val moduleId = result.moduleId
}
}
// Make sure you're in a coroutine
CoroutineScope(Main).launch {
// Initialize ChartboostCore. You do not need to do anything additional besides providing the Chartboost app ID to initialize mediation.
ChartboostCore.initializeSdk(context, SdkConfiguration("[chartboost app id]", listOf(usercentrics)), listener)
}
// To load an adaptive 6x1 ad (with width 300dp)
heliumBannerAd.load(placement, HeliumBannerSize.adaptive6x1(300))
// You can pass in another size or the old non-adaptive sizes such as HeliumBannerSize.STANDARD
// To listen for refreshes
val listener: HeliumBannerAdListener = object : HeliumBannerAdListener {
fun onAdViewAdded(placementName: String, child: View?) {
// notified that a view is added.
}
// other callbacks didn't change
}
heliumBannerAd.heliumBannerAdListener = listener
// Make sure you're in a coroutine
CoroutineScope(Main).launch { ...
// Create a listener
val listener = object : ChartboostMediationBannerAdViewListener {
override fun onAdClicked(placement: String) {
// Fired when the banner is clicked
}
override fun onAdImpressionRecorded(placement: String) {
// Fired when a banner impression has occurred
}
override fun onAdViewAdded(
placement: String,
child: View?,
) {
// Fired when a view has been added to the banner
}
}
// Create an adaptive banner ad instance. Here is an example adaptive 6x1
val banner = ChartboostMediationBannerAdView(
context,
"[placement]",
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.adaptive6x1(300),
listener
)
// Load an adaptive banner ad. This variable has the load details.
val adaptiveBannerResult = banner.load(ChartboostMediationBannerAdLoadRequest(
"[placement]",
keywords,
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.adaptive6x1(300)
))
val density = context.resources.displayMetrics.density
heliumBannerAd.layoutParams = ViewGroup.LayoutParams(
300 * density,
50 * density
)
// If you want this to be automatic, just use WRAP_CONTENT for
// both width and height.
heliumBannerAd.layoutParams = ViewGroup.LayoutParams(
ViewGroup.LayoutParams.WRAP_CONTENT,
ViewGroup.LayoutParams.WRAP_CONTENT
)
// You can change this anytime. The next ad will use these sizes.
// To get the size of the currently showing creative, see:
heliumBannerAd.getCreativeSizeDips()
val density = context.resources.displayMetrics.density
chartboostMediationBannerAdView.layoutParams = ViewGroup.LayoutParams(
300 * density,
50 * density
)
// If you want this to be automatic, just use WRAP_CONTENT for
// both width and height.
chartboostMediationBannerAdView.layoutParams = ViewGroup.LayoutParams(
ViewGroup.LayoutParams.WRAP_CONTENT,
ViewGroup.LayoutParams.WRAP_CONTENT
)
// You can change this anytime. The next ad will use these sizes.
// To get the size of the currently showing creative, see:
chartboostMediationBannerAdView.getCreativeSizeDips()
/*
The following Banner enum Sizes can be passed down:
HeliumBannerAd.HeliumBannerSize.STANDARD
HeliumBannerAd.HeliumBannerSize.MEDIUM
HeliumBannerAd.HeliumBannerSize.LEADERBOARD
*/
val bannerSize = HeliumBannerAd.HeliumBannerSize.STANDARD
val heliumBannerAd = new HeliumBannerAd(context, placementName, bannerSize, bannerListener)
// Make sure you're in a coroutine
CoroutineScope(Main).launch {
...
// Create a listener
val listener = object : ChartboostMediationBannerAdViewListener {
override fun onAdClicked(placement: String) {
// Fired when the banner is clicked
}
override fun onAdImpressionRecorded(placement: String) {
// Fired when a banner impression has occurred
}
override fun onAdViewAdded(
placement: String,
child: View?,
) {
// Fired when a view has been added to the banner
}
}
// Create a standard banner ad instance
val standardBanner = ChartboostMediationBannerAdView(
context,
"[placement]",
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.STANDARD,
listener
)
// It is also possible to get it from the xml
val standardBanner = activity.findViewById(R.id.standard_banner) as ChartboostMediationBannerAdView
// Loading a standard banner. This variable has the load details.
val bannerLoadResult = standardBanner.load(ChartboostMediationBannerAdLoadRequest(
"[placement]",
keywords,
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.STANDARD
))
// Create a medium rectangle banner ad instance
val mediumRectagle = ChartboostMediationBannerAdView(
context,
"[placement]",
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.MEDIUM,
listener
)
// Load a medium rectangle. This variable has the load details.
val mediumRectangleLoadResult = mediumRectagle.load(ChartboostMediationBannerAdLoadRequest(
"[placement]",
keywords,
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.MEDIUM
))
// Create a leaderboard ad instance
val leaderboard = ChartboostMediationBannerAdView(
context,
"[placement]",
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.LEADERBOARD,
listener
)
// Load a leaderboard ad. This variable has the load details.
val leaderboardResult = leaderboard.load(ChartboostMediationBannerAdLoadRequest(
"[placement]",
keywords,
ChartboostMediationBannerAdView.ChartboostMediationBannerSize.LEADERBOARD
))
// Interstitial Ads
val interstitialRequest =
ChartboostMediationAdLoadRequest(
placementName = "YOUR_INTERSTITIAL_MEDIATION_PLACEMENT",
keywords = // Construct your keywords
)
// Rewarded Ads
val rewardedRequest =
ChartboostMediationAdLoadRequest(
placementName = "YOUR_REWARDED_MEDIATION_PLACEMENT",
keywords = // Construct your keywords
)
// Load the fullscreen ad
val result =
HeliumSdk.loadFullscreenAd(
context,
interstitialRequest, // or rewardedRequest
chartboostMediationFullscreenAdListener,
)
// Handle the ad load result
result.ad?.let { ad ->
// Success. Show the ad.
CoroutineScope(Main).launch {
ad.show(context)
}
} ?: run {
// Failure
}
// Make sure you're in a coroutine
CoroutineScope(Main).launch {
// Interstitial Ads
val interstitialRequest =
ChartboostMediationFullscreenAdLoadRequest(
placement = "YOUR_INTERSTITIAL_MEDIATION_PLACEMENT",
keywords = Keywords()
)
// Rewarded Ads
val rewardedRequest =
ChartboostMediationFullscreenAdLoadRequest(
placement = "YOUR_REWARDED_MEDIATION_PLACEMENT",
keywords = Keywords()
)
// Load the fullscreen ad
val result =
ChartboostMediationFullscreenAd.loadFullscreenAd(
context,
interstitialRequest, // or rewardedRequest
chartboostMediationFullscreenAdListener,
)
// Handle the ad load result
result.ad?.let { ad ->
// Success. Show the ad.
ad.show(activity)
} ?: run {
// Failure
}
}
// To drop oversized ads
HeliumSdk.setShouldDiscardOversizedAds(true)
// To allow oversized ads
HeliumSdk.setShouldDiscardOversizedAds(false)
// To drop oversized ads
ChartboostMediationSdk.setShouldDiscardOversizedAds(true)
// To allow oversized ads
ChartboostMediationSdk.setShouldDiscardOversizedAds(false)
heliumInterstitialAd.clearLoaded()
heliumRewardedAd.clearLoaded()
ChartboostMediationFullscreenAd.invalidate()
ChartboostMediationBannerAdView.clearAd()
override fun onDestroy() {
...
// Release interstitial ad
heliumInterstitialAd?.let {
it.destroy();
Log("destroyed an existing interstitial");
}
// Release rewarded ad
heliumRewardedAd?.let {
it.destroy();
Log("destroyed an existing rewarded");
}
// Release banner ad
heliumBannerAd?.let {
it.destroy();
Log("destroyed an existing banner");
}
...
}
override fun onDestroy() {
...
// Release banner ad
chartboostMediationBannerAdView?.let {
it.destroy();
Log("destroyed an existing banner");
}
...
}
HeliumSdk.setTestMode(true)
HeliumSdk.setTestMode(false)
ChartboostMediationSdk.setTestMode(context, true)
ChartboostMediationSdk.setTestMode(context, false)
// COPPA
HeliumSdk.setSubjectToCoppa(true)
// or
HeliumSdk.setSubjectToCoppa(false)
//- By sending `setSubjectToCoppa(true)`, you indicate that you want your content treated as child-directed for purposes of COPPA. We will take steps to disable interest-based advertising for such ad requests.
//- By sending `setSubjectToCoppa(false)`, you indicate that you don't want your content treated as child-directed for purposes of COPPA. You represent and warrant that your applications and services are not directed towards children and that you will not provide any information to Mediation from a user under the age of 13.
// GDPR
HeliumSdk.setSubjectToGDPR(true)
// or
HeliumSdk.setSubjectToGDPR(false)
//- By sending `setSubjectToGDPR(true)`, you indicate that GDPR is applied to this user from your application.
//- By sending `setSubjectToGDPR(false)`, you indicate that GDPR is not applied to this user from your application.
// User Given Consent
HeliumSdk.setUserHasGivenConsent(true)
// or
HeliumSdk.setUserHasGivenConsent(false)
//- By sending `setUserHasGivenConsent(true)`, you indicate that this user from your application has given consent to share personal data for behavior-targeted advertising.
//- By sending `setUserHasGivenConsent(false)`, you indicate that this user from your application has not given consent to use its personal data for behavior-targeted advertising, so only contextual advertising is allowed.
// CCPA
HeliumSdk.setCCPAConsent(true)
// or
HeliumSdk.setCCPAConsent(false)
//- By sending `setCCPAConsent(true)`, you indicate that this user from your application has given consent to share personal data for behavior-targeted advertising under CCPA regulation.
//- By sending `setCCPAConsent(false)`, you indicate that this user from your application has not given consent to allow sharing personal data for behavior-targeted advertising under CCPA regulation.
// Set Keywords
val interstitialAd = HeliumInterstitialAd(placementName, heliumInterstitialAdListener)
val rewardedAd = HeliumRewardedAd(placementName, heliumRewardedAdListener)
val bannerAd = HeliumBannerAd(context, placementName, bannerSize, heliumBannerAdListener)
interstitialAd.keywords["i12_keyword1"] = "i12_value1"
rewardedAd.keywords["rwd_keyword1"] = "rwd_value1"
bannerAd.keywords["bnr_keyword1"] = "bnr_value1"
// Remove Keywords
interstitialAd.remove("i12_keyword1")
rewardedAd.remove("rwd_keyword1")
bannerAd.remove("bnr_keyword1")
// ChartboostMediationFullscreenAd
// Adding Keywords to the Keywords object
val keywords = Keywords()
keywords["keyword1"] = "value1"
// Removing Keywords.
keywords.remove("keyword1")
// Passing keywords to the fullscreen load request.
val request = ChartboostMediationFullscreenAdLoadRequest(
placement = "placement",
keywords = keywords,
)
// Make sure you're in a coroutine
val result =
ChartboostMediationFullscreenAd.loadFullscreenAd(
context,
request,
listener,
)
// Adding Keywords from the ad result.
result.ad?.request?.keywords?.set("keyword1", "value1")
// Removing Keywords from the ad result.
result.ad?.request?.keywords?.remove("keyword1")
// Banners
// Adding Keywords to the Keywords object.
val keywords = Keywords()
keywords["banner1"] = "value1"
val bannerRequest = ChartboostMediationBannerAdLoadRequest(
"placement",
keywords,
bannerSize,
)
// Adding Keywords to banner request.
bannerRequest.keywords["banner2"] = "value2"
// Removing Keywords
val bannerAdView = ChartboostMediationBannerAdView(
context,
"placement",
size,
listener,
)
// Removing a keyword from the banner ad view
bannerAdView.keywords.remove("key1")
// It is also possible to remove the keyword from the banner load request
val keywords = Keywords()
keywords["key1"] = "value1"
keywords.remove("key1")
val loadRequest = ChartboostMediationBannerAdLoadRequest("placement", keywords, size)
// Can then load the banner with the keywords
bannerAdView.load(loadRequest)
HeliumSdk.setUserIdentifier("user")
ChartboostCore.publisherMetadata.setPlayerIdentifier("player_id")
val rewardedAd: HeliumRewardedAd = // create your HeliumRewardedAd
// load ad
val base64EncodedCustomData = "Y3VzdG9tIGRhdGE="
rewarded.customData = base64EncodedCustomData
// show ad
val ilrdObserver = object: HeliumIlrdObserver {
override fun onImpression(impData: HeliumImpressionData) {
// Placement name
val placement = impData.placementId
// JSON
val json = impData.ilrdInfo
}
}
override fun onCreate(savedInstanceState: Bundle?) {
...
// Subscribe to ILRD on app startup, e.g. in onCreate()
HeliumSdk.subscribeIlrd(ilrdObserver)
...
}
override fun onDestroy() {
...
// Unsubscribe from ILRD on app terminations, e.g. in onDestroy()
HeliumSdk.unsubscribeIlrd(ilrdObserver)
...
}
val chartboostMediationIlrdObserver = object: ChartboostMediationIlrdObserver {
override fun onImpression(impData: ChartboostMediationImpressionData) {
// Placement name
val placement = impData.placementId
// JSON
val json = impData.ilrdInfo
}
}
override fun onCreate(savedInstanceState: Bundle?) {
...
// Subscribe to ILRD on app startup, e.g. in onCreate()
ChartboostMediationSdk.subscribeIlrd(chartboostMediationIlrdObserver)
...
}
override fun onDestroy() {
...
// Unsubscribe from ILRD on app terminations, e.g. in onDestroy()
ChartboostMediationSdk.unsubscribeIlrd(chartboostMediationIlrdObserver)
...
}
// HeliumFullscreenAdListener
val heliumFullscreenAdListener = object : HeliumFullscreenAdListener
// HeliumBannerAdListener
val heliumBannerAdListener = object : HeliumBannerAdListener
// ChartboostMediationFullscreenAdListener
val chartboostMediationFullscreenAdListener = object : ChartboostMediationFullscreenAdListener
// ChartboostMediationBannerAdViewListener
val chartboostMediationBannerAdViewListener = object : ChartboostMediationBannerAdViewListener
// Chartboost Mediation SDK
-keep class com.chartboost.heliumsdk.** { *; }
// Chartboost Mediation Adapters
-keep class com.chartboost.mediation.** { *; }
// Keep kotlinx.serialization annotations
-keepattributes *Annotation*
// Keep the names of kotlinx.serialization classes
-keep,includedescriptorclasses class kotlinx.serialization.** {
*;
}
// Keep the names of classes with @Serializable annotation
-keep,includedescriptorclasses @kotlinx.serialization.Serializable class * {
*;
}
// Keep kotlinx.serialization internal implementation classes
-keepclassmembers class kotlinx.serialization.internal.** {
*;
}
// Chartboost Mediation SDK
-keep class com.chartboost.chartboostmediationsdk.** { *; }
// Chartboost Core SDK
-keep class com.chartboost.core.** { *; }
// Chartboost Mediation Adapters
-keep class com.chartboost.mediation.** { *; }
// Keep kotlinx.serialization annotations
-keepattributes *Annotation*
// Keep the names of kotlinx.serialization classes
-keep,includedescriptorclasses class kotlinx.serialization.** {
*;
}
// Keep the names of classes with @Serializable annotation
-keep,includedescriptorclasses @kotlinx.serialization.Serializable class * {
*;
}
// Keep kotlinx.serialization internal implementation classes
-keepclassmembers class kotlinx.serialization.internal.** {
*;
}