# Sticky Banner

{% hint style="info" %}
This placement type is deprecated. We recommend using the new [auto-load-banner](https://aatkit.gitbook.io/ios-integration/formats/banner/auto-load-banner "mention") type instead.
{% endhint %}

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 <a href="#create-placement" id="create-placement"></a>

To create an instance of [AATStickyBannerPlacement](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatstickybannerplacement), use the following API:

{% tabs %}
{% tab title="Swift" %}

```swift
var placement = AATSDK.createStickyBannerPlacement(name: "<PLACEMENT_NAME>", size: .banner320x50)
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
id<AATStickyBannerPlacement> placement = [AATSDK createStickyBannerPlacementWithName:@"<PLACEMENT_NAME>" size:AATBannerPlacementSizeBanner300x50];
```

{% endtab %}
{% endtabs %}

You have to specify a placement name and the size argument of the type [AATBannerPlacementSize](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatbannerplacementsize) which specifies the size of the ad to be displayed.

### Listen to Callbacks (Optional) <a href="#listen-to-callbacks-optional" id="listen-to-callbacks-optional"></a>

Through the use of [AATStickyBannerPlacementDelegate](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatstickybannerplacementdelegate), you can listen to the different placement callbacks.

{% tabs %}
{% tab title="Swift" %}

```swift
placement.delegate = self
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
placement.delegate = self;
```

{% endtab %}
{% endtabs %}

### 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.

{% tabs %}
{% tab title="Swift" %}

```swift
if let bannerAdView = placement.getPlacementView() {
    view.addSubview(bannerAdView)
    // Change the bannerAdView frame to your desired location on the screen
}
```

{% endtab %}

{% tab title="Objective-C" %}

```
UIView *bannerAdView = [self.placement getPlacementView];
[self.view addSubview:bannerAdView];
// Change the bannerAdView frame to your desired location on the screen
```

{% endtab %}
{% endtabs %}

### Request Ad

You can load ads for the sticky banner placement either automatically (recommended) or manually.

#### Automatic Reload <a href="#automatic-reload" id="automatic-reload"></a>

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.

{% tabs %}
{% tab title="Swift" %}

```swift
// reload the banner placement every 30 seconds.
placement.startAutoReload()
// OR set refresh time manually
placement.startAutoReload(seconds: 45)
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
//reload the banner placement each 30 seconds.
[self.placement startAutoReload];
// or set refresh time manually
[self.placement startAutoReloadWithSeconds:45];
```

{% endtab %}
{% endtabs %}

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

{% tabs %}
{% tab title="Swift" %}

```swift
placement.stopAutoReload()
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
[self.placement stopAutoReload];
```

{% endtab %}
{% endtabs %}

#### Manual Load <a href="#manual-load" id="manual-load"></a>

To manually load the sticky banner placement:

{% tabs %}
{% tab title="Swift" %}

```swift
placement.reload()
// Or using force load
placement.reload(forceLoad: true)
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
[placement reload];
// Or using force load
[self.placement reloadWithForceLoad:YES];
```

{% endtab %}
{% endtabs %}

**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](#create-placement)), 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](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatbanneralign) that contains information about [horizontal](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatbanneralign/horizontalalign-swift.enum) and [vertical](https://ios-sdk.aatkit.com/references/documentation/aatkit/aatbanneralign/verticalalign-swift.enum) alignments.

{% tabs %}
{% tab title="Swift" %}

```swift
let alignment = AATBannerAlign(horizontalAlign: .center, verticalAlign: .center)
placement.setBannerAlign(alignment: alignment)
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
AATBannerAlign *alignment = [[AATBannerAlign alloc] initWithHorizontalAlign:HorizontalAlignCenter verticalAlign:VerticalAlignCenter];
[self.placement setBannerAlignWithAlignment:alignment];
```

{% endtab %}
{% endtabs %}

<figure><img src="https://3006681101-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FC07HayBzqyav5R2yFhOr%2Fuploads%2F2Mj8l5T9N5xd3YnD19VB%2FScreenshot%202023-02-03%20at%204.50.35%20PM.png?alt=media&#x26;token=3f8150ad-4bf3-4347-85d6-40c7e099e4e1" alt=""><figcaption><p>A 375x50 placement displaying a 320x50 banner ad</p></figcaption></figure>

{% hint style="info" %}
The above image is for a placement created with size 375x50 while the loaded ad is 320x50. The red background is the placement ad container after setting the alignment to `AATBannerAlign(horizontalAlign: .trailing, verticalAlign: .center)` (the red colour is just used here for explanatory purposes).
{% endhint %}

### Complete Code Example <a href="#complete-code-example" id="complete-code-example"></a>

{% tabs %}
{% tab title="Swift" %}

```swift
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
    }
}
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
@interface ViewController () <AATStickyBannerPlacementDelegate>
@property id<AATStickyBannerPlacement> placement;
@end

@implementation ViewController
- (void)viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];
    
    // [IMPORTANT] Notify AATKit about the currently active view controller
    [AATSDK controllerViewDidAppearWithController:self];
    
    // Create the placement
    self.placement = [AATSDK createStickyBannerPlacementWithName:@"<PLACEMENT_NAME>" size:AATBannerPlacementSizeBanner300x50];
    
    // Set placement delegate to listen to the callbacks
    self.placement.delegate = self;
    
    // Set ad view alignment inside the placement view
    AATBannerAlign *alignment = [[AATBannerAlign alloc] initWithHorizontalAlign:HorizontalAlignCenter verticalAlign:VerticalAlignCenter];
    [self.placement setBannerAlignWithAlignment:alignment];
    
    // Get the banner view
    UIView *bannerAdView = [self.placement getPlacementView];
    [self.view addSubview:bannerAdView];
    // Change the bannerAdView frame to your desired location on the screen
    
    //reload the banner placement every 30 seconds.
    [self.placement startAutoReload];
    // or set refresh time manually
    [self.placement startAutoReloadWithSeconds:30];
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
    // [IMPORTANT] Remove the currently active view controller
    [AATSDK controllerViewWillDisappear];
    // [IMPORTANT] Stop placement autoreload
    [self.placement stopAutoReload];
}

#pragma mark - AATStickyBannerPlacementDelegate
- (void)aatHaveAdWithPlacement:(id<AATPlacement>)placement {
    // The placement has loaded a new ad
}

- (void)aatNoAdWithPlacement:(id<AATPlacement>)placement {
    // The placement could not load a new ad
}

- (void)aatPauseForAdWithPlacement:(id<AATPlacement> _Nonnull)placement {
    // Ad has been displayed on the screen
}

- (void)aatResumeAfterAdWithPlacement:(id<AATPlacement>)placement {
    // Back to the app after clicking on the ad
}
@end
```

{% endtab %}
{% endtabs %}