Banner

Banner ads are classic static banners, usually located at the bottom or top of the screen. Appodeal supports traditional 320x50 banners, 728x90 tablet banners and smart banners that adjust to the size and orientation of the device.

Checking If Ad Is Loaded

You can check if the ad has been loaded before showing it. This method returns a boolean value indicating whether or not the banner has been loaded.

Swift

Appodeal.isReadyForShow(with: .bannerTop)

Objective-C

[Appodeal isReadyForShowWithStyle: AppodealShowStyleBannerTop];

---

We recommend you to check ad caching before trying to show it.

Display Banner At The Bottom Of The Screen

Banner is a singleton now, if you are using bannerTop or bannerBottom on different controllers, the SDK will use the same banner instance.

Banner ads are refreshed every 15 seconds automatically by default. To display a banner, you need to call the following code:

Swift

Appodeal.showAd(.bannerBottom, rootViewController: self)

Objective-C

[Appodeal showAd:AppodealShowStyleBannerBottom rootViewController:self];

---

Display Banner At The Top Of The Screen

Swift

Appodeal.showAd(.bannerTop, rootViewController: self)

Objective-C

[Appodeal showAd:AppodealShowStyleBannerTop rootViewController:self];

---

Display Banner At The Left Or Right Corner Of The Screen

If your app uses landscape interface orientation you can show Appodeal Banner at the left or right corner. The banner will have the offset according to the safe area layout guide.

caution

Disable banner smart sizing if you use AppodealShowStyleBannerLeft or AppodealShowStyleBannerRight

Swift

// Overrides default rotation angles
// Appodeal.setBannerLeftRotationAngleDegrees(90, rightRotationAngleDegrees: 180)


Appodeal.showAd(.bannerLeft, forPlacement: placement, rootViewController: self)
// Appodeal.showAd(.bannerRight, forPlacement: placement, rootViewController: self)

Objective-C

// Overrides default rotation angles
// [Appodeal setBannerLeftRotationAngleDegrees:90 rightRotationAngleDegrees:180];

[Appodeal showAd: AppodealShowStyleBannerLeft forPlacement: placement rootViewController: self];
// [Appodeal showAd: AppodealShowStyleBannerRight forPlacement: placement rootViewController: self];

---

Display Banner In Programmatically Created View

You can also add the Appodeal banner to your view hierarchy manually.

For example:

Swift

override func viewWillAppear(_ animated: Bool) {
    super.viewWillAppear(animated)
    if let banner = Appodeal.banner() {
        self.view.addSubview(banner)
        banner.frame = CGRect(x: 0, y: 0, width: self.view.bounds.width, height: 50)
    }
}

Objective-C

- (void)viewWillAppear:(BOOL)animated 
{
  [super viewWillAppear:animated];

  [self.view addSubview:[Appodeal banner]];
  [Appodeal banner].frame = CGRectMake(0, 0, self.view.bounds.size.width, 50);
}

---

Important!

Custom BannerView must be on the top of the hierarchy and mustn't be overlapped by other views.

Callbacks

Callbacks are used to track different lifecycle events of an ad, e.g., when a banner has successfully loaded or is about to appear. To get them, you need to set the delegate as follows:

Swift

//set delegate
Appodeal.setBannerDelegate(self)

Objective-C

//set delegate
[Appodeal setBannerDelegate:self];

Usually, the class that implements banners is also the delegate class. That’s why the delegate property can be set to self.

Now you can use the following callback methods:

Swift

// banner was loaded (precache flag shows if the loaded ad is precache)
func bannerDidLoadAdIsPrecache(_ precache: Bool) {}
// banner was shown
func bannerDidShow() {} 
// banner failed to load
func bannerDidFailToLoadAd() {}
// banner was clicked 
func bannerDidClick() {} 
// banner did expire and could not be shown
func bannerDidExpired() {} 

Objective-C

// banner was loaded (precache flag shows if the loaded ad is precache)
- (void)bannerDidLoadAdIsPrecache:(BOOL)precache {}
// banner was shown
- (void)bannerDidShow {} 
// banner failed to load
- (void)bannerDidFailToLoadAd {} 
// banner was clicked
- (void)bannerDidClick {} 
// banner did expire and could not be shown
- (void)bannerDidExpired {} 

tip

All callbacks are called on the main thread.

caution

If automatic caching is ON for the Banner ad type, do not show the banner in the bannerDidLoadAdIsPrecache callback. The banner will be refreshed automatically after the first show.

Hide

To remove the banner from your view hierarchy:

Swift

Appodeal.hideBanner()

Objective-C

[Appodeal hideBanner];

---

Placements

Appodeal SDK allows you to tag each impression with different placement. To be able to use placements, you need to create them in Appodeal Dashboard. Read more about placements.

Swift

Appodeal.showAd(.bannerTop, forPlacement: placement, rootViewController: self)

Objective-C

[Appodeal showAd:AppodealShowStyleBannerTop forPlacement:placement rootViewController:self];

---

If the loaded ad can't be shown in a specific placement, nothing will be shown. If auto caching is enabled, the SDK will start to cache another ad, which can affect display rate. To save the loaded ad for future use (for instance, for another placement) check if the ad can be shown before calling show method:

Swift

Appodeal.canShow(.bannerTop, forPlacement: placement)

Objective-C

[Appodeal canShow:AppodealAdTypeBannerTop forPlacement:placement];

---

You can configure your impression logic for each placement.

If you have no placements or call Appodeal.show with a placement that does not exist, the impression will be tagged with 'default' placement with corresponding settings applied.

Important!

Placement settings affect ONLY ad presentation, not loading or caching.

Advanced BannerView Integration

If basic integration is not appropriate for you due to the complex views hierarchy of your app, you can use AppodealBannerView UIView subclass to integrate banners.

Swift

import UIKit
import Appodeal

class YourViewController : UIViewController, AppodealBannerViewDelegate {

  override func viewDidLoad () {
    super.viewDidLoad()
    // required: init ad banner
    var bannerView: AppodealBannerView!
    bannerView.init(size: bannerSize, rootViewController: self);

    // optional: set delegate
    bannerView.setDelegate(self);

    // required: add banner to superview and call -loadAd to start banner loading
    self.view addSubview(bannerView);
    bannerView.loadAd();
  }

  // optional: implement any of AppodealBannerViewDelegate methods
  func bannerViewDidLoadAd(_ bannerView: APDBannerView, isPrecache precache: Bool) {
     NSLog("bannerView was loaded")       
  }

  func bannerView(_ bannerView: APDBannerView, didFailToLoadAdWithError error: Error) {
     NSLog("bannerView failed to load");        
  }

  func bannerViewDidInteract(_ bannerView: APDBannerView) {
     NSLog("bannerView was clicked")
  }

  func bannerViewDidShow(_ bannerView: APDBannerView) {
     NSLog("bannerView was shown")
  }

  func bannerViewExpired(_ bannerView: APDBannerView) {
     NSLog("bannerView did expire and could not be shown")
  }
}

Objective-C

#import "YourViewController.h"
#import <Appodeal/Appodeal.h>

@interface YourViewController () <AppodealBannerViewDelegate>
@end

@implementation YourViewController

- (void)viewDidLoad
{
  [super viewDidLoad];

  // required: init ad banner
  AppodealBannerView *bannerView = [[AppodealBannerView alloc] initWithSize:kAppodealUnitSize_320x50 rootViewController:self];

  // optional: set delegate
  bannerView.delegate = self;

  // required: add banner to superview and call -loadAd to start banner loading
  [self.view addSubview:bannerView];
  [bannerView loadAd];
}

// optional: implement any of AppodealBannerViewDelegate methods
- (void)bannerViewDidLoadAd:(APDBannerView *)bannerView isPrecache:(BOOL)precache{
  NSLog(@"Banner %@ did load!", bannerView);
}

- (void)bannerViewDidInteract:(APDBannerView *)bannerView {
  NSLog(@"Banner %@ did interact", bannerView);
}

- (void)bannerView:(APDBannerView *)bannerView didFailToLoadAdWithError:(NSError *)error {
  NSLog(@"Banner %@ did fail with error: %@", bannerView, error);
}

- (void)bannerViewDidShow:(APDBannerView *)bannerView {
   NSLog(@"Banner %@ did show ad ", bannerView);
}

- (void)bannerViewExpired:(APDBannerView *)bannerView {
   NSLog(@"Banner %@ expired", bannerView);
}

@end

---

Enable Smart Banners

Smart banners are banner ads which automatically fit the screen/container size. Using them helps to deal with increasing fragmentation of the screen sizes on different devices. To enable them, use the following method:

Swift

//for top/bottom banners allows banner view to resize automatically to fit device screen
Appodeal.setSmartBannersEnabled(true)
//for banner view allows banner view to resize automatically to fit device screen
bannerView.usesSmartSizing = true

Objective-C

//for top/bottom banners allows banner view to resize automatically to fit device screen 
[Appodeal setSmartBannersEnabled:YES];
//for banner view allows banner view to resize automatically to fit device screen
bannerView.usesSmartSizing = YES;

---

Change Banner Background

This method allows to create a grey background for banner ads: 

Swift

//for top/bottom banners
Appodeal.setBannerBackgroundVisible(true)

//for bannerView
bannerView.backgroundVisible = true

Objective-C

//for top/bottom banners
[Appodeal setBannerBackgroundVisible: YES];

//for bannerView
[bannerView setBannerBackgroundVisible: YES];

---

Enable Banner Refresh Animation

Swift

//for top/bottom banners
Appodeal.setBannerAnimationEnabled(true)

//for bannerView
bannerView.bannerAnimationEnabled = true

Objective-C

//for top/bottom banners
[Appodeal setBannerAnimationEnabled:YES];

//for bannerView
[bannerView setBannerAnimationEnabled:YES];

---

Get Predicted eCPM

This method returns the expected eCPM for the cached ad. The amount is calculated based on historical data for the current ad unit.

Swift

Appodeal.predictedEcpm(for: .banner)

Objective-C

[Appodeal predictedEcpmForAdType: AppodealAdTypeBanner]; 

---

Check If Banner Is Initialized

Swift

Appodeal.isInitialized(for: .banner)

Objective-C

[Appodeal isInitalizedForAdType: AppodealAdTypeBanner];

---

Returns true if banner was initialized.

Check If Autocache Is Enabled

Swift

Appodeal.isAutocacheEnabled(.banner)

Objective-C

[Appodeal isAutocacheEnabled: AppodealAdTypeBanner];

---

Returns true if autocache is enabled for banner.