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.

1. Manual caching

By default, auto caching is enabled: Appodeal SDK starts to load Banner right after the initialization method is called. The next banner ad starts to load after the previous one has been shown.

To disable automatic caching for banners, use the code below before SDK initialization:

Appodeal.setAutocache(false, types: .banner)

[Appodeal setAutocache: NO types:AppodealAdTypeBanner];

Appodeal.cacheAd(.banner)

[Appodeal cacheAd:AppodealAdTypeBanner];

2. Checking if banner has been 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.

Appodeal.isReadyForShow(with: .bannerTop)

[Appodeal isReadyForShowWithStyle: AppodealShowStyleBannerTop];

3. Displaying 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:

Appodeal.showAd(.bannerBottom, rootViewController: self)

[Appodeal showAd:AppodealShowStyleBannerBottom rootViewController:self];

4. Displaying banner at the top of the screen

Appodeal.showAd(.bannerTop, rootViewController: self)

[Appodeal showAd:AppodealShowStyleBannerTop rootViewController:self];

5. Displaying 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.

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


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

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

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

6. Displaying banner in programmatically created view

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

For example:

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)
    }
}

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

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

7. Using banner 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:

//set delegate
Appodeal.setBannerDelegate(self)

//set delegate
[Appodeal setBannerDelegate:self];

Now you can use the following callback methods:

// 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() {} 

// 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 {} 

8. Hiding banner

To remove banner from your view hierarchy:

Appodeal.hideBanner()

[Appodeal hideBanner];

9. Banner 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.

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

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

Appodeal.canShow(.bannerTop, forPlacement: placement)

[Appodeal canShow:AppodealAdTypeBannerTop forPlacement: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.

10. Advanced banner integration

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.

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")
  }
}

#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

11. Enabling 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:

//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

//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;

12. Changing banner background

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

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

//for bannerView
bannerView.backgroundVisible = true

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

//for bannerView
[bannerView setBannerBackgroundVisible: YES];

13. Enabling banner refresh animation

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

//for bannerView
bannerView.bannerAnimationEnabled = true

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

//for bannerView
[bannerView setBannerAnimationEnabled:YES];

14. Getting 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.

Appodeal.predictedEcpm(for: .banner)

[Appodeal predictedEcpmForAdType: AppodealAdTypeBanner]; 

15. Checking if banner has been initialized

Appodeal.isInitialized(for: .banner)

[Appodeal isInitalizedForAdType: AppodealAdTypeBanner];

Returns true if banner was initialized.

16. Checking if autocache is enabled for banner

Appodeal.isAutocacheEnabled(.banner)

[Appodeal isAutocacheEnabled: AppodealAdTypeBanner];

Returns true if autocache is enabled for banner.