Skip to content

README ClassReference

MarkusOhADOP edited this page Nov 7, 2023 · 12 revisions

Class Reference for BidmadSDK-iOS

BidmadBannerAd

  • Banner Ad Class
Function Description
@property id <BIDMADOpenBiddingBannerDelegate> delegate Banner Ad Delegate Property
- (id)initWith:(UIViewController *) containerView:(UIView *) zoneID:(NSString *) Banner Ad Init Method
- (void)load Banner Ad Load Method
- (void)setRefreshInterval:(NSInteger) Banner Ad Refresh Time Setting Method
- (void)hide Banner Ad Hiding Method
- (void)show Banner Ad Showing Method (When Hidden)
- (void)remove Banner Ad Removal Method

BIDMADOpenBiddingBannerDelegate

  • Banner Ad Callback
Function Description
- (void)onLoadAd:(OpenBiddingBanner *) If loaded, this method gets called
- (void)onClickAd:(OpenBiddingBanner*) If Clicked, this method gets called
- (void)onLoadFailAd:(OpenBiddingBanner *) error:(NSError *) If Error, this method gets called

BidmadInterstitialAd

  • Interstitial Ad Class
Function Description
@property id <BIDMADOpenBiddingInterstitialDelegate> delegate Interstitial Ad Delegate Property
- (id)initWith:(UIViewController *) zoneID:(NSString *) Interstitial Ad Init Method
- (void)load Interstitial Ad Load Method
- (void)show Interstitial Ad Show Method
@property BOOL isAutoReload; Set true for auto-reload ad (when ad is shown, another ad is loaded automatically). Set false for NO auto reload
- (BOOL)isLoaded Check if the Interstitial Ad is loaded

BIDMADOpenBiddingInterstitialDelegate

  • Interstitial Callbacks
Function Description
- (void)onLoadAd:(OpenBiddingInterstitial *) If loaded, this method gets called
- (void)onShowAd:(OpenBiddingInterstitial *) If shown, this method gets called
- (void)onCloseAd:(OpenBiddingInterstitial *) If closed, this method gets called
- (void)onLoadFailAd:(OpenBiddingInterstitial *) error:(NSError *) If failed, this method gets called
- (void)onClickAd:(OpenBiddingInterstitial *) If clicked, this mehtod gets called

BidmadRewardAd

  • Reward Ad Class
Function Description
@property id <BIDMADOpenBiddingRewardVideoDelegate> delegate Reward Ad Delegate Property
- (id)initWith:(UIViewController *) zoneID:(NSString *) Reward Ad Init Method
- (void)load Reward Ad Load Method
- (void)show Reward Ad Show Method
@property BOOL isAutoReload; Set true for auto-reload ad (when ad is shown, another ad is loaded automatically). Set false for NO auto reload
- (BOOL)isLoaded Check if the Reward Ad is loaded

BIDMADOpenBiddingRewardVideoDelegate

  • Reward Callbacks
Function Description
- (void)onSkipAd:(OpenBiddingRewardVideo *) If skipped, this method gets called
- (void)onLoadAd:(OpenBiddingRewardVideo *) If loaded, this method gets called
- (void)onShowAd:(OpenBiddingRewardVideo *) If shown, this method gets called
- (void)onClickAd:(OpenBiddingRewardVideo *) If Clicked, this method gets called
- (void)onCloseAd:(OpenBiddingRewardVideo *) If closed, this method gets called
- (void)onCompleteAd:(OpenBiddingRewardVideo *) If watching success, this method gets called
- (void)onLoadFailAd:(OpenBiddingRewardVideo *) error:(NSError *) If failed, this method gets called

BidmadAppOpenAd

  • BidmadAppOpenAd Class
Function Description
@property id <OpenBiddingAppOpenAdDelegate> delegate AppOpen Ad Delegate Property
- (id)initWith:(UIViewController *) zoneID:(NSString *) AppOpen Ad Init Method
- (void)load AppOpen Ad Load Method
- (void)show AppOpen Ad Show Method
- (void)deregisterForAppOpenAd AppOpen Ad Deregister from Auto Loading
- (BOOL)isLoaded Check if the AppOpen Ad is loaded

OpenBiddingAppOpenAdDelegate

  • AppOpen Ad Callbacks
Function Description
- (void)onLoadAd:(OpenBiddingAppOpenAd *) If loaded, this method gets called
- (void)onShowAd:(OpenBiddingAppOpenAd *) If shown, this method gets called
- (void)onClickAd:(OpenBiddingAppOpenAd *) If Clicked, this method gets called
- (void)onCloseAd:(OpenBiddingAppOpenAd *) If closed, this method gets called
- (void)onLoadFailAd:(OpenBiddingAppOpenAd *) error:(NSError *) If failed, this method gets called

BidmadCommon

  • BidmadCommon Class
Function Description
+ (void)setAdvertiserTrackingEnabled:(BOOL) Advertiser Tracking Setting for Facebook Ad Network
+ (BOOL)getAdvertiserTrackingEnabled Get Advertiser Tracking Setting
+ (void)reqAdTrackingAuthorizationWith:(void (^)(BidmadTrackingAuthorizationStatus)) Request and Show App Tracking Transparency Popup
+ (void)setIsChildDirectedAds:(BOOL) Set if child is using for COPPA Compliance
+ (void)setUserConsentStatusForCCPACompliance:(BOOL) Set consent for CCPA Compliance
+ (void)setIsDebug:(BOOL) Expose debug logs
+ (BOOL)isDebug Get if Debug logs are exposed
+ (NSString *)bidmadVersion Get the bidmad version
+ (void)setTestDeviceId:(NSString *) Set Test Device ID for Google Ad Networks
+ (NSString *)testDeviceId Get Test Device ID
+ (NSNumber *)isChildDirectedTreament Get Property of Child directed ad setting
+ (NSNumber *)isUserConsentCCPA Get Property of CCPA Consent
+ (void)initializeSdk Initialize Ad Networks supported by BidmadSDK
+ (void)setCuid:(NSString *) Set the CUID string for server side callback
+ (void)setUseServerSideCallback:(BOOL) Set whether server side callback should be used

BidmadNativeAd

  • Native Ad Class
Function Description
- (id)initWithZoneID:(NSString *)zoneID Native Ad Init Method
- (void)load Native Ad Load Method
- (void)setRootViewController:(UIViewController *) adView:(BIDMADNativeAdView *) Setting the view controller and ad view before viewing the ad
- (void)removeAdView:(BIDMADNativeAdView *) Removing the ad from ad view before the cell disappears from table view
+ (BIDMADNativeAdView *)findAdViewFromSuperview:(UIView *)superview find the ad view from the container view
@property id <BidmadNativeAdDelegate> delegate Native Ad Delegate Property
@property (readonly) BOOL isLoaded Check if the ad is loaded
@property (nonatomic, strong) NSString *zoneID Get the zone id associated with the native ad

BidmadNativeAdDelegate

  • Native Ad Callback
Function Description
- (void)onLoadAd:(BidmadNativeAd *)bidmadAd If loaded, this method gets called
- (void)onClickAd:(BidmadNativeAd *)bidmadAd If Clicked, this method gets called
- (void)onLoadFailAd:(BidmadNativeAd *) error:(NSError *) If Error, this method gets called

BidmadAdFreeInformation

  • This class provides events to let user know when to show or hide advertisements
Function Description
+ (BidmadAdFreeInformationStatus)status the current status of ad free
+ (void)setDelegate:(id<BidmadAdFreeInformationDelegate>) setting the delegate where callback will be given to. The callback will be given when the status changes

BidmadAdFreeInformationDelegate

  • This delegate is set to let the app know changes in ad free status
Function Description
- (void)didAdFreeInformationStatusChange:(BidmadAdFreeInformationStatus) When the status changes, this function gets called

BidmadAdFreeInformationStatus

  • This is an enum structurue that shows status whether the advertisement should be blocked (not shown) or passed (shown).
Case Description
BidmadAdFreeInformationStatusPassed Advertisement should be shown to the user of your app
BidmadAdFreeInformationStatusBlocked Advertisement should not be shown to the user of your app
Clone this wiki locally