POBAppOpenAd Class Reference

Inherits from NSObject
Declared in POBAppOpenAd.h

Overview

Displays App Open Ads.

– initWithPublisherId:profileId:adUnitId:

Initializes & returns a newly initialized AppOpenAd object for supporting ‘No Ad Server Configuration’.

- (instancetype)initWithPublisherId:(NSString *)publisherId profileId:(NSNumber *)profileId adUnitId:(NSString *)adUnitId

Parameters

publisherId

Unique identifier assigned at the time of publisher onboarding.
profileId

Profile id.
adUnitId

Ad unit id used to identify a unique placement on screen.

Return Value

Instance of POBAppOpenAd

Discussion

Initializes & returns a newly initialized AppOpenAd object for supporting ‘No Ad Server Configuration’.

Declared In

POBAppOpenAd.h

– loadAd

Initiates the loading of an app open ad

- (void)loadAd

Discussion

Initiates the loading of an app open ad

Declared In

POBAppOpenAd.h

– loadAdWithResponse:forBiddingHost:

Initiates the loading of an app open ad with bid response for bidding host.

- (void)loadAdWithResponse:(NSString *)bidResponse forBiddingHost:(POBSDKBiddingHost)biddingHost

Parameters

bidResponse

Stringified JSON bid response as per Open-RTB standard.
biddingHost

Bidding host for which bid response is applicable.

Discussion

Initiates the loading of an app open ad with bid response for bidding host.

Declared In

POBAppOpenAd.h

– showFromViewController:

Presents an app open ad in full screen view. Calling this method has no effect until the ad is received (appOpenAdDidReceiveAd:) and is ready to show, i.e. ‘isReady’ flag is true.

- (void)showFromViewController:(UIViewController *)controller

Parameters

controller

UIViewController to be used for presenting the app open ad.

Discussion

Presents an app open ad in full screen view. Calling this method has no effect until the ad is received (appOpenAdDidReceiveAd:) and is ready to show, i.e. ‘isReady’ flag is true.

Declared In

POBAppOpenAd.h

  delegate

Sets the POBAppOpenAdDelegate delegate receiver for the app open ad

@property (nonatomic, weak) id<POBAppOpenAdDelegate> _Nullable delegate

Discussion

Sets the POBAppOpenAdDelegate delegate receiver for the app open ad

Warning: Proper reference management practices should be observed when using delegates.

Warning: Ensure that the delegate is set to nil prior to setting nil to POBAppOpenAd’s object reference.

Declared In

POBAppOpenAd.h

  videoDelegate

Sets the POBAppOpenAdVideoDelegate delegate to receive the video ad event.

@property (nonatomic, nullable, weak) id<POBAppOpenAdVideoDelegate> videoDelegate

Discussion

Sets the POBAppOpenAdVideoDelegate delegate to receive the video ad event.

Declared In

POBAppOpenAd.h

– bid

Returns the winning bid that will be used to render the ad

- (POBBid *_Nullable)bid

Discussion

Returns the winning bid that will be used to render the ad

Declared In

POBAppOpenAd.h

  request

Object representing bid request

@property (nonatomic, readonly) POBRequest *request

Discussion

Object representing bid request

You may set some additional targeting parameters on this object

See Also

Declared In

POBAppOpenAd.h

  impression

Managed impression object created internally. It provides APIs to set custom parameters

@property (nonatomic, readonly) POBImpression *impression

Discussion

Managed impression object created internally. It provides APIs to set custom parameters

Declared In

POBAppOpenAd.h

  isReady

Returns YES if the app open ad is ready to be displayed. The delegate’s appOpenAdDidReceiveAd: will be called after this property switches from NO to YES.

@property (nonatomic, assign, readonly) BOOL isReady

Discussion

Returns YES if the app open ad is ready to be displayed. The delegate’s appOpenAdDidReceiveAd: will be called after this property switches from NO to YES.

Declared In

POBAppOpenAd.h