com.pubmatic.sdk.nativead

Class POBNativeAdProvider

java.lang.Object

com.pubmatic.sdk.nativead.POBNativeAdProvider

All Implemented Interfaces:

POBNativeAd, POBNativeAdEventListener, POBNativeRendererListener

public class POBNativeAdProvider
extends java.lang.Object
implements POBNativeAd, POBNativeRendererListener, POBNativeAdEventListener

Class implementing the core logic of Native Ad provider which identifies the type and returns either POBNativeAd or POBCustomNativeAd instance.

Constructor Summary

Constructors

Constructor and Description
POBNativeAdProvider(android.content.Context context, POBNativeTemplateType nativeTemplateType, POBNativeAdEventBridge adEventHandler) Constructor

Method Summary

Modifier and Type	Method and Description
void	destroy() Method to destroy the native ad
POBNativeAdView	getAdView() Returns the rendered Native Ad View in both OpenWrapPartnerWin and OnAdServerWin condition Instance of POBNativeAdView works as a wrapper around AdServerView and OpenWrap POBNativeTemplateView
POBNativeAdDataResponseAsset	getDataAssetForId(int assetId) Return the data asset for the respective Id
POBNativeAdImageResponseAsset	getImageAssetForId(int assetId) Return the image asset for the respective Id
POBNativeAdTitleResponseAsset	getTitleAssetForId(int assetId) Return the title asset for the respective Id
void	onAdClicked() Notify about the Native Ad recorded click
void	onAdClicked(int assetId) Notify about the Native Ad recorded click for specific asset
void	onAdClosed() Notify about the Native Ad closed
void	onAdImpression() Notify about the Native Ad recorded impression
void	onAdLeavingApplication() Notify about the Native Ad leaving application
void	onAdOpened() Notify about the Native Ad opened
void	onAdRendered(android.view.View adView) Notify about the Native Ad rendering completion
void	onAdRenderingFailed(com.pubmatic.sdk.common.POBError error) Notify about the Native Ad rendering failure
void	onDsaInfoIconClicked() Notifies to show the DSA info detail screen
void	onNativeAdClicked() Get called when the ad server SDK informs about click event as a result of user interaction.
void	onNativeAdClosed() Get called this when the ad server SDK closed the ad
void	onNativeAdImpression() Get called when the ad server SDK informs about impression event
void	onNativeAdOpened() Get called this when the ad server SDK has opened an ad
void	registerViewForInteraction(android.view.View adView, java.util.List<android.view.View> clickableViews, POBNativeAdListener listener) Register's native ad view and its asset views for impression and click tracking purpose.
void	renderAd(POBNativeAdListener listener) Render the native template in POBNativeAdView object
void	renderAd(POBNativeTemplateView templateView, POBNativeAdListener listener) Another flavor of renderAd method use by publisher to pass there own custom view template
void	setBid(com.pubmatic.sdk.openwrap.core.POBBid bid) Sets the instance of POBBid
void	setNativeAdResponse(POBNativeAdResponse nativeAdResponse) Setter for the native ad response

Methods inherited from class java.lang.Object

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

Constructor Detail

POBNativeAdProvider

public POBNativeAdProvider(@NonNull
                           android.content.Context context,
                           @NonNull
                           POBNativeTemplateType nativeTemplateType,
                           @NonNull
                           POBNativeAdEventBridge adEventHandler)

Constructor

Parameters:

context - Activity context

nativeTemplateType - Template type for Native Ad

adEventHandler - Instance of POBNativeAdEvent

Method Detail

setBid

public void setBid(@Nullable
                   com.pubmatic.sdk.openwrap.core.POBBid bid)

Sets the instance of POBBid

Parameters:

bid - Instance of POBBid

setNativeAdResponse

public void setNativeAdResponse(@Nullable
                                POBNativeAdResponse nativeAdResponse)

Setter for the native ad response

Parameters:

nativeAdResponse - Instance of POBNativeAdResponse

renderAd

@MainThread
public void renderAd(@NonNull
                                 POBNativeAdListener listener)

Description copied from interface: POBNativeAd

Render the native template in POBNativeAdView object

Specified by:

renderAd in interface POBNativeAd

Parameters:

listener - POBNativeAdListener to get rendering callbacks

renderAd

@MainThread
public void renderAd(@NonNull
                                 POBNativeTemplateView templateView,
                                 @NonNull
                                 POBNativeAdListener listener)

Description copied from interface: POBNativeAd

Another flavor of renderAd method use by publisher to pass there own custom view template

Specified by:

renderAd in interface POBNativeAd

Parameters:

templateView - custom template to get populate

listener - POBNativeAdListener of rendering callbacks

destroy

public void destroy()

Description copied from interface: POBNativeAd

Method to destroy the native ad

Specified by:

destroy in interface POBNativeAd

registerViewForInteraction

public void registerViewForInteraction(@NonNull
                                       android.view.View adView,
                                       @NonNull
                                       java.util.List<android.view.View> clickableViews,
                                       @NonNull
                                       POBNativeAdListener listener)

Description copied from interface: POBNativeAd

Register's native ad view and its asset views for impression and click tracking purpose.

Specified by:

registerViewForInteraction in interface POBNativeAd

Parameters:

adView - native ad view container

clickableViews - clickable asset views

listener - POBNativeAdListener of rendering callbacks

getAdView

@Nullable
public POBNativeAdView getAdView()

Description copied from interface: POBNativeAd

Returns the rendered Native Ad View in both OpenWrapPartnerWin and OnAdServerWin condition Instance of POBNativeAdView works as a wrapper around AdServerView and OpenWrap POBNativeTemplateView

Specified by:

getAdView in interface POBNativeAd

Returns:

Instance of POBNativeAdView

getTitleAssetForId

@Nullable
public POBNativeAdTitleResponseAsset getTitleAssetForId(int assetId)

Description copied from interface: POBNativeAd

Return the title asset for the respective Id

Specified by:

getTitleAssetForId in interface POBNativeAd

Parameters:

assetId - Id of the asset.

Returns:

Instance of POBNativeAdTitleResponseAsset

getDataAssetForId

@Nullable
public POBNativeAdDataResponseAsset getDataAssetForId(int assetId)

Description copied from interface: POBNativeAd

Return the data asset for the respective Id

Specified by:

getDataAssetForId in interface POBNativeAd

Parameters:

assetId - Id of the asset.

Returns:

Instance of POBNativeAdDataResponseAsset

getImageAssetForId

@Nullable
public POBNativeAdImageResponseAsset getImageAssetForId(int assetId)

Description copied from interface: POBNativeAd

Return the image asset for the respective Id

Specified by:

getImageAssetForId in interface POBNativeAd

Parameters:

assetId - Id of the asset.

Returns:

Instance of POBNativeAdImageResponseAsset

onAdRendered

public void onAdRendered(@NonNull
                         android.view.View adView)

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad rendering completion

Specified by:

onAdRendered in interface POBNativeRendererListener

Parameters:

adView - Native Ad view instance

onAdRenderingFailed

public void onAdRenderingFailed(@NonNull
                                com.pubmatic.sdk.common.POBError error)

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad rendering failure

Specified by:

onAdRenderingFailed in interface POBNativeRendererListener

Parameters:

error - POBError for show failures

onAdImpression

public void onAdImpression()

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad recorded impression

Specified by:

onAdImpression in interface POBNativeRendererListener

onAdClicked

public void onAdClicked()

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad recorded click

Specified by:

onAdClicked in interface POBNativeRendererListener

onAdClicked

public void onAdClicked(int assetId)

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad recorded click for specific asset

Specified by:

onAdClicked in interface POBNativeRendererListener

onAdLeavingApplication

public void onAdLeavingApplication()

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad leaving application

Specified by:

onAdLeavingApplication in interface POBNativeRendererListener

onAdOpened

public void onAdOpened()

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad opened

Specified by:

onAdOpened in interface POBNativeRendererListener

onAdClosed

public void onAdClosed()

Description copied from interface: POBNativeRendererListener

Notify about the Native Ad closed

Specified by:

onAdClosed in interface POBNativeRendererListener

onDsaInfoIconClicked

public void onDsaInfoIconClicked()

Description copied from interface: POBNativeRendererListener

Notifies to show the DSA info detail screen

Specified by:

onDsaInfoIconClicked in interface POBNativeRendererListener

onNativeAdClosed

public void onNativeAdClosed()

Description copied from interface: POBNativeAdEventListener

Get called this when the ad server SDK closed the ad

Specified by:

onNativeAdClosed in interface POBNativeAdEventListener

onNativeAdOpened

public void onNativeAdOpened()

Description copied from interface: POBNativeAdEventListener

Get called this when the ad server SDK has opened an ad

Specified by:

onNativeAdOpened in interface POBNativeAdEventListener

onNativeAdClicked

public void onNativeAdClicked()

Description copied from interface: POBNativeAdEventListener

Get called when the ad server SDK informs about click event as a result of user interaction.

Specified by:

onNativeAdClicked in interface POBNativeAdEventListener

onNativeAdImpression

public void onNativeAdImpression()

Description copied from interface: POBNativeAdEventListener

Get called when the ad server SDK informs about impression event

Specified by:

onNativeAdImpression in interface POBNativeAdEventListener