com.pubmatic.sdk.nativead

Class POBNativeAdManager

java.lang.Object

com.pubmatic.sdk.nativead.POBNativeAdManager

All Implemented Interfaces:

com.pubmatic.sdk.common.POBAdServerSignalingEventListener, POBBidEvent

public class POBNativeAdManager
extends java.lang.Object
implements com.pubmatic.sdk.common.POBAdServerSignalingEventListener, POBBidEvent

Class responsible for loading native ads by fetching bids from OW Server, submitting the same to primary ad sever if present and creative native ads. Use loadAd(POBRequest, POBProfileInfo) to load native ad. To get native ads set setListener(POBNativeAdManagerListener), that will notifies loading events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	POBNativeAdManager.POBNativeAdManagerListener Interface to definition to notify Native Ad load events.

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

POBBidEvent.BidEventError

Constructor Summary

Constructors

Constructor and Description
POBNativeAdManager(Context context, POBNativeTemplateType templateType, com.pubmatic.sdk.nativead.POBNativeAdEventBridge eventHandlerBridge) Initializes & returns a newly allocated ad loader object for supporting 'Header Bidding Configuration'.

Method Summary

Modifier and Type	Method and Description
POBBid	getBid() Used to get bid instance
com.pubmatic.sdk.common.base.POBBidsProvider	getBidsProvider() Returns bids provider
void	loadAd(POBRequest request, com.pubmatic.sdk.common.models.POBProfileInfo profileInfo) Load the Native ad for given ad request and profile info.
void	onAdServerWin() Publisher should call this method to notify the OpenWrap SDK about ad server SDK renders its own ad
void	onFailed(POBError error) Handler should call this method to notify the OpenWrap SDK about any kind of load time error
void	onOpenWrapPartnerWin(java.lang.String bidId) Call this when the ad server SDK signals about partner bid win with bid id.
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	setBidEventListener(POBBidEventListener bidEventListener) Sets Bid event listener to notify bid events
void	setListener(POBNativeAdManager.POBNativeAdManagerListener adManagerListener) To listen the AdManager load events, refer

Methods inherited from class java.lang.Object

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

Constructor Detail

POBNativeAdManager

public POBNativeAdManager(@NonNull
                          Context context,
                          @NonNull
                          POBNativeTemplateType templateType,
                          @NonNull
                          com.pubmatic.sdk.nativead.POBNativeAdEventBridge eventHandlerBridge)

Initializes & returns a newly allocated ad loader object for supporting 'Header Bidding Configuration'.

Parameters:

context - the application context

templateType - Instance of POBNativeTemplateType

eventHandlerBridge - Instance of POBNativeAdEvent or its subclass

Method Detail

setListener

public void setListener(@Nullable
                        POBNativeAdManager.POBNativeAdManagerListener adManagerListener)

To listen the AdManager load events, refer

Parameters:

adManagerListener - reference of POBNativeAdManager.POBNativeAdManagerListener.

loadAd

public void loadAd(@NonNull
                   POBRequest request,
                   @Nullable
                   com.pubmatic.sdk.common.models.POBProfileInfo profileInfo)

Load the Native ad for given ad request and profile info.

Parameters:

request - the instance of request

profileInfo - the

onOpenWrapPartnerWin

public void onOpenWrapPartnerWin(@Nullable
                                 java.lang.String bidId)

Description copied from interface: com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Call this when the ad server SDK signals about partner bid win with bid id.

Specified by:

onOpenWrapPartnerWin in interface com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Parameters:

bidId - Winning partner bid id

onAdServerWin

public void onAdServerWin()

Description copied from interface: com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Publisher should call this method to notify the OpenWrap SDK about ad server SDK renders its own ad

Specified by:

onAdServerWin in interface com.pubmatic.sdk.common.POBAdServerSignalingEventListener

onFailed

public void onFailed(@NonNull
                     POBError error)

Description copied from interface: com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Handler should call this method to notify the OpenWrap SDK about any kind of load time error

Specified by:

onFailed in interface com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Parameters:

error - Error object with error details from ad server SDK

getBidsProvider

@Nullable
public com.pubmatic.sdk.common.base.POBBidsProvider getBidsProvider()

Description copied from interface: com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Returns bids provider

Specified by:

getBidsProvider in interface com.pubmatic.sdk.common.POBAdServerSignalingEventListener

Returns:

bids provider

setBidEventListener

public void setBidEventListener(@Nullable
                                POBBidEventListener bidEventListener)

Description copied from interface: POBBidEvent

Sets Bid event listener to notify bid events

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()

Description copied from interface: POBBidEvent

Used to get bid instance

Specified by:

getBid in interface POBBidEvent

Returns:

returns current bid