Custom Banner Ad Adapter

💡Tips: The class name can be customized, but it must be consistent with the custom ad platform class name configured in the backend. For example, if the adapter class name added in the backend is: DemoCustomBannerAdapter, you need to create the corresponding DemoCustomBannerAdapter.m file.

1. Recommended File Structure

Banner/
├── DemoCustomBannerAdapter.h          # Banner ad adapter header file
├── DemoCustomBannerAdapter.m          # Banner ad adapter implementation file
├── DemoCustomBannerDelegate.h         # Banner ad delegate header file
└── DemoCustomBannerDelegate.m         # Banner ad delegate implementation file

2. Required Methods to Override

• You need to inherit from DemoCustomBaseAdapter and override the relevant methods:
• When developers call the ad loading API, the custom Adapter's loadADWithArgument: method will be called

3. Callback Method Description

Banner ad adapters support the following callback methods, which inherit from the ATBaseTrackProtocol and ATBannerTrackProtocol protocols:

3.1 Basic Ad Event Callbacks

3.2 Banner Ad Specific Event Callbacks

4. Implementation Steps

4.1 Implement DemoCustomBannerDelegate.h

1. Import header file #import <AnyThinkSDK.h>
2. Add property: @property (nonatomic, strong) ATBannerAdStatusBridge * adStatusBridge;
3. Conform to your third-party ad SDK banner ad callback protocol

Example:

objc Copy

#import <AnyThinkSDK/AnyThinkSDK.h>
#import <Foundation/Foundation.h>
#import "DemoCustomAdapterCommonHeader.h"

@interface DemoCustomBannerDelegate : NSObject<YourBannerViewDelegate>

@property (nonatomic, strong) ATBannerAdStatusBridge * adStatusBridge;

@end

4.2 Implement DemoCustomBannerDelegate.m

1. Implement your third-party SDK's protocol methods, such as ad load success, ad click, ad close, etc.
2. In the third-party SDK ad load success event, call to notify us of ad load success and pass back our Banner object, for example:

objc Copy

/**
   Platform ad is ready and can be displayed
 */
- (void)yourBannerAdReadySuccess:(YourBannerView *)bannerAd { // This is the third-party SDK's protocol method, called when ad loads successfully
    // Pass the banner ad object from the third-party ad SDK callback to our mediation SDK
    [self.adStatusBridge atOnBannerAdLoadedWithView:bannerAd adExtra:@{}];
}

3. In the third-party SDK's ad load failure event, call to notify us of ad load failure, for example:

objc Copy

/**
 * Called after ad request fails
 */
- (void)yourBannerError:(YourBannerView *)bannerAd error:(NSError *)error { // This is the third-party SDK's protocol method, called when ad loading fails
    // Notify us of load failure
    [self.adStatusBridge atOnAdLoadFailed:error adExtra:nil];
}

4. Refer to our SDK's ATBannerTrackProtocol and ATBaseTrackProtocol protocols, implement other ad events and notify us, for example:

objc Copy

/**
 *  Banner click callback
 */
- (void)yourBannerClicked:(YourBannerView *)bannerAd {
    [self.adStatusBridge atOnAdClick:nil];
}

4.3 Implement DemoCustomBannerAdapter.h

1. Inherit from DemoCustomBaseAdapter
2. Import header file #import <AnyThinkSDK.h>
3. Conform to ATBaseBannerAdapterProtocol protocol

4.4 Implement DemoCustomBannerAdapter.m

1. Add the following properties:

objc Copy

@interface DemoCustomBannerAdapter()

// Implemented in step 1 of this document
@property (nonatomic, strong) DemoCustomBannerDelegate * bannerDelegate;

// Third-party SDK's banner ad object
@property (nonatomic, strong) YourBannerView *bannerView;

@end

2. Initialize the bannerDelegate property

objc Copy

#pragma mark - lazy
- (DemoCustomBannerDelegate *)bannerDelegate{
    if (_bannerDelegate == nil) {
        _bannerDelegate = [[DemoCustomBannerDelegate alloc] init];
        _bannerDelegate.adStatusBridge = self.adStatusBridge;
    }
    return _bannerDelegate;
}

3. Implement the ad loading method:

objc Copy

#pragma mark - Ad load
- (void)loadADWithArgument:(ATAdMediationArgument *)argument {
    dispatch_async(dispatch_get_main_queue(), ^{ // Usually needs to be executed on the main thread
        // Get necessary loading information through the argument object, such as size, create necessary parameters, prepare to pass to the third-party banner loading method, start loading ads
        CGSize bannerSize = CGSizeMake(320, 50);
        if (!CGSizeEqualToSize(argument.bannerSize, CGSizeZero)) {
            bannerSize = argument.bannerSize;
        }
        
        self.bannerView = [[YourBannerView alloc] initWithFrame:CGRectMake(0, 0, bannerSize.width, bannerSize.height)];
        // Note: Set delegate to DemoCustomBannerDelegate
        self.bannerView.delegate = self.bannerDelegate;
        
        YourBannerAdConfigParams *adParam = [[YourBannerAdConfigParams alloc]init];
        adParam.showCloseBtn = NO;
        adParam.interval = 0;
        // Call the third-party ad SDK's loading method
        [self.bannerView loadAdAndShowWithPid:argument.serverContentDic[@"slot_id"] presentVC:argument.viewController adParams:adParam];
    });
}