Banner Integration for Android

Banners are a rectangular, system-initiated ads that can be either static or animated, and are served in a designated area around your live app content.

⚡ Before you start

Make sure that you have correctly integrated the ironSource SDK into your application. Integration is outlined here.
Make sure to initialize the SDK using LevelPlay Initialization API.
You can find the AdUnitID in LevelPlay dashboard. Learn more here.
This documentation is relevant for SDK 8.9.0+. Documentation for legacy banner APIs (SDK 8.4.0 and below) can be found here.

Create Banner Ad Object and Set Size

The creation of the banner ad object should be done after receiving onInitSuccess callback.

Java
Kotlin

// Create ad configuration - optional
LevelPlayAdSize adSize = LevelPlayAdSize.BANNER;
LevelPlayBannerAdView.Config adConfig = new LevelPlayBannerAdView.Config.Builder()
    .setAdSize(adSize)
    .setPlacementName("placementName")
    .build();
// Create the banner view and set the ad unit id
LevelPlayBannerAdView levelPlayBanner = new LevelPlayBannerAdView(context, "adUnitId", adConfig);

// Create ad configuration - optional
val adSize = LevelPlayAdSize.BANNER
val adConfig = LevelPlayBannerAdView.Config.Builder()
    .setAdSize(adSize)
    .setPlacementName("placementName")
    .build()
// Create the banner view and set the ad unit id
val levelPlayBanner = LevelPlayBannerAdView(context, "adUnitId", adConfig)

LevelPlayAdSize	Description	Dimensions in dp (Width X Height)
BANNER	Standard banner	320 x 50
LARGE	Large banner	320 x 90
MEDIUM_RECTANGLE	Medium Rectangular (MREC)	300 x 250
Adaptive	Automatically renders ads to adjust size and orientation for mobile & tablets	Device width X recommended height

To create the ad size follow one of these options:

Adaptive ad size that adjusts to the screen width (recommended):

This option returns BANNER or LEADERBOARD according to the device type.
Networks that supports adaptive feature (Google, Yandex) will return the a height based on their optimization logic.

Java
Kotlin

 LevelPlayAdSize adSize = LevelPlayAdSize.createAdaptiveAdSize(context);

 val adSize = createAdaptiveAdSize(context)

Specific banner size:
This option allows you to set specifically a banner size: BANNER, LARGE, MEDIUM_RECTANGLE.

Java
Kotlin

levelPlayBanner.setAdSize(LevelPlayAdSize.MEDIUM_RECTANGLE);

levelPlayBanner.setAdSize(LevelPlayAdSize.MEDIUM_RECTANGLE)

Placements

We support placements in banners for reporting only. Placements should be set before the loadAd, to affect all reloaded ads.

Java
Kotlin

// Set the placement name
levelPlayBanner.setPlacementName("placementName");

// Set the placement name
levelPlayBanner.setPlacementName("placementName")

Set Banner Listener

Implement the LevelPlayBannerAdViewListener in your code to get informed of ad delivery.

It is recommended to set the listener before loading the banner ad.
Please note that each banner ad should have its own listener implementation.
Callbacks run on the main thread.
When callbacks are not supported by all networks, they are marked as optional.

Java
Kotlin

levelPlayBanner.setBannerListener(new LevelPlayBannerAdViewListener() {
    @Override
    public void onAdLoaded(@NonNull LevelPlayAdInfo adInfo) {
    // Ad was loaded successfully 
    }
    @Override
    public void onAdLoadFailed(@NonNull LevelPlayAdError error) {
    // Ad load failed
    }
    @Override
    public void onAdDisplayed(@NonNull LevelPlayAdInfo adInfo) {
    // Ad was displayed and visible on screen
    }
    @Override
    public void onAdDisplayFailed(@NonNull LevelPlayAdInfo adInfo, @NonNull LevelPlayAdError error) {
    // Optional. Ad failed to be displayed on screen 
    }
    @Override
    public void onAdClicked(@NonNull LevelPlayAdInfo adInfo) {
    // Ad was clicked
    }
    @Override
    public void onAdExpanded(@NonNull LevelPlayAdInfo adInfo) {
    // Optional. Ad is opened on full screen 
    }
    @Override
    public void onAdCollapsed(@NonNull LevelPlayAdInfo adInfo) {
    // Optional. Ad is restored to its original size 
    }
    @Override
    public void onAdLeftApplication(@NonNull LevelPlayAdInfo adInfo) 
    // Optional. User pressed on the ad and was navigated out of the app 
    }
});

levelPlayBanner.setBannerListener(object: LevelPlayBannerAdViewListener {
    override fun onAdLoaded(adInfo: LevelPlayAdInfo) {
    // Ad was loaded successfully 
    }
    override fun onAdLoadFailed(error: LevelPlayAdError) {
    // Ad load failed
    }
    override fun onAdDisplayed(adInfo: LevelPlayAdInfo) {
    // Ad was displayed and visible on screen
    }
    override fun onAdDisplayFailed(adInfo: LevelPlayAdInfo, error: LevelPlayAdError) {
    // Optional. Ad failed to be displayed on screen 
    }
    override fun onAdClicked(adInfo: LevelPlayAdInfo) {
    // Ad was clicked
    }
    override fun onAdExpanded(adInfo: LevelPlayAdInfo) {
    // Optional. Ad is opened on full screen
    }
    override fun onAdCollapsed(adInfo: LevelPlayAdInfo) {
    // Optional. Ad is restored to its original size 
    }
    override fun onAdLeftApplication(adInfo: LevelPlayAdInfo) {
    // Optional. User pressed on the ad and was navigated out of the app 
    }
})

LevelPlay Ad Info

Ad Info

The LevelPlayAdInfo parameter includes information about the loaded ad.

Learn more about its implementation and available fields here.

Load Banner Ad

To load a banner ad use loadAd.

Java
Kotlin

// Load the banner ad
levelPlayBanner.loadAd();

// Load the banner ad
levelPlayBanner.loadAd()

Pause and Resume Banner Refresh

You can pause banner refresh in your code if the refresh value was defined in the platform. Use the following methods to stop the automatic refresh of the banner ad, or re-enable it after pausing.

Note:

When the banner is displayed again, it will complete the time till refresh, from the time it was paused.

pauseAutoRefresh – pauses auto-refresh of the banner ad.
resumeAutoRefresh – resumes auto-refresh of the banner ad after it has been paused.

Java
Kotlin

// Pause refresh
levelPlayBanner.pauseAutoRefresh();
// Resume refresh
levelPlayBanner.resumeAutoRefresh();

// Pause refresh
levelPlayBanner.pauseAutoRefresh()
// Resume refresh
levelPlayBanner.resumeAutoRefresh()

Destroy Banner Ad

To destroy a banner, call the destroy method.

A destroyed banner can no longer be shown again. To display more ads, create a new LevelPlayBannerAdView object.

Java
Kotlin

levelPlayBanner.destroy()

levelPlayBanner.destroy();

Full Implementation Example of Banner Ads

Here is an example for creating and loading a banner ad using adaptive banner size.

Java
Kotlin

public void createAndLoadBanner() {
    // Create ad configuration - optional
    LevelPlayAdSize adSize = LevelPlayAdSize.BANNER;
    LevelPlayBannerAdView.Config adConfig = new LevelPlayBannerAdView.Config.Builder()
        .setAdSize(adSize)
        .setPlacementName("placementName")
        .build();
    
    // Create the banner view and set the ad unit id
    LevelPlayBannerAdView levelPlayBanner = new LevelPlayBannerAdView(context, "adUnitId", adConfig);
    
    // Add the banner view to the container
    ViewGroup adContainer = findViewById(android.R.id.adContainer);
    adContainer.addView(levelPlayBanner);
    levelPlayBanner.setBannerListener(new LevelPlayBannerAdViewListener() {
        @Override
        public void onAdLoaded(@NonNull LevelPlayAdInfo adInfo) {
            // Ad was loaded successfully 
        }
        @Override
        public void onAdLoadFailed(@NonNull LevelPlayAdError error) {
            // Ad load failed
        }
        @Override
        public void onAdDisplayed(@NonNull LevelPlayAdInfo adInfo) {
            // Ad was displayed and visible on screen
        }
        @Override
        public void onAdDisplayFailed(@NonNull LevelPlayAdInfo adInfo, @NonNull LevelPlayAdError error) {
            // Ad failed to be displayed on screen
        }
        @Override
        public void onAdClicked(@NonNull LevelPlayAdInfo adInfo) {
            // Ad was clicked
        }
        @Override
        public void onAdExpanded(@NonNull LevelPlayAdInfo adInfo) {
            // Ad is opened on full screen
        }
        @Override
        public void onAdCollapsed(@NonNull LevelPlayAdInfo adInfo) {
            // Ad is restored to its original size
        }
        @Override
        public void onAdLeftApplication(@NonNull LevelPlayAdInfo adInfo) {
            // User pressed on the ad and was navigated out of the app 
        }
    });
    
    // Load the banner ad
    levelPlayBanner.loadAd();
    
    // To get actual banner layout size (either custom/standard size or adaptive)
    int height = adSize.getHeight();
    int width = adSize.getWidth();
}

public fun createAndLoadBanner() {
    // Create ad configuration - optional
    val adSize = LevelPlayAdSize.BANNER
    val adConfig = LevelPlayBannerAdView.Config.Builder()
        .setAdSize(adSize)
        .setPlacementName("placementName")
        .build()
    // Create the banner view and set the ad unit id
    val levelPlayBanner = LevelPlayBannerAdView(context, "adUnitId", adConfig)
    
    // Add the banner view to the container
    val adContainer = findViewById<ViewGroup>(R.id.adContainer)
    adContainer.addView(levelPlayBanner)
    levelPlayBanner.setBannerListener(object: LevelPlayBannerAdViewListener {
        override fun onAdLoaded(adInfo: LevelPlayAdInfo) {
            // Ad was loaded successfully 
        }
        override fun onAdLoadFailed(error: LevelPlayAdError) {
            // Ad load failed
        }
        override fun onAdDisplayed(adInfo: LevelPlayAdInfo) {
            // Ad was displayed and visible on screen
        }
        override fun onAdDisplayFailed(adInfo: LevelPlayAdInfo, error: LevelPlayAdError) {
            // Ad failed to be displayed on screen
        }
        override fun onAdClicked(adInfo: LevelPlayAdInfo) {
            // Ad was clicked
        }
        override fun onAdExpanded(adInfo: LevelPlayAdInfo) {
            // Ad is opened on full screen
        }
        override fun onAdCollapsed(adInfo: LevelPlayAdInfo) {
            // Ad is restored to its original size
        }
        override fun onAdLeftApplication(adInfo: LevelPlayAdInfo) {
            // User pressed on the ad and was navigated out of the app 
        }
    })
    
    // Load the banner ad
    levelPlayBanner.loadAd()
    
    // Get width and height for the container
    val width = adSize.getWidth()
    val height = adSize.getHeight()
}

LevelPlay Mediation Demo App

The Integration Demo application demonstrates how to integrate banner Ad Unit APIs in your app.

Download Android Demo Application

Done!
You are now all set up to serve banners in your application. Verify your integration with our Integration Test Suite.

What’s Next?
Follow our integration guides to integrate additional Banner Ad networks or configure additional ad formats: