// While in a coroutine
val adRequest = ChartboostMediationAdLoadRequest(
placementName = [Your Placement Name],
keywords = Keywords(),
)
val loadResult = HeliumSdk.loadFullscreenAd(
context,
adRequest,
object : ChartboostMediationFullscreenAdListener {
override fun onAdImpressionRecorded(ad: ChartboostMediationFullscreenAd) {
// Impression
}
override fun onAdClicked(ad: ChartboostMediationFullscreenAd) {
// Clicked
}
override fun onAdRewarded(ad: ChartboostMediationFullscreenAd) {
// Rewarded
}
override fun onAdExpired(ad: ChartboostMediationFullscreenAd) {
// Expired
}
override fun onAdClosed(
ad: ChartboostMediationFullscreenAd,
error: ChartboostMediationAdException?
) {
// Closed
}
}
)
}
ChartboostMediationAdLoadRequest adRequest = new ChartboostMediationAdLoadRequest([Your Placement Name], new Keywords());
HeliumSdk.loadFullscreenAdFromJava(
context,
adRequest,
new ChartboostMediationFullscreenAdListener() {
public void onAdImpressionRecorded(@NonNull ChartboostMediationFullscreenAd ad) {
// Impression
}
public void onAdClicked(@NonNull ChartboostMediationFullscreenAd ad) {
// Clicked
}
public void onAdRewarded(@NonNull ChartboostMediationFullscreenAd ad) {
// Rewarded
}
public void onAdExpired(@NonNull ChartboostMediationFullscreenAd ad) {
// Expired
}
public void onAdClosed(
@NonNull ChartboostMediationFullscreenAd ad,
@Nullable ChartboostMediationAdException error) {
// Closed
}
},
new ChartboostMediationFullscreenAdLoadListener() {
public void onAdLoaded(@NonNull ChartboostMediationFullscreenAd ad) {
// Loaded
}
}
)
// Create a Chartboost Mediation fullscreen ad queue with the ad queue manager. The manager returns a ChartboostMediationFullscreenAdQueue.
val queue: ChartboostMediationFullscreenAdQueue = ChartboostMediationFullscreenAdQueueManager.queue(context, placementName)
// To listen to ad queue events, you can use the ChartboostMediationFullscreenAdQueueListener
queue.adQueueListener = object : ChartboostMediationFullscreenAdQueueListener {
override fun onFullScreenAdQueueUpdated(
adQueue: ChartboostMediationFullscreenAdQueue,
result: AdLoadResult,
numberOfAdsReady: Int,
) {
println(
"Fullscreen ad queue updated${
if (result.error != null) {
" with error: ${result.error?.cause}"
} else {
""
}
}. Number of ads ready: $numberOfAdsReady",
)
}
override fun onFullscreenAdQueueExpiredAdRemoved(
adQueue: ChartboostMediationFullscreenAdQueue,
numberOfAdsReady: Int,
) {
println("Fullscreen ad queue removed an expired ad. Number of ads ready: $numberOfAdsReady")
}
}
// To start queueing ads, use the `start()` method.
queue.start()
// To check if the queue is running, query the read-only `isRunning` property.
queue.isRunning
// To check if there's an ad in the queue, use the `hasNextAd()` method.
// To get an ad from the queue, use the `getNextAd()` method.
CoroutineScope(Main).launch {
if (queue.hasNextAd) {
val ad = queue.nextAd()
// Showing an ad needs to be in a suspend function.
// Be mindful that ads will need to be reattached to your ChartboostMediationFullscreenAdListener if you are listening to ad cycle events.
ad?.listener = fullscreenAdListener()
ad?.show(context)
}
}
// To stop the queue, use the `stop()` method.
queue.stop()
// Keywords can be set at any time, whether the queue is stopped or running.
// The next ad request sent by the running queue will use the keywords set here.
queue.keywords.set("keyword_key", "keyword_value")
// To set a queue capacity, use the queueCapacity property.
queue.queueCapacity = 3
// Create a Chartboost Mediation fullscreen ad queue with the ad queue manager. The manager returns a ChartboostMediationFullscreenAdQueue.
ChartboostMediationFullscreenAdQueue queue = ChartboostMediationFullscreenAdQueueManager.queue(context, placementName)
// To listen to ad queue events, you can use the ChartboostMediationFullscreenAdQueueListener
final ChartboostMediationFullscreenAdQueueListener fullscreenAdQueueListener = new ChartboostMediationFullscreenAdQueueListener() {
@Override
public void onFullScreenAdQueueUpdated(@NonNull ChartboostMediationFullscreenAdQueue adQueue, @NonNull AdLoadResult result, int numberOfAdsReady) {
System.out.println("Fullscreen ad queue has been updated for placement " + placementName + ". Number of ads ready to show: " + numberOfAdsReady);
}
@Override
public void onFullscreenAdQueueExpiredAdRemoved(@NonNull ChartboostMediationFullscreenAdQueue adQueue, int numberOfAdsReady) {
System.out.println("Fullscreen ad queue expired ad has been removed for placement " + placementName + ". Number of ads ready to show: " + numberOfAdsReady);
}
};
// Attach the created ChartboostMediationFullscreenAdQueueListener with the setAdQueueListener() method.
queue.setAdQueueListener(fullscreenAdQueueListener);
// To start queueing ads, use the `start()` method.
queue.start()
// To check if the queue is running, query the `isRunning()` method.
queue.isRunning()
// To check if there's an ad in the queue, use the `hasNextAd()` method.
// To get an ad from the queue, use the `getNextAd()` method.
if (queue.hasNextAd()) {
ChartboostMediationFullscreenAd ad = queue.getNextAd()
if (ad != null) {
// Be mindful that ads will need to be reattached to your ChartboostMediationFullscreenAdListener if you are listening to ad cycle events.
ad.setListener(fullscreenAdListener())
ad.showFullscreenAdFromJava(context, result -> {});
} else {
System.out.println("Fullscreen ad is null. Load an ad first.");
}
}
// To stop the queue, use the `stop()` method.
queue.stop()
// To set a queue capacity, use the `setQueueCapacity(int value)` method.
// The dashboard's queue size settings can be overridden at runtime.
// If this placement has a Queue Size setting of 2 and Max Queue Size
// is 4 or 5, this line of code will increase this queue's size to
// 4. But if Max Queue Size is smaller than the number passed to
// setQueueCapacity, the queue size will only be increased up to the
// allowed maximum. So if Max Queue Size is 3 then an error message
// will be logged and this queue's size will be changed to 3.
queue.setQueueCapacity(3)
fun adaptive2x1(width: Int): HeliumBannerSizefun adaptive4x1(width: Int): HeliumBannerSizefun adaptive6x1(width: Int): HeliumBannerSizefun adaptive8x1(width: Int): HeliumBannerSizefun adaptive10x1(width: Int): HeliumBannerSizefun adaptive1x2(width: Int): HeliumBannerSizefun adaptive1x3(width: Int): HeliumBannerSizefun adaptive1x4(width: Int): HeliumBannerSizefun adaptive9x16(width: Int): HeliumBannerSizefun adaptive1x1(width: Int): HeliumBannerSize// 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
val listener: HeliumBannerAdListener = object : HeliumBannerAdListener {
// An overload for the existing onAdCached function that provides an
// additional parameter, the banner size. By default this calls the
// currently implemented onAdCached
fun onAdCached(
placementName: String,
loadId: String,
winningBidInfo: Map<String, String>,
error: ChartboostMediationAdException?,
bannerSize: Size
)
// the other callbacks have not changed
}
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()
// To drop oversized ads
HeliumSdk.setShouldDiscardOversizedAds(true)
// To allow oversized ads
HeliumSdk.setShouldDiscardOversizedAds(false)
/*
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)
...
<com.chartboost.heliumsdk.ad.HeliumBannerAd
android:id="@+id/bannerAd"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
tools:layout_height="50dp"
app:heliumBannerSize="STANDARD"
app:heliumPlacementName="PlacementName" />
...
// load() returns a String representing the load request identifier.
heliumBannerAd.load()
// load() returns a String representing the load request identifier.
heliumBannerAd.load();
heliumInterstitialAd.clearLoaded()
heliumRewardedAd.clearLoaded()
heliumInterstitialAd.clearLoaded();
heliumRewardedAd.clearLoaded();
// To clear currently showing and any cached ad loaded for auto refresh.
heliumBannerAd.clearAd()
// To clear currently showing and any cached ad loaded for auto refresh.
heliumBannerAd.clearAd();