com.pubmatic.sdk.openwrap.banner

Class POBBannerView

java.lang.Object

FrameLayout

com.pubmatic.sdk.openwrap.banner.POBBannerView

All Implemented Interfaces:

POBBidEvent

@MainThread
public class POBBannerView
extends FrameLayout
implements POBBidEvent

The view class that displays the banner ad.

It renders a banner ad from either the ad server SDK or open wrap partner whichever gets a chance in the auction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	POBBannerView.POBAdState Banner ad states
static class	POBBannerView.POBBannerViewListener Static member class for interaction with the POBBannerView.

Nested classes/interfaces inherited from interface com.pubmatic.sdk.openwrap.core.POBBidEvent

POBBidEvent.BidEventError

Constructor Summary

Constructors

Constructor and Description
POBBannerView(Context context) Used to create instances when placed in XML layouts.
POBBannerView(Context context, AttributeSet attrs) Used to create instances when placed in XML layouts.
POBBannerView(Context context, AttributeSet attrs, int defStyle) Used to create instances when placed in XML layouts with default style.
POBBannerView(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, POBAdSize... adSizes) Constructor Initializes and returns a newly allocated banner view object for supporting 'No Ad Server Configuration' Publisher should create object of POBBannerView using this constructor when instantiating from code.
POBBannerView(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, com.pubmatic.sdk.openwrap.banner.POBBannerEvent event) Constructor Initializes and returns a newly allocated banner view object Publisher should create object of POBBannerView using this constructor when instantiating from java code.

Method Summary

Modifier and Type	Method and Description
void	destroy() Invoke this method when your activity/fragment is about to destroy.
boolean	forceRefresh() Cancels existing ad requests and initiates new ad request.
POBRequest	getAdRequest() Returns an Object representing OpenWrap ad request.
POBBid	getBid() Get bid
POBAdSize	getCreativeSize() Returns the Size of the rendered ad creative
POBImpression	getImpression() Returns an instance of impression object created internally.
void	init(java.lang.String publisherId, int profileId, java.lang.String adUnitId, POBAdSize... adSizes) Initializes newly allocated banner view object for supporting 'No Ad Server Configuration' Invoke this method only if POBBannerView is inflated via xml resource.
void	init(java.lang.String publisherId, int profileId, java.lang.String adUnitId, com.pubmatic.sdk.openwrap.banner.POBBannerEvent event) Initializes newly allocated banner view object.
void	loadAd() Initiate the loading of a banner ad, if the POBRequest is available then it proceeds with further execution else it will log error
void	loadAd(java.lang.String bidResponse) Initiates the loading of a banner ad with oRTB bid response.
void	pauseAutoRefresh() Pauses the auto refresh, By default, banner refreshes automatically as per configured refresh interval on OpenWrap portal.
void	proceedOnError(POBBidEvent.BidEventError error, java.lang.String errorMessage) Introduced in OpenWrapSDK v3.6.0
boolean	proceedToLoadAd() Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread.
void	resumeAutoRefresh() Resumes the auto-refresh as per configured refresh interval on OpenWrap portal, call this method only if you have previously paused auto-refresh using `pauseAutoRefresh()`.
void	setBidEventListener(POBBidEventListener bidEventListener) Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener
void	setListener(POBBannerView.POBBannerViewListener listener) Sets instance of POBBannerViewListener for the Banner view.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

POBBannerView

public POBBannerView(@NonNull
                     Context context)

Used to create instances when placed in XML layouts. The view should be positioned like any other view.

Parameters:

context - Activity context

POBBannerView

public POBBannerView(@NonNull
                     Context context,
                     @Nullable
                     AttributeSet attrs)

Used to create instances when placed in XML layouts. The view should be positioned like any other view.

Parameters:

context - Activity context

attrs - ui attributes

POBBannerView

public POBBannerView(@NonNull
                     Context context,
                     @Nullable
                     AttributeSet attrs,
                     int defStyle)

Used to create instances when placed in XML layouts with default style. The view should be positioned like any other view.

Parameters:

context - Activity context

attrs - ui attributes

defStyle - default style

POBBannerView

public POBBannerView(@NonNull
                     Context context,
                     @NonNull
                     java.lang.String publisherId,
                     int profileId,
                     @NonNull
                     java.lang.String adUnitId,
                     @NonNull
                     POBAdSize... adSizes)

Constructor Initializes and returns a newly allocated banner view object for supporting 'No Ad Server Configuration' Publisher should create object of POBBannerView using this constructor when instantiating from code. And in case POBBannerView inflated from xml resource, publisher should call init() of this view (from java code) and pass the required ad tag details.

Parameters:

context - Activity context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen.

adSizes - List of banner ad sizes for this impression

POBBannerView

public POBBannerView(@NonNull
                     Context context,
                     @NonNull
                     java.lang.String publisherId,
                     int profileId,
                     @NonNull
                     java.lang.String adUnitId,
                     @NonNull
                     com.pubmatic.sdk.openwrap.banner.POBBannerEvent event)

Constructor Initializes and returns a newly allocated banner view object Publisher should create object of POBBannerView using this constructor when instantiating from java code. And in case POBBannerView inflated from xml resource, publisher should call init() of this view (from java code) and pass the required ad tag details.

Parameters:

context - Activity context

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen.

event - Valid instance of class implementing POBBannerEvent

Method Detail

init

public void init(@NonNull
                 java.lang.String publisherId,
                 int profileId,
                 @NonNull
                 java.lang.String adUnitId,
                 @NonNull
                 com.pubmatic.sdk.openwrap.banner.POBBannerEvent event)

Initializes newly allocated banner view object. Invoke this method only if POBBannerView is inflated via xml resource. Note: If validation check's pass through, the method will create POBRequest

Parameters:

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen.

event - Valid instance of class implementing POBBannerEvent

destroy

public void destroy()

Invoke this method when your activity/fragment is about to destroy. It cleans the resources.

pauseAutoRefresh

public void pauseAutoRefresh()

Pauses the auto refresh, By default, banner refreshes automatically as per configured refresh interval on OpenWrap portal. Calling this method prevents the refresh cycle to happen even if a refresh interval has been specified.

It is recommended to use this method whenever the ad view is about to be hidden from the user for any period of time, to avoid unnecessary ad requests. You can then call `resumeAutoRefresh()` to resume the refresh when banner becomes visible.

resumeAutoRefresh

public void resumeAutoRefresh()

Resumes the auto-refresh as per configured refresh interval on OpenWrap portal, call this method only if you have previously paused auto-refresh using `pauseAutoRefresh()`. This method has no effect if a refresh interval has not been set.

init

public void init(@NonNull
                 java.lang.String publisherId,
                 int profileId,
                 @NonNull
                 java.lang.String adUnitId,
                 @NonNull
                 POBAdSize... adSizes)

Initializes newly allocated banner view object for supporting 'No Ad Server Configuration' Invoke this method only if POBBannerView is inflated via xml resource.

Parameters:

publisherId - Identifier of the publisher

profileId - Profile ID of an ad tag

adUnitId - Ad unit id used to identify unique placement on screen.

adSizes - List of banner ad sizes for this impression

loadAd

@RequiresPermission(allOf={<error>,<error>})
public void loadAd()

Initiate the loading of a banner ad, if the POBRequest is available then it proceeds with further execution else it will log error

loadAd

@RequiresPermission(allOf={<error>,<error>})
public void loadAd(@NonNull
                                                                java.lang.String bidResponse)

Initiates the loading of a banner ad with oRTB bid response. This API expects the response with oRTB v2.5 specification.

Parameters:

bidResponse - oRTB response of format - oRTB-2.5

forceRefresh

@RequiresPermission(allOf={<error>,<error>})
public boolean forceRefresh()

Cancels existing ad requests and initiates new ad request.

It may skip force refresh in below cases: 1). Ad is being loaded 2). Waiting response from ad server SDK (if applicable) 3). User interacting with ad (Opening Internal browser or expanding ad)

Returns:

Status true/false, about force refresh, as described it can skip in few cases by returning 'false'

getImpression

@Nullable
public POBImpression getImpression()

Returns an instance of impression object created internally. It provides APIs to set pubmatic zone id and other custom parameters.

Returns:

Returns an instance of POBImpression.

getAdRequest

@Nullable
public POBRequest getAdRequest()

Returns an Object representing OpenWrap ad request. You may set some additional targeting parameters on this object.

Returns:

Instance of POBRequest

setListener

public void setListener(@Nullable
                        POBBannerView.POBBannerViewListener listener)

Sets instance of POBBannerViewListener for the Banner view.

Parameters:

listener - Instance of POBBannerViewListener

setBidEventListener

public void setBidEventListener(@Nullable
                                POBBidEventListener bidEventListener)

Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener

Specified by:

setBidEventListener in interface POBBidEvent

Parameters:

bidEventListener - reference of POBBidEventListener

proceedToLoadAd

public boolean proceedToLoadAd()

Description copied from interface: POBBidEvent

Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread. Also, unnecessary duplicate call will fail and appropriate errors will be logged with return value `false`

Specified by:

proceedToLoadAd in interface POBBidEvent

Returns:

Returns the boolean value indicating success or failure.

proceedOnError

public void proceedOnError(@NonNull
                           POBBidEvent.BidEventError error,
                           @NonNull
                           java.lang.String errorMessage)

Description copied from interface: POBBidEvent

Introduced in OpenWrapSDK v3.6.0

Proceeds with error, If integration type is of primary ad server case like DFP and MoPub, the execution is continued by invoking ad server call ignoring OpenWrap's bid. In case of No ad server integration, flow is completed by setting its state to default considering error at client side. Note: Should be called from Main/UI thread

Specified by:

proceedOnError in interface POBBidEvent

Parameters:

error - the error of type POBBidEvent.BidEventError Example: Scenario 1 : When bid is failed in client-side in-app auction loss proceedOnError(BidEventError#CLIENT_SIDE_AUCTION_LOSS);

Scenario 2 : When bid is expired proceedOnError(BidEventError#BID_EXPIRED);

errorMessage - custom description for the error Example: When the bid is failed in client-side application the publisher can pass on custom message to identify the issue in logs

getBid

@Nullable
public POBBid getBid()

Get bid

Specified by:

getBid in interface POBBidEvent

Returns:

returns bid

getCreativeSize

@Nullable
public POBAdSize getCreativeSize()

Returns the Size of the rendered ad creative

Returns:

Instance of POBAdSize