POBInterstitial Class Reference

Inherits from NSObject
Conforms to POBBidEvent
Declared in POBInterstitial.h

Overview

Displays Interstitial Ads.

– initWithPublisherId:profileId:adUnitId:eventHandler:

Initializes & returns a newly initialized Interstitial object with the specified POBInterstitialEvent implementaion and other details.

- (instancetype _Nullable)initWithPublisherId:(NSString *)publisherId profileId:(NSNumber *)profileId adUnitId:(NSString *)adUnitId eventHandler:(id<POBInterstitialEvent>)eventHandler

Parameters

publisherId

Unique identifier assigned at the time of publisher onboarding.
profileId

Profile id.
adUnitId

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

Object conforming to POBInterstitialEvent protocol

Return Value

Instance of POBInterstitial

Declared In

POBInterstitial.h

– initWithPublisherId:profileId:adUnitId:

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

- (instancetype _Nullable)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 POBInterstitial

Declared In

POBInterstitial.h

– loadAd

Initiates the loading of an interstitial ad

- (void)loadAd

Declared In

POBInterstitial.h

– loadAdWithResponse:

Loads an interstitial ad from the provided RTB response

- (void)loadAdWithResponse:(NSString *)response

Parameters

response

response string as per Open-RTB 2.5 standard

Declared In

POBInterstitial.h

– bid

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

- (POBBid *)bid

Declared In

POBInterstitial.h

– showFromViewController:

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

- (void)showFromViewController:(UIViewController *)controller

Parameters

controller

UIViewController to be used for presenting the interstitial ad.

Declared In

POBInterstitial.h

  delegate

Sets the POBInterstitialDelegate delegate receiver for the interstitial ad

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

Discussion

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 POBInterstitial’s object reference.

Declared In

POBInterstitial.h

  request

Object representing bid request

@property (nonatomic, readonly) POBRequest *request

Discussion

You may set some additional targeting parameters on this object

See Also

Declared In

POBInterstitial.h

  impression

Managed impression object created internally. It provides APIs to set PubMatic zone id and other custom parameterss

@property (nonatomic, readonly) POBImpression *impression

Declared In

POBInterstitial.h

  isReady

Returns YES if the interstitial is ready to be displayed. The delegate’s interstitialDidReceiveAd: will be called after this property switches from NO to YES.

@property (nonatomic, assign, readonly) BOOL isReady

Declared In

POBInterstitial.h

  videoDelegate

Sets the POBInterstitialVideoDelegate delegate receiver for the interstitial ad which will notify about VAST based video events. Renderer which does not render VAST videos in Interstitial, may avoid setting this delegate.

@property (nonatomic, weak) id<POBInterstitialVideoDelegate> videoDelegate

Declared In

POBInterstitial.h