Skip to content

[ENG] iOS API API Migration Guide

MarkusOhADOP edited this page Dec 17, 2021 · 1 revision

v4.1.0.0 API Migration Guide

In v4.1.0.0, OBH and SDK were integrated, and a new API was added for SDK operation after integration.
The existing API has not been removed and can still be called, but please switch to the new API for normal operation in v4.1.0.0 and later versions.
APIs that have been changed or removed from the new API can be checked in the table below, and for a detailed API list, please check Reference.


4.0.1.1 or less 4.1.0.0 or later
Class / Delegate Protocol Methods Class / Delegate Protocol Methods
BIDMADBanner /
OpenBiddingBanner
- (id)initWithParentViewController:(UIViewController) rootView:(UIView) BidmadBannerAd - (id)initWith:(UIViewController) containerView:(UIView) zoneID:(NSString)
@property NSString zoneID Removed
@property id<BIDMADBannerDelegate> delegate @property id <BIDMADOpenBiddingBannerDelegate> delegate
- (void)requestBannerView - (void)load
@property (nonatomic, assign) int refreshInterval - (void)setRefreshInterval:(NSInteger)
- (void)hideView - (void)hide
- (void)showView - (void)show
- (void)removeAds - (void)remove
BIDMADBannerDelegate - (void)BIDMADBannerClosed:(BIDMADBanner) BIDMADOpenBiddingBannerDelegate - (void)BIDMADOpenBiddingBannerClosed:(OpenBiddingBanner)
- (void)BIDMADBannerLoad:(BIDMADBanner) - (void)BIDMADOpenBiddingBannerLoad:(OpenBiddingBanner)
- (void)BIDMADBannerClick:(BIDMADBanner) - (void)BIDMADOpenBiddingBannerClick:(OpenBiddingBanner)
- (void)BIDMADBannerAllFail:(BIDMADBanner) - (void)BIDMADOpenBiddingBannerAllFail:(OpenBiddingBanner)
- (void)BIDMADBannerError:(BIDMADBanner) code:(NSString) Removed
BIDMADInterstitial /
OpenBiddingInterstitial
- (id)init BidmadInterstitialAd - (id)initWith:(UIViewController) zoneID:(NSString)
@property NSString zoneID Removed
@property UIViewController parentViewController Removed
@property id<BIDMADInterstitialDelegate> delegate @property id <BIDMADOpenBiddingInterstitialDelegate> delegate
- (void)loadInterstitialView - (void)load
- (void)showInterstitialView - (void)show
- (void)removeInterstitialADS Removed
@property BOOL isLoaded - (BOOL)isLoaded
BIDMADInterstitialDelegate - (void)BIDMADInterstitialLoad:(BIDMADInterstitial) BIDMADOpenBiddingInterstitialDelegate - (void)BIDMADOpenBiddingInterstitialLoad:(OpenBiddingInterstitial)
- (void)BIDMADInterstitialShow:(BIDMADInterstitial) - (void)BIDMADOpenBiddingInterstitialShow:(OpenBiddingInterstitial)
- (void)BIDMADInterstitialClose:(BIDMADInterstitial) - (void)BIDMADOpenBiddingInterstitialClose:(OpenBiddingInterstitial)
- (void)BIDMADInterstitialAllFail:(BIDMADInterstitial) - (void)BIDMADOpenBiddingInterstitialAllFail:(OpenBiddingInterstitial)
- (void)BIDMADInterstitialError:(BIDMADInterstitial) code:(NSString) Removed
BIDMADRewardVideo /
OpenBiddingRewardVideo
- (id)init BidmadRewardAd - (id)initWith:(UIViewController) zoneID:(NSString)
@property NSString zoneID Removed
@property UIViewController parentViewController Removed
@property id<BIDMADRewardVideoDelegate> delegate @property id <BIDMADOpenBiddingRewardVideoDelegate> delegate
@property BOOL isLoaded - (BOOL)isLoaded
- (void)loadRewardVideo - (void)load
- (void)showRewardVideo - (void)show
BIDMADRewardVideoDelegate - (void)BIDMADRewardSkipped:(BIDMADRewardVideo) BIDMADOpenBiddingRewardVideoDelegate - (void)BIDMADOpenBiddingRewardSkipped:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoLoad:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoLoad:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoShow:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoShow:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoClick:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoClick:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoClose:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoClose:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoSucceed:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoSucceed:(OpenBiddingRewardVideo)
- (void)BIDMADRewardVideoAllFail:(BIDMADRewardVideo) - (void)BIDMADOpenBiddingRewardVideoAllFail:(OpenBiddingRewardVideo)
BIDMADRewardInterstitial - (id)init BidmadRewardInterstitialAd - (id)initWith:(UIViewController) zoneID:(NSString)
@property NSString zoneID Removed
@property UIViewControllerparentViewController Removed
@property id<BIDMADRewardInterstitialDelegate> delegate @property id <OpenBiddingRewardInterstitialDelegate> delegate
@property BOOL isLoaded - (BOOL)isLoaded
- (void) requestRewardInterstitial - (void)load
- (void) showRewardInterstitialView - (void)show
BIDMADRewardInterstitialDelegate - (void)BIDMADRewardInterstitialLoad:(BIDMADRewardInterstitial) OpenBiddingRewardInterstitialDelegate - (void)OpenBiddingRewardInterstitialLoad:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialShow:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialShow:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialClick:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialClick:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialClose:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialClose:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialSkipped:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialSkipped:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialSuccess:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialSuccess:(OpenBiddingRewardInterstitial)
- (void)BIDMADRewardInterstitialAllFail:(BIDMADRewardInterstitial) - (void)OpenBiddingRewardInterstitialAllFail:(OpenBiddingRewardInterstitial)
BIDMADAppOpenAd - (id)init BidmadAppOpenAd - (id)initWith:(UIViewController) zoneID:(NSString)
@property NSString zoneID Removed
@property id<BIDMADAppOpenAdDelegate> delegate @property id <OpenBiddingAppOpenAdDelegate> delegate
@property BOOL isLoaded - (BOOL)isLoaded
- (void)requestAppOpenAd - (void)load
- (void)showAppOpenAd - (void)show
- (void)registerForAppOpenAdForZoneID: (NSString) Removed (Once BidmadAppOpenAd is Initialized, Automatically Registered)
- (void)deregisterForAppOpenAd - (void)deregisterForAppOpenAd
BIDMADAppOpenAdDelegate - (void)BIDMADAppOpenAdLoad:(BIDMADAppOpenAd) OpenBiddingAppOpenAdDelegate - (void)OpenBiddingAppOpenAdLoad:(OpenBiddingAppOpenAd)
- (void)BIDMADAppOpenAdShow:(BIDMADAppOpenAd) - (void)OpenBiddingAppOpenAdShow:(OpenBiddingAppOpenAd)
- (void)BIDMADAppOpenAdClick:(BIDMADAppOpenAd) - (void)OpenBiddingAppOpenAdClick:(OpenBiddingAppOpenAd)
- (void)BIDMADAppOpenAdClose:(BIDMADAppOpenAd) - (void)OpenBiddingAppOpenAdClose:(OpenBiddingAppOpenAd)
- (void)BIDMADAppOpenAdAllFail:(BIDMADAppOpenAd) code:(NSString) - (void)OpenBiddingAppOpenAdAllFail:(OpenBiddingAppOpenAd) code:(NSString)
BIDMADOfferwall - (id)initWithZoneId:(NSString) BidmadOfferwallAd - (id)initWith:(UIViewController) zoneID:(NSString)
@property UIViewController parentViewController Removed
@property NSString zoneID Removed
@property id<BIDMADOfferwallDelegate> delegate @property id <BIDMADOfferwallDelegate> delegate
@property BOOL isLoaded - (BOOL)isLoaded
- (void)loadOfferwall - (void)load
- (void)showOfferwall - (void)show
- (void)getCurrencyBalance - (void)getCurrencyWithCurrencyReceivalCompletion:(void (^)(BOOL, NSInteger))
- (void)spendCurrency:(int) - (void)spendCurrency:(NSInteger) currencySpenditureCompletion:(void (^)(BOOL, NSInteger))
BIDMADOfferwallDelegate - (void)BIDMADOfferwallGetCurrencyBalanceSuccess:(BIDMADOfferwall) currencyName:(NSString) balance:(int) BIDMADOfferwallDelegate Replaced (CompletionHandler from getCurrencymethod handles callback)
- (void)BIDMADOfferwallGetCurrencyBalanceFail:(BIDMADOfferwall) error:(NSString) Replaced (CompletionHandler from getCurrencymethod handles callback)
- (void)BIDMADOfferwallSpendCurrencySuccess:(BIDMADOfferwall) currencyName:(NSString) balance:(int) Replaced (CompletionHandler from spendCurrency method handles callback)
- (void)BIDMADOfferwallSpendCurrencyFail:(BIDMADOfferwall) error:(NSString) Replaced (CompletionHandler from spendCurrency method handles callback)
BIDMADSetting - (void)setAdvertiserTrackingEnabled:(BOOL) BidmadCommon + (void)setAdvertiserTrackingEnabled:(BOOL)
- (BOOL)getAdvertiserTrackingEnabled + (BOOL)getAdvertiserTrackingEnabled
- (void)reqAdTrackingAuthorizationWithCompletionHandler:(CompleteHandler) + (void)reqAdTrackingAuthorizationWith:(void (^)(BidmadTrackingAuthorizationStatus))
- (void)setIsChildDirectedAds: (BOOL) + (void)setIsChildDirectedAds:(BOOL)
- (void)setUserConsentStatusForCCPACompliance: (BOOL) + (void)setUserConsentStatusForCCPACompliance:(BOOL)
- (void)setIsDebug:(BOOL) + (void)setIsDebug:(BOOL)
- (BOOL)isDebug + (BOOL)isDebug
@property NSString version + (NSString)bidmadVersion
- (void)setTestDeviceId:(NSString) + (void)setTestDeviceId:(NSString)
- (NSString)testDeviceId + (NSString)testDeviceId
@property NSNumber isChildDirectedTreament + (NSNumber)isChildDirectedTreament
@property NSNumber isUserConsentCCPA + (NSNumber)isUserConsentCCPA