Documentation

Support

Unity LevelPlay

Get started with LevelPlay

SDK integration

LevelPlay platform

Unity LevelPlay

Banner integration for iOS

Implement banner ads in your iOS app by creating a banner ad object, setting its size, and displaying it within the app's view hierarchy.
Read time 5 minutesLast updated 4 hours ago
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.

Prerequisites

  • 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.
  • Find the AdUnitID in LevelPlay dashboard.

Create Banner Ad Object and Set Size

The creation of the banner ad object should be done after receiving onInitSuccess callback. 
// Create ad configuration - optional
LPMBannerAdViewConfigBuilder *adConfigBuilder = [LPMBannerAdViewConfigBuilder new];
[adConfigBuilder setWithAdSize:bannerSize];
[adConfigBuilder setWithPlacementName:@"placementName"];
LPMBannerAdViewConfig *adConfig = [adConfigBuilder build];
// Create the banner view and set the ad unit id
self.bannerAd = [[LPMBannerAdView alloc] initWithAdUnitId:@"adUnitId" config: adConfig];

Banner Sizes

LPMAdSize

Description

Dimensions in dp (Width X Height)

bannerSizeStandard banner320 x 50
largeSizeLarge banner320 x 90
mediumRectangleSizeMedium Rectangular (MREC)300 x 250
AdaptiveAutomatically renders ads to adjust size and orientation for mobile & tabletsDevice 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. 
LPMAdSize *bannerSize = [LPMAdSize createAdaptiveAdSize];
[self.bannerAdView setAdSize: bannerSize];

Specific banner size

This option allows you to set specifically a banner size: BANNER, LARGE, MEDIUM_RECTANGLE. 
LPMAdSize *bannerSize = [LPMAdSize createAdaptiveAdSize];
[self.bannerAdView setAdSize: bannerSize];

Placements

We support placements in banners for reporting only. Placements should be set before the loadAd, to affect all reloaded ads. 
// Set the placement name
[self.bannerAdView setPlacementName:@"PlacementName"];

Set Banner Delegates

Implement the LPMBannerAdViewDelegate in your code to get informed of ad delivery.
  • It is recommended to set the delegates before loading the banner ad.
  • Each banner ad view should have its own delegate implementation.
  • Callbacks run on the main thread.
  • When callbacks are not supported by all networks, they are marked as optional.
// Set delegate implementation 
[self.bannerAdView setDelegate:self]
#pragma mark - LPMBannerAdViewDelegate
- (void)didLoadAdWithAdInfo:(nonnull LPMAdInfo *)adInfo {
//Ad was loaded successfully
}
- (void)didFailToLoadAdWithAdUnitId:(nonnull NSString *)adUnitId error:(nonnull NSError *)error { 
// Ad load failed
}
- (void)didClickAdWithAdInfo:(LPMAdInfo *)adInfo {
// Ad was clicked
}
- (void)didDisplayAdWithAdInfo:(LPMAdInfo *)adInfo {
// Ad was displayed and visible on screen
}
- (void)didFailToDisplayAdWithAdInfo:(LPMAdInfo *)adInfo error:(NSError *)error {
// Optional. Ad was failed to be displayed on screen
}
- (void)didLeaveAppWithAdInfo:(LPMAdInfo *)adInfo {
// Optional. User pressed on the ad and was navigated out of the app 
}
- (void)didExpandAdWithAdInfo:(LPMAdInfo *)adInfo {
// Optional. Ad is opened on full screen
}
- (void)didCollapseAdWithAdInfo:(LPMAdInfo *)adInfo {
// Optional. Ad is restored to its original size
}

LevelPlay Ad Info

The LevelPlayAdInfo parameter includes information about the loaded ad.

Load Banner Ad

To load a banner ad, use loadAd. 
// Load the banner ad
[self.bannerAdView loadAdWithViewController:self]

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.
  • pauseAutoRefresh - pauses auto-refresh of the banner ad.
  • resumeAutoRefresh - resumes auto-refresh of the banner ad after it has been paused.
// Pause refresh
[self.bannerAdView pauseAutoRefresh]; 
// Resume refresh
[self.bannerAdView 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 LPMBannerAdView object. 
[self.bannerAdView destroy];

Full Implementation Example of Banner Ads

Here is an example for creating and loading a banner ad using adaptive banner size. 
NS_ASSUME_NONNULL_BEGIN
@interface BannerAdViewController () <LPMBannerAdViewDelegate>
@property(nonatomic, strong) LPMBannerAdView *bannerAd;
@end
@implementation BannerAdViewController
- (void)dealloc {
[self.bannerAd destroy];
}
- (void)createBannerAd {
LPMAdSize *bannerSize = [self getBannerSize] ?: [LPMAdSize mediumRectangleSize];
// Create ad configuration - optional
LPMBannerAdViewConfigBuilder *adConfigBuilder = [LPMBannerAdViewConfigBuilder new];
[adConfigBuilder setWithAdSize:bannerSize];
[adConfigBuilder setWithPlacementName:@"placementName"];
LPMBannerAdViewConfig *adConfig = [adConfigBuilder build];
// Create the banner view and set the ad unit id
self.bannerAd = [[LPMBannerAdView alloc] initWithAdUnitId:@"adUnitId" config: adConfig];

// Set the delegate implementation
[self.bannerAd setDelegate:self];

// Add the banner view to the view hierarchy with the proper constraints
[self addBannerViewWithSize:bannerSize];
}
- (LPMAdSize *)getBannerSize {
// 1. Recommended - Adaptive ad size that adjusts to the screen width
LPMAdSize *bannerSize = [LPMAdSize createAdaptiveAdSize];
// 2. Adaptive ad size using fixed width ad size
// self.bannerSize = [LPMAdSize createAdaptiveAdSizeWithWidth:400];
// 3. Specific banner size - BANNER, LARGE, MEDIUM_RECTANGLE
// self.bannerSize = [LPMAdSize mediumRectangleSize];

return bannerSize;
}
- (void)loadBannerAd {
[self.bannerAd loadAdWithViewController:self];
}
- (void)addBannerViewWithSize:(LPMAdSize *)bannerSize {
self.bannerAd.translatesAutoresizingMaskIntoConstraints = NO;

// Add the banner view to the view hierarchy
[self.view addSubview:self.bannerAd];
[NSLayoutConstraint activateConstraints:@[
   [self.bannerAd.bottomAnchor constraintEqualToAnchor:self.view.safeAreaLayoutGuide.bottomAnchor],
   [self.bannerAd.centerXAnchor constraintEqualToAnchor:self.view.centerXAnchor],
   [self.bannerAd.widthAnchor constraintEqualToConstant:bannerSize.width],
   [self.bannerAd.heightAnchor constraintEqualToConstant:bannerSize.height]
]];
}
#pragma mark - LPMBannerAdViewDelegate
- (void)didLoadAdWithAdInfo:(nonnull LPMAdInfo *)adInfo {}
- (void)didFailToLoadAdWithAdUnitId:(nonnull NSString *)adUnitId error:(nonnull NSError *)error {}
- (void)didClickAdWithAdInfo:(LPMAdInfo *)adInfo {}
- (void)didDisplayAdWithAdInfo:(LPMAdInfo *)adInfo {}
- (void)didFailToDisplayAdWithAdInfo:(LPMAdInfo *)adInfo error:(NSError *)error {}
- (void)didLeaveAppWithAdInfo:(LPMAdInfo *)adInfo {}
- (void)didExpandAdWithAdInfo:(LPMAdInfo *)adInfo {}
- (void)didCollapseAdWithAdInfo:(LPMAdInfo *)adInfo {}
@end
NS_ASSUME_NONNULL_END

LevelPlay Mediation Demo App

The Integration Demo application demonstrates how to integrate banner Ad Unit APIs in your app. Download iOS Demo Application Verify your integration with our Integration Test Suite.

Next steps

Follow our integration guides to integrate additional Banner Ad networks or configure additional ad formats: