com.pubmatic.sdk.openwrap.eventhandler.dfp

Class DFPBannerEventHandler

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBBaseEvent

com.pubmatic.sdk.openwrap.banner.POBBannerEvent

com.pubmatic.sdk.openwrap.eventhandler.dfp.DFPBannerEventHandler

All Implemented Interfaces:

com.google.android.gms.ads.admanager.AppEventListener

public class DFPBannerEventHandler
extends com.pubmatic.sdk.openwrap.banner.POBBannerEvent
implements com.google.android.gms.ads.admanager.AppEventListener

This class implements the communication between the OpenWrap SDK and the GAM SDK for a given ad unit. It implements the PubMatic's OpenWrap interface. OpenWrap SDK notifies (using OpenWrap interface) to make a request to GAM SDK and pass the targeting parameters. This class also creates the GAM's PublisherAdView, initialize it and listen for the callback methods. And pass the GAM ad event to OpenWrap SDK via POBBannerEventListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DFPBannerEventHandler.DFPConfigListener Interface to get the GAM view and it's request builder, to configure the properties.

Constructor Summary

Constructors

Constructor and Description
DFPBannerEventHandler(Context context, java.lang.String adUnitId, com.google.android.gms.ads.AdSize... gamAdSizes) Constructor to initialise GAM AdView with required properties.
DFPBannerEventHandler(Context context, java.lang.String adUnitId, com.google.android.gms.ads.AdSize gamAdSize, POBAdSize[] owAdSizes) Constructs an event handler instance with GAM ad unit and ad size.

Method Summary

Modifier and Type	Method and Description
void	destroy() OpenWrap SDK calls this method to perform any final cleanup.
View	getAdServerView() To retrieve ad server ad view
POBAdSize	getAdSize() OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK
void	onAppEvent(java.lang.String key, java.lang.String bidId)
void	requestAd(POBBid bid) OpenWrap SDK calls this method to make a request to primary SDK.
POBAdSize[]	requestedAdSizes() OpenWrap SDK calls this method to get the size for which ad request should be made.
void	setAppEventListener(GAMAppEventListener listener) Sets the App event listener object.
void	setConfigListener(DFPBannerEventHandler.DFPConfigListener listener) Sets the Data listener object.
void	setEventListener(com.pubmatic.sdk.openwrap.banner.POBBannerEventListener eventListener) OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.
void	setGAMAdSizes(com.google.android.gms.ads.AdSize... gamAdSizes) Optional API can be used to set multiple ad sizes to AdManagerAdView using AdManagerAdView.setAdSizes(AdSize...) internally.

Methods inherited from class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

getAdInteractionListener, getRenderer

Methods inherited from class com.pubmatic.sdk.openwrap.core.POBBaseEvent

prepareErrorFromResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DFPBannerEventHandler

public DFPBannerEventHandler(@NonNull
                             Context context,
                             @NonNull
                             java.lang.String adUnitId,
                             @NonNull
                             com.google.android.gms.ads.AdSize... gamAdSizes)

Constructor to initialise GAM AdView with required properties. Note: OpenWrap SDK does not support fluid ad size, it will be omitted from OpenWrap ad request.

Parameters:

context - Activity / App context

adUnitId - GAM ad unit ID

gamAdSizes - valid ad sizes for banner

DFPBannerEventHandler

public DFPBannerEventHandler(@NonNull
                             Context context,
                             @NonNull
                             java.lang.String adUnitId,
                             @NonNull
                             com.google.android.gms.ads.AdSize gamAdSize,
                             @NonNull
                             POBAdSize[] owAdSizes)

Constructs an event handler instance with GAM ad unit and ad size. Use this constructor to request adaptive sizes from GAM. Note: OpenWrap SDK does not support fluid ad size, it will be omitted from OpenWrap ad request.

Parameters:

context - the activity context

adUnitId - the GAM AdUnit Id

gamAdSize - the GAM AdSize, to be used for GAM ad request. You may also use an adaptive size here..

owAdSizes - the array of OpenWrap SDK ad sizes, to be used for OpenWrap ad requests.

Method Detail

setGAMAdSizes

public void setGAMAdSizes(@NonNull
                          com.google.android.gms.ads.AdSize... gamAdSizes)

Optional API can be used to set multiple ad sizes to AdManagerAdView using AdManagerAdView.setAdSizes(AdSize...) internally. Note: In case of Empty or Null AdSizes, the changes won't be applied to AdManagerAdView

setConfigListener

public void setConfigListener(@Nullable
                              DFPBannerEventHandler.DFPConfigListener listener)

Sets the Data listener object. Publisher should implement the DFPConfigListener and override its method only when publisher needs to set the targeting parameters over GAM banner ad view.

Parameters:

listener - DFP data listener

setAppEventListener

public void setAppEventListener(@Nullable
                                GAMAppEventListener listener)

Sets the App event listener object. Publisher should implement the DFPAppEventListener and override its method only when publisher need GAM SDK's app event callback

Parameters:

listener - DFP app event listener

requestAd

public void requestAd(@Nullable
                      POBBid bid)

Description copied from class: com.pubmatic.sdk.openwrap.core.POBBaseEvent

OpenWrap SDK calls this method to make a request to primary SDK. OpenWrap SDK passes the winning bid for the requested impression. Publisher needs to pass the details as a targeting parameter to primary SDK

Specified by:

requestAd in class com.pubmatic.sdk.openwrap.core.POBBaseEvent

Parameters:

bid - winning bid for the requested impression

destroy

public void destroy()

Description copied from class: com.pubmatic.sdk.openwrap.core.POBBaseEvent

OpenWrap SDK calls this method to perform any final cleanup.

Specified by:

destroy in class com.pubmatic.sdk.openwrap.core.POBBaseEvent

setEventListener

public void setEventListener(@Nullable
                             com.pubmatic.sdk.openwrap.banner.POBBannerEventListener eventListener)

Description copied from class: com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.

Save the `listener` to use it in later phases of ad server events execution

Specified by:

setEventListener in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

Parameters:

eventListener - object conforming to POBBannerEventListener

getAdSize

@Nullable
public POBAdSize getAdSize()

Description copied from class: com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK

Overrides:

getAdSize in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

Returns:

Ad size of the rendered creative

requestedAdSizes

@Nullable
public POBAdSize[] requestedAdSizes()

Description copied from class: com.pubmatic.sdk.openwrap.banner.POBBannerEvent

OpenWrap SDK calls this method to get the size for which ad request should be made.

Overrides:

requestedAdSizes in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

Returns:

Array of POBAdSize

getAdServerView

@Nullable
public View getAdServerView()

Description copied from class: com.pubmatic.sdk.openwrap.banner.POBBannerEvent

To retrieve ad server ad view

Overrides:

getAdServerView in class com.pubmatic.sdk.openwrap.banner.POBBannerEvent

Returns:

ad server ad view

onAppEvent

public void onAppEvent(@NonNull
                       java.lang.String key,
                       @NonNull
                       java.lang.String bidId)

Specified by:

onAppEvent in interface com.google.android.gms.ads.admanager.AppEventListener