Banner Ad

1. Basic requirements

• Add ​ADX iOS SDK to your project.

• Use the Ad Unit ID issued for Banner Ads.

• Before requesting an ad, SDK initialization must be done first.

  • SDK initialization should be called only once when the app launches and ad requests should be made after SDK initialization is complete.

  • For iOS 14 and later, request ads only after obtaining ATT (App Tracking Transparency) permission.

2. Implementation

1. Instantiate an ADXAdView using the initWithAdUnitId:adSize:rootViewController: method and register the ADXAdViewDelegate callbacks.

   ADXAdSize	Size (width * height)
   ADXAdSizeBanner	320 * 50
   ADXAdSizeLargeBanner	320 * 100
   ADXAdSizeMediumRectangle	320 * 250
   ADXAdSizeLeaderboard	728 * 90

2. Set the frame of the bannerView and add it to the ViewController.

3. Call loadAd to request an ad.

Objective-C

#import <ADXLibrary/ADXAdView.h>

@interface BannerViewController () <ADXAdViewDelegate>

@property (strong) ADXAdView *bannerView;

@end

@implementation BannerViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    self.bannerView = [[ADXAdView alloc] 
        initWithAdUnitId:@"<ADX_BANNER_AD_UNIT_ID>"
        adSize:ADXAdSizeBanner
        rootViewController:self];

    self.bannerView.delegate = self;
    
    self.bannerView.frame = CGRectMake(
        (self.view.bounds.size.width - ADXAdSizeBanner.width) / 2,
        0,
        ADXAdSizeBanner.width,
        ADXAdSizeBanner.height);
    
    [self.view addSubview:self.bannerView];
    
    [self.bannerView loadAd];
}

#pragma mark - ADXAdViewDelegate

- (void)adViewDidLoad:(ADXAdView *)adView {
    NSLog(@"adViewDidLoad");
}

- (void)adView:(ADXAdView *)adView didFailToLoadWithError:(NSError *)error {
    NSLog(@"adView:didFailToLoadWithError: %@", error);
    
}
- (void)adViewDidClick:(ADXAdView *)adView {
    NSLog(@"adViewDidClick");
}

Swift

import UIKit
import ADXLibrary

class BannerViewController: UIViewController {
    
    var bannerView : ADXAdView!
    
    override func viewDidLoad() {
        super.viewDidLoad()

        bannerView = ADXAdView(
            adUnitId: "<ADX_BANNER_AD_UNIT_ID>", 
            adSize: ADXAdSizeBanner, 
            rootViewController: self)

        bannerView.delegate = self
        
        bannerView.frame = CGRect(
            x: (UIScreen.main.bounds.size.width - ADXAdSizeBanner.width) / 2,
            y: 0,
            width: ADXAdSizeBanner.width,
            height: ADXAdSizeBanner.height)
            
        view.addSubview(bannerView)
        
        bannerView.loadAd()
    }
}

extension BannerViewController: ADXAdViewDelegate {
    
    func adViewDidLoad(_ adView: ADXAdView) {
        print("adViewDidLoad");
    }
    
    func adView(_ adView: ADXAdView, didFailToLoadWithError error: Error) {
        print("adView:didFailToLoadWithError")
    }
    
    func adViewDidClick(_ adView: ADXAdView) {
        print("adViewDidClick")
    }
}

3. Callback

You can receive banner ad events through the ADXAdViewDelegate.

Objective-C

- (void)adViewDidLoad:(ADXAdView *)adView;
- (void)adView:(ADXAdView *)adView didFailToLoadWithError:(NSError *)error;
- (void)adViewDidClick:(ADXAdView *)adView;

Swift

func adViewDidLoad(_ adView: ADXAdView)
func adView(_ adView: ADXAdView, didFailToLoadWithError error: Error)
func adViewDidClick(_ adView: ADXAdView)

4. Ad Revenue (paidEventHandler)

You can check the estimated ad revenue for ad impressions.

• As shown in the example below, use paidEventHandler to check the estimated eCPM value.

• Manually set values during mediation setup and actual values may be mixed, so it is recommended to treat this as an estimate.

• The currency unit of eCPM is USD.

• You can link ad revenue data with your MMP. For details, please refer to the SDK integration guides below:

  • Adjust’s ADX SDK Integration Guide

  • Airbridge’s ADX SDK Integration Guide

Objective-C

#import <UIKit/UIKit.h>
#import <ADXLibrary/ADXAdView.h>
#import <FirebaseAnalytics/FirebaseAnalytics.h>
#import <AppsFlyerAdRevenue/AppsFlyerAdRevenue.h>

@interface BannerViewController () <ADXAdViewDelegate>
@property (strong) ADXAdView * bannerView;
@end

@implementation BannerViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    self.bannerView = [[ADXAdView alloc] 
        initWithAdUnitId:@"<ADX_BANNER_AD_UNIT_ID>"
        adSize:ADXAdSizeBanner
        rootViewController:self];
                        
    self.bannerView.delegate = self;    
    
    __weak typeof(self) weakSelf = self;
    self.bannerView.paidEventHandler = ^(double eCPM) {
        __strong typeof(self) strongSelf = weakSelf;
        if(!strongSelf) { return; }
        NSNumber * revenue = [NSNumber numberWithDouble:eCPM/1000];
        [strongSelf handleAdRevenue:revenue];
    };
}

- (void)handleAdRevenue:(NSNumber *)revenue {
    // 1) Firebase Analytics
    [FIRAnalytics logEventWithName:kFIREventAdImpression
                        parameters: @{
        kFIRParameterAdPlatform: @"AD(X)",
        kFIRParameterAdFormat: @"BannerAd",
        kFIRParameterAdUnitName: @"ADX Banner Ad",
        kFIRParameterCurrency: @"USD",
        kFIRParameterValue: revenune
    }];
    
    // 2) AppsFlyer
    NSDictionary * adRevenueParams = @{
        @"AdUnitName" : @"ADX Banner Ad",
        @"AdType" : @"BannerAd",
    };
    
    AppsFlyerAdRevenue * appsFlyerAdRevenue = [AppsFlyerAdRevenue shared];
    [appsFlyerAdRevenue 
        logAdRevenueWithMonetizationNetwork:@"AD(X)"
        mediationNetwork:AppsFlyerAdRevenueMediationNetworkTypeCustom
        eventRevenue:revenune
        revenueCurrency:@"USD"
        additionalParameters:adRevenueParams];
}

#pragma mark - ADXAdViewDelegate
- (void)adViewDidLoad:(ADXAdView *)adView {}
- (void)adView:(ADXAdView *)adView didFailToLoadWithError:(NSError *)error {}
- (void)adViewDidClick:(ADXAdView *)adView {}

@end

Swift

import UIKit
import ADXLibrary
import FirebaseAnalytics
import AppsFlyerAdRevenue

class BannerAdViewController: UIViewController {

    var bannerView : ADXAdView!
    
    override func viewDidLoad() {
        super.viewDidLoad()

        bannerView = ADXAdView(adUnitId: "<ADX_BANNER_AD_UNIT_ID>")
        bannerView.delegate = self
        bannerView.paidEventHandler = { [weak self] eCPM in
            let revenue:NSNumber = (eCPM / 1000) as NSNumber
            self?.handleAdRevenue(revenue: revenue)
        }
    }
    
    func handleAdRevenue(revenue:NSNumber) {
        // 1) Firebase Analytics
        Analytics.logEvent(
            AnalyticsEventAdImpression,
            parameters: [
                AnalyticsParameterAdPlatform: "AD(X)",
                AnalyticsParameterAdUnitName: "ADX Banner Ad",
                AnalyticsParameterAdFormat: "BannerAd",
                AnalyticsParameterValue: revenune,
                AnalyticsParameterCurrency: "USD",
            ])
        
        // 2) AppsFlyer
        let adRevenueParams:[AnyHashable: Any] = [
            "AdUnitName" : "ADX Banner Ad",
            "AdType" : "BannerAd",
        ]
        
        AppsFlyerAdRevenue.shared().logAdRevenue(
            monetizationNetwork: "AD(X)",
            mediationNetwork: .custom,
            eventRevenue: revenune,
            revenueCurrency: "USD",
            additionalParameters: adRevenueParams)
    }
}

extension BannerViewController: ADXAdViewDelegate {
    func adViewDidLoad(_ adView: ADXAdView) {}
    func adView(_ adView: ADXAdView, didFailToLoadWithError error: Error) {}
    func adViewDidClick(_ adView: ADXAdView) {}
}