com.pubmatic.sdk.nativead

Class POBNativeAdLoader

java.lang.Object

com.pubmatic.sdk.nativead.POBNativeAdLoader

All Implemented Interfaces:

POBNativeAdManager.POBNativeAdManagerListener, com.pubmatic.sdk.openwrap.core.POBBaseAd

public class POBNativeAdLoader
extends java.lang.Object
implements com.pubmatic.sdk.openwrap.core.POBBaseAd, POBNativeAdManager.POBNativeAdManagerListener

Ad loader class to load native ad from PubMatic as per the template specified during initialization.

This class also interacts with primary ad server for header bidding via event handler if specified.

Constructor Summary

Constructors

Constructor and Description
POBNativeAdLoader(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, POBNativeTemplateType templateType) Initializes & returns a newly allocated ad loader object for supporting 'No Ad Server Configuration'.
POBNativeAdLoader(Context context, java.lang.String publisherId, int profileId, java.lang.String adUnitId, POBNativeTemplateType templateType, com.pubmatic.sdk.nativead.POBNativeAdEvent eventHandler) Initializes & returns a newly allocated ad loader object for supporting 'Header Bidding Configuration'.

Method Summary

Modifier and Type	Method and Description
void	destroy() Invoke this method when your activity/fragment is about to destroy.
POBRequest	getAdRequest() Returns an instance of POBRequest, required for setting targeting parameters.
POBNativeAdLoaderConfig	getConfig() Returns the Instance of the Ad Loader config class which publisher can use to pass any custom properties such as ContextType, ContextSubType, PlacementType etc.
POBImpression	getImpression() Returns an instance of POBImpression which gets created internally.
void	loadAd() Initiate the loading for the Native ad
void	onAdReceived(POBNativeAdManager adManager, POBNativeAd nativeAd) Notifies the callback that an Native Ad has been successfully loaded.
void	onBidFailure(POBNativeAdManager nativeAdManager) Notifies the callback that POBBidEvent.proceedOnError(BidEventError, String) has been called for NoAdServer integration.
void	onFailedToLoad(POBNativeAdManager adManager, POBError error) Notifies the callback of an error encountered while loading an adManager.
void	setAdLoaderListener(POBNativeAdLoaderListener adLoaderListener) Sets the POBNativeAdLoaderListener receiver for the ad loader events.
void	setBidEventListener(POBBidEventListener bidEventListener) Sets Bid event listener to notify bid events
void	setNativeCustomAssets(java.util.List<com.pubmatic.sdk.nativead.request.POBBaseNativeRequestAsset> customAssetList) Setter for native custom asset request list

Methods inherited from class java.lang.Object

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

Constructor Detail

POBNativeAdLoader

public POBNativeAdLoader(@NonNull
                         Context context,
                         @NonNull
                         java.lang.String publisherId,
                         int profileId,
                         @NonNull
                         java.lang.String adUnitId,
                         @NonNull
                         POBNativeTemplateType templateType,
                         @NonNull
                         com.pubmatic.sdk.nativead.POBNativeAdEvent eventHandler)

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

Parameters:

publisherId - Unique identifier assigned at the time of publisher on-boarding.

profileId - Profile id of the ad tag.

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

templateType - Instance of POBNativeTemplateType any custom properties such as ContextType, ContextSubType, placementType etc.

eventHandler - Instance of POBNativeAdEvent or its subclass

POBNativeAdLoader

public POBNativeAdLoader(@NonNull
                         Context context,
                         @NonNull
                         java.lang.String publisherId,
                         int profileId,
                         @NonNull
                         java.lang.String adUnitId,
                         @NonNull
                         POBNativeTemplateType templateType)

Initializes & returns a newly allocated ad loader object for supporting 'No Ad Server Configuration'.

Parameters:

publisherId - Unique identifier assigned at the time of publisher on-boarding.

profileId - Profile id of the ad tag.

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

templateType - Instance of POBNativeTemplateType

Method Detail

setAdLoaderListener

public void setAdLoaderListener(@Nullable
                                POBNativeAdLoaderListener adLoaderListener)

Sets the POBNativeAdLoaderListener receiver for the ad loader events.

Parameters:

adLoaderListener - Instance of POBNativeAdLoaderListener

setBidEventListener

public void setBidEventListener(@Nullable
                                POBBidEventListener bidEventListener)

Sets Bid event listener to notify bid events

Parameters:

bidEventListener - reference of POBBidEventListener

getConfig

@NonNull
public POBNativeAdLoaderConfig getConfig()

Returns the Instance of the Ad Loader config class which publisher can use to pass any custom properties such as ContextType, ContextSubType, PlacementType etc.

Returns:

Instance of POBNativeAdLoaderConfig

setNativeCustomAssets

public void setNativeCustomAssets(@NonNull
                                  java.util.List<com.pubmatic.sdk.nativead.request.POBBaseNativeRequestAsset> customAssetList)

Setter for native custom asset request list

Parameters:

customAssetList - List of custom assets created with the help POBBaseNativeRequestAsset and its derived classes.

loadAd

@RequiresPermission(value="android.permission.INTERNET")
public void loadAd()

Initiate the loading for the Native ad

Specified by:

loadAd in interface com.pubmatic.sdk.openwrap.core.POBBaseAd

getImpression

@Nullable
public POBImpression getImpression()

Returns an instance of POBImpression which gets created internally. POBImpression provides the APIs to set PubMatic zone id and other custom parameters.

Specified by:

getImpression in interface com.pubmatic.sdk.openwrap.core.POBBaseAd

Returns:

Returns an instance of POBImpression.

getAdRequest

@Nullable
public POBRequest getAdRequest()

Returns an instance of POBRequest, required for setting targeting parameters.

Specified by:

getAdRequest in interface com.pubmatic.sdk.openwrap.core.POBBaseAd

Returns:

Instance of POBRequest

destroy

public void destroy()

Description copied from interface: com.pubmatic.sdk.openwrap.core.POBBaseAd

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

Specified by:

destroy in interface com.pubmatic.sdk.openwrap.core.POBBaseAd

onAdReceived

public void onAdReceived(@NonNull
                         POBNativeAdManager adManager,
                         @NonNull
                         POBNativeAd nativeAd)

Description copied from interface: POBNativeAdManager.POBNativeAdManagerListener

Notifies the callback that an Native Ad has been successfully loaded.

Specified by:

onAdReceived in interface POBNativeAdManager.POBNativeAdManagerListener

Parameters:

adManager - Instance of POBNativeAdManager over which native ad is loaded

nativeAd - the newly loaded instance of POBNativeAd

onFailedToLoad

public void onFailedToLoad(@NonNull
                           POBNativeAdManager adManager,
                           @NonNull
                           POBError error)

Description copied from interface: POBNativeAdManager.POBNativeAdManagerListener

Notifies the callback of an error encountered while loading an adManager.

Specified by:

onFailedToLoad in interface POBNativeAdManager.POBNativeAdManagerListener

Parameters:

adManager - Instance of POBNativeAdManager over which native adManager is loaded

error - The error encountered while attempting to load the native ad.

onBidFailure

public void onBidFailure(@NonNull
                         POBNativeAdManager nativeAdManager)

Notifies the callback that POBBidEvent.proceedOnError(BidEventError, String) has been called for NoAdServer integration. Helps to manage the POBNativeAdManager count in POBNativeAdLoader's hashset.

Parameters:

nativeAdManager - Instance to be removed from POBNativeAdLoader's hashset.