Adaptive sticky banner

An adaptive sticky banner is a small, automatically updated ad placed at the bottom or top of the app screen. It doesn't overlap the main content and is often used in gaming apps.

The adaptive sticky banner delivers maximum performance by optimizing the ad size for each device. With this ad type, developers can set the maximum allowable ad width, and the system determines the optimal ad size automatically.

Appearance

This guide shows how to integrate adaptive sticky banners into iOS apps. In addition to code examples and instructions, it contains format-specific recommendations and links to additional resources.

Prerequisite

1. Follow the SDK integration steps described in Quick start.
2. Initialize your ad SDK in advance.
3. Make sure you're running the latest Yandex Mobile Ads SDK version. If you're using mediation, make sure you're also running the latest version of the unified build.

Implementation

Key steps for integrating adaptive sticky banners:

• Create a BannerAdView instance.
• Implement the delegate methods.
• Load the ad.
• Pass additional settings if you're using Adfox.
• Receive the ad in the delegate method and render it.

Features of adaptive sticky banner integration

1. All calls to Yandex Mobile Ads SDK methods must be made from the main thread.

2. We strongly advise against attempting to load a new ad when receiving an error in the func bannerAdViewDidFailLoading(_ bannerAdView: BannerAdView, error: Error) delegate method. If you need to load an ad from func bannerAdViewDidFailLoading(_ bannerAdView: BannerAdView, error: Error), restrict ad load retries to avoid recurring failed ad requests due to network connection constraints.

3. To make sure your adaptive sticky banners work correctly, use Auto Layout. Using a fixed-sized frame for the view may result in incorrect ad rendering.

4. Adaptive sticky banners work best when using all the available width. In most cases, that's the full width of the device screen. Make sure to include all padding and safe display areas applicable to your app.

5. Adaptive sticky banners are designed for placement in scrollable content. It can have the same height as the device screen or be limited to the maximum height depending on the API.

6. To get the ad size, use the BannerAdSize.sticky(containerWidth: CGFloat) method, passing the available ad container width as an argument.

7. The BannerAdSize object calculated using BannerAdSize.sticky(containerWidth: CGFloat) contains constant ad width and height values for the same device. Once you test your app layout on a specific device, you can be sure the ad size will not change.

8. The height of the adaptive sticky banner shouldn't exceed 15% of the screen height and should be at least 50 dp.

Creating a BannerAdView instance

To display banner ads, create a BannerAdView instance, passing only the ad size. You also need to set a delegate for BannerAdView by implementing the BannerAdViewDelegate protocol in your class.

Ads are sized for the device using the SDK method BannerAdSize.sticky(containerWidth:). Pass the maximum permissible width of the ad container. We recommend using the entire width of the device screen or the width of the parent container. Make sure you include all padding and safe display areas applicable to your app.

You will also need the ad unit ID (adUnitId) from the Yandex Advertising Network interface.

Example of creating a BannerAdView in a view controller:

final class StickyBannerViewController: UIViewController {
        private lazy var bannerAdView: BannerAdView = {
        let width = view.safeAreaLayoutGuide.layoutFrame.width
        let adSize = BannerAdSize.sticky(containerWidth: width)

        let bannerAdView = BannerAdView(adSize: adSize)
        bannerAdView.delegate = self
        bannerAdView.translatesAutoresizingMaskIntoConstraints = false
        return bannerAdView
    }()
}

extension StickyBannerViewController: BannerAdViewDelegate {
    func bannerAdViewDidLoad(_ bannerAdView: BannerAdView) {
        // Ad loaded successfully
    }

    func bannerAdViewDidFailLoading(_ bannerAdView: BannerAdView, error: Error) {
        // Failed to load
    }
}

Loading ads

After you create BannerAdView, you need to load the ad.

To get notified about successful or failed loads and to track the adaptive sticky banner lifecycle, set the delegate on the BannerAdView instance and implement BannerAdViewDelegate.

You can extend the ad request using AdRequest by passing user interests, page context, location, or other data. Additional contextual data can significantly improve ad quality. Read more in Ad targeting.

The following example shows how to load an adaptive sticky banner. After a successful load, func bannerAdViewDidLoad(_ bannerAdView: BannerAdView) of BannerAdViewDelegate is called:

final class StickyBannerViewController: UIViewController {
    private lazy var bannerAdView: BannerAdView = {
        let width = view.safeAreaLayoutGuide.layoutFrame.width
        let adSize = BannerAdSize.sticky(containerWidth: width)

        let bannerAdView = BannerAdView(adSize: adSize)
        bannerAdView.delegate = self
        bannerAdView.translatesAutoresizingMaskIntoConstraints = false
        return bannerAdView
    }()

    func loadAd() {
        let request = AdRequest(adUnitID: "R-M-XXXXX-YY")
        bannerAdView.loadAd(with: request)
    }
}

Displaying ads

After the ad loads successfully, you can render it in two ways:

final class StickyBannerViewController: UIViewController {
  private lazy var bannerAdView: BannerAdView = {
      let width = view.safeAreaLayoutGuide.layoutFrame.width
      let adSize = BannerAdSize.sticky(containerWidth: width)

      let bannerAdView = BannerAdView(adSize: adSize)
      bannerAdView.delegate = self
      bannerAdView.translatesAutoresizingMaskIntoConstraints = false
      return bannerAdView
  }()

  func showAd() {
      view.addSubview(bannerAdView)
      NSLayoutConstraint.activate([
          bannerAdView.topAnchor.constraint(equalTo: loadButton.bottomAnchor, constant: 100),
          bannerAdView.centerXAnchor.constraint(equalTo: view.centerXAnchor)
      ])
  }
}

final class StickyBannerViewController: UIViewController {
  private lazy var bannerAdView: BannerAdView = {
      let width = view.safeAreaLayoutGuide.layoutFrame.width
      let adSize = BannerAdSize.sticky(containerWidth: width)

      let bannerAdView = BannerAdView(adSize: adSize)
      bannerAdView.delegate = self
      bannerAdView.translatesAutoresizingMaskIntoConstraints = false
      return bannerAdView
  }()

  func showAd() {
      bannerAdView.displayAdBottom(in: view)
  }
}

Testing adaptive sticky banner integration

Using demo ad units for ad testing

We recommend using test ads to test your ad integration and your app itself.

To guarantee that test ads are returned for every ad request, we created a special demo ad placement ID. Use it to check your ad integration.

Demo adUnitId: demo-banner-yandex.

You can find the list of available demo ad placement IDs in the Demo ad units for testing section.

Testing ad integration

You can test your ad integration using the native Console tool.

To view detailed logs, call the YandexAds class's enableLogging method.

YandexAds.enableLogging()

To view SDK logs, go to the Console tool and set Subsystem = com.mobile.ads.ads.sdk. You can also filter logs by category and error level.

If you're having problems integrating ads, you'll get a detailed report on the issues and recommendations for how to fix them.

Additional resources

• Link to GitHub.