Sticky Banner
Integrate Sticky Banners
A sticky banner placement serves as a container for banner ads. It is commonly used as a static, constantly shown, part of the app’s presentation. The ad content of the banner changes over time. To create a placement you need to specify its name and size.
Create Placement
To create an instance of AATStickyBannerPlacement, use the following API:
var placement = AATSDK.createStickyBannerPlacement(name: "<PLACEMENT_NAME>", size: .banner320x50)
You have to specify a placement name and the size argument of the type AATBannerPlacementSize which specifies the size of the ad to be displayed.
Listen to Callbacks (Optional)
Through the use of AATStickyBannerPlacementDelegate, you can listen to the different placement callbacks.
placement.delegate = self
Get the Banner View
The sticky banner placement provides a banner ad view once and will keep responsible for refreshing the displayed ad content over time. So, once you’ve created the placement, get the ad container view via this method func getPlacementView() -> UIView?
and display it on the screen. If auto-reloading is used, the placement will update the view content once it has got a new ad.
if let bannerAdView = placement.getPlacementView() {
view.addSubview(bannerAdView)
// Change the bannerAdView frame to your desired location on the screen
}
Request Ad
You can load ads for the sticky banner placement either automatically (recommended) or manually.
Automatic Reload
To automatically load (and reload) the sticky banner placement enable auto-reload. If you do not set the refresh time interval seconds explicitly, AATKit will
Reload every 30 seconds (if no refresh time interval is set on the Dashboard)
Respect the refresh time interval setting of the Dashboard (which means, you can configure the interval without having to re-publish your app)
Note: if you make use of automatic reload, please make sure to disable (or not enable) automatic banner refresh at your ad networks of choice. Otherwise, the different auto reloads would interfere with each other.
// reload the banner placement every 30 seconds.
placement.startAutoReload()
// OR set refresh time manually
placement.startAutoReload(seconds: 45)
The minimum refresh time is 30 seconds.
This needs to stop the auto-reload when it is no longer needed (e.g. if the view controller presenting ads will disappear):
placement.stopAutoReload()
Manual Load
To manually load the sticky banner placement:
placement.reload()
// Or using force load
placement.reload(forceLoad: true)
Force Load
false
(default):reload()
will respect the current time interval.true
:reload()
will immediately reload (irrespective of the fact when the last ad was loaded). This can be useful if the same sticky banner placement is used on various different pages of the app and you want to load a new ad every time the user navigates to another page (while still using auto-reloading).
Banner Alignment
If the placement is created with a size larger than the banner ad size (see placement creation), you can align the banner ad inside the placement view. To set the ad alignment, use the setBannerAlign(alignment: AATBannerAlign)
API passing the proper AATBannerAlign that contains information about horizontal and vertical alignments.
let alignment = AATBannerAlign(horizontalAlign: .center, verticalAlign: .center)
placement.setBannerAlign(alignment: alignment)

Complete Code Example
class ViewController: UIViewController {
// Create the placement
var placement = AATSDK.createStickyBannerPlacement(name: "<PLACEMENT_NAME>", size: .banner320x50)
override func viewDidAppear(_ animated: Bool) {
super.viewDidAppear(animated)
// [IMPORTANT] Notify AATKit about the currently active view controller
AATSDK.controllerViewDidAppear(controller: self)
// Set placement delegate to listen to the callbacks
placement.delegate = self
// Set ad view alignment inside the placement view
let alignment = AATBannerAlign(horizontalAlign: .center, verticalAlign: .center)
placement.setBannerAlign(alignment: alignment)
// Get the banner view
if let bannerAdView = placement.getPlacementView() {
view.addSubview(bannerAdView)
// Change the bannerAdView frame to your desired location on the screen
}
// reload the banner placement every 30 seconds.
placement.startAutoReload()
// OR set refresh time manually
placement.startAutoReload(seconds: 30)
}
override func viewWillDisappear(_ animated: Bool) {
super.viewWillDisappear(animated)
// [IMPORTANT] Remove the currently active view controller
AATSDK.controllerViewWillDisappear()
// [IMPORTANT] Stop placement auto-reload
placement?.stopAutoReload()
}
}
extension ViewController: AATStickyBannerPlacementDelegate {
func aatHaveAd(placement: AATPlacement) {
// The placement has loaded a new ad
}
func aatNoAd(placement: AATPlacement) {
// The placement could not load a new ad
}
func aatPauseForAd(placement: AATPlacement) {
// Ad has been displayed on the screen
}
func aatResumeAfterAd(placement: AATPlacement) {
// Back to the app after clicking on the ad
}
}
Last updated