Banner Integration for Unity

Banners are a rectangular, system-initiated ads that can be either static or animated, and are served in a designated area around your live app content. 

Integrate and serve Banner ads through ironSource Mediation in a few easy steps:

  1. Implement the Banner Events
  2. Load Banner Ad
  3. Destroy the Banner Ad
  4. Integrate a Banner Provider

 

Before You Start

  • Make sure that you have correctly integrated the ironSource Unity Plugin into your application. Integration is outlined here.
  • Banner Mediation is supported in ironSource SDK 6.6.0 and above.
  • You will need to integrate one of our mediation adapters with Banner support to serve this ad unit.

    Step 1. Implement the Banner Events

    The ironSource Unity Plugin fires several events to inform you of ad availability and activity. Under IronSource/Assets/Prefabs, you’ll find the IronSourceEventsPrefab. Add it to your project to receive these events.

    public class VideoScript : MonoBehaviour {
      void Start() 
      {
        IronSourceEvents.onBannerAdLoadedEvent += BannerAdLoadedEvent;
        IronSourceEvents.onBannerAdLoadFailedEvent += BannerAdLoadFailedEvent;        
        IronSourceEvents.onBannerAdClickedEvent += BannerAdClickedEvent; 
        IronSourceEvents.onBannerAdScreenPresentedEvent += BannerAdScreenPresentedEvent; 
        IronSourceEvents.onBannerAdScreenDismissedEvent += BannerAdScreenDismissedEvent;
        IronSourceEvents.onBannerAdLeftApplicationEvent += BannerAdLeftApplicationEvent;
      }
    }
    //Invoked once the banner has loaded
    void BannerAdLoadedEvent() {
    }
    //Invoked when the banner loading process has failed.
    //@param description - string - contains information about the failure.
    void BannerAdLoadFailedEvent (IronSourceError error) {
    }
    // Invoked when end user clicks on the banner ad
    void BannerAdClickedEvent () {
     }
    //Notifies the presentation of a full screen content following user click
    void BannerAdScreenPresentedEvent () {
    }
    //Notifies the presented screen has been dismissed
    void BannerAdScreenDismissedEvent() {
    }
    //Invoked when the user leaves the app
    void BannerAdLeftApplicationEvent() {
     }
    

    Step 2. Load Banner Ad

    Load Banner

    To load a Banner ad, call the following method:

    IronSource.Agent.loadBanner(YOUR_BANNER_SIZE, YOUR_BANNER_POSITION);
    

    When loading the banner, make sure to configure your Banner Size and Position:

    IronSourceBannerSize Description Dimensions Ad Network Support
    BANNER Standard Banner
    Best for Phones & Tablets
    50 X screen width Admob, AppLovin, Facebook, InMobi
    LARGE_BANNER Large Banner
    Best for Tablets and Larger Devices
    90 X screen width Admob, Facebook,
    RECTANGLE_BANNER Large Rectangular Banner
    Best for Scrollable Feeds or Between Game Levels
    250 X screen width Admob, AppLovin, Facebook, InMobi
    SMART_BANNER Smart Banner
    Renders ads that automatically resize to fit the device’s size and orientation
    50 (screen height ≤ 720) X screen width
    90 (screen height > 720) X screen width
    Admob, AppLovin, Facebook, InMobi
    IronSourceBannerPosition Description
    TOP Banner will be positioned at the top center of the screen
    BOTTOM Banner will be positioned at the bottom center of the screen

    We support placements, as well as capping and pacing for Banners on the ironSource dashboard. Learn how to set up placements, capping and pacing for Banners to optimize your app’s user experience here.

    If you’ve set up placements for your Banner, call the following method to serve a Banner ad in a specific location:

    IronSource.Agent.loadBanner(YOUR_BANNER_SIZE, YOUR_BANNER_POSITION, YOUR_PLACEMENT_NAME);

    You will receive the onBannerAdLoadedEvent and the banner will show on your app.

    Hide & Display Banner

    In order to provide maximum flexibility in the ad experience, you now have the ability to hide and present banners on your app.

    Once you’ve loaded and served a banner, you can choose to hide this banner and re-show it at a later point in your app.

    To hide the banner, call this function:

    IronSource.Agent.hideBanner();

    To then show this same banner again, call this function:

    IronSource.Agent.displayBanner();

    Step 3. Destroy the Banner Ad

    Once you’ve successfully served a Banner, we recommend calling the below function to destroy the previous Banner.

    IronSource.Agent.destroyBanner();

    After you call this method, the Banner in question can no longer be used. In the case you want to serve it again, you will need to request a new Banner using the loadBanner method.

    Step 4.  Integrate a Banner Provider

    Next, integrate the ad network adapters to serve Banners through ironSource Mediation. We currently support Admob, AppLovinFacebook and InMobi Banners.

     

    Done!
    You are now all set up to serve Banners in your application. Verify your integration with our Integration Helper.


    What’s Next? 

    Follow our integration guides to integrate additional ad units:

     

    Interested in integrating more mediation adapters? Check out our supported Mediation Networks.