com.pubmatic.sdk.openwrap.eventhandler.dfp

Class GAMNativeEventHandler

java.lang.Object

com.pubmatic.sdk.openwrap.core.POBBaseEvent

com.pubmatic.sdk.openwrap.banner.POBBannerEvent

com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeEventHandler

All Implemented Interfaces:

com.google.android.gms.ads.admanager.AppEventListener, com.google.android.gms.ads.formats.OnAdManagerAdViewLoadedListener, com.google.android.gms.ads.nativead.NativeAd.OnNativeAdLoadedListener, com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomFormatAdLoadedListener

public class GAMNativeEventHandler
extends com.pubmatic.sdk.openwrap.banner.POBBannerEvent
implements com.google.android.gms.ads.admanager.AppEventListener, com.google.android.gms.ads.formats.OnAdManagerAdViewLoadedListener, com.google.android.gms.ads.nativead.NativeAd.OnNativeAdLoadedListener, com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomFormatAdLoadedListener

This class manages GAM's Native + Banner combined header bidding requests using AdLoader and listens to the respective callbacks. It also communicates with the OpenWrap SDK, via POBBannerEventListener, to inform the GAM banner ad events. Native/custom native ad callbacks are provided through specific listeners GAMNativeEventHandler.NativeAdListener or GAMNativeEventHandler.NativeCustomFormatAdListener while banner ad events are provided through POBBannerViewListener as usual. Note: You must set up banner demand, in addition to native and/or custom native, to include OW banner bids

Reference: https://developers.google.com/ad-manager/mobile-ads-sdk/android/native-banner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GAMNativeEventHandler.GAMConfigListener Interface to get the GAM Banner request builder, to configure the properties.
static class	GAMNativeEventHandler.NativeAdListener Interface definition to provide the NativeAd event callback
static class	GAMNativeEventHandler.NativeCustomFormatAdListener Interface definition to provide the NativeCustomFormatAd event callback

Constructor Summary

Constructors

Constructor and Description
GAMNativeEventHandler(android.content.Context context, java.lang.String adUnitId, com.google.android.gms.ads.AdSize... adSizes) Constructor to initialise required properties using that Event Handler build ad request.

Method Summary

Modifier and Type	Method and Description
void	configureNativeAd(GAMNativeEventHandler.NativeAdListener nativeAdListener) Prepares handler to request GAM's NativeAd by setting up GAMNativeEventHandler.NativeAdListener.
void	configureNativeCustomFormatAd(java.lang.String customFormatId, GAMNativeEventHandler.NativeCustomFormatAdListener nativeCustomFormatAdListener, com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomClickListener nativeCustomFormatClickListener) Prepares handler to request GAM's NativeCustomFormatAd by setting up GAMNativeEventHandler.NativeCustomFormatAdListener.
void	destroy()
android.view.View	getAdServerView()
com.pubmatic.sdk.common.POBAdSize	getAdSize()
void	onAdManagerAdViewLoaded(com.google.android.gms.ads.admanager.AdManagerAdView adManagerAdView)
void	onAppEvent(java.lang.String key, java.lang.String bidId)
void	onCustomFormatAdLoaded(com.google.android.gms.ads.nativead.NativeCustomFormatAd nativeCustomFormatAd)
void	onNativeAdLoaded(com.google.android.gms.ads.nativead.NativeAd nativeAd)
void	requestAd(com.pubmatic.sdk.openwrap.core.POBBid bid)
com.pubmatic.sdk.common.POBAdSize[]	requestedAdSizes()
void	setAdManagerOptions(com.google.android.gms.ads.formats.AdManagerAdViewOptions adManagerOptions) Sets AdManagerAdView options to use while requesting an ad using GAM AdLoader
void	setAppEventListener(GAMAppEventListener listener) Sets the App event listener object.
void	setConfigListener(GAMNativeEventHandler.GAMConfigListener configListener) Use this method to set GAMNativeEventHandler.GAMConfigListener reference and implement its method to set the additional targeting parameters for GAM's AdLoader.
void	setEventListener(com.pubmatic.sdk.openwrap.banner.POBBannerEventListener listener)
void	setNativeAdOptions(com.google.android.gms.ads.nativead.NativeAdOptions nativeAdOptions) Sets NativeAd options to use while requesting an ad using GAM AdLoader

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

getAdInteractionListener, getRenderer

Methods inherited from class java.lang.Object

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

Constructor Detail

GAMNativeEventHandler

public GAMNativeEventHandler(@NonNull
                             android.content.Context context,
                             @NonNull
                             java.lang.String adUnitId,
                             @NonNull
                             com.google.android.gms.ads.AdSize... adSizes)

Constructor to initialise required properties using that Event Handler build ad request.

Parameters:

context - instance of application context

adUnitId - GAM ad unit id

adSizes - valid ad sizes for banner

Method Detail

configureNativeAd

public void configureNativeAd(@Nullable
                              GAMNativeEventHandler.NativeAdListener nativeAdListener)

Prepares handler to request GAM's NativeAd by setting up GAMNativeEventHandler.NativeAdListener.

Parameters:

nativeAdListener - an instance of GAMNativeEventHandler.NativeAdListener

configureNativeCustomFormatAd

public void configureNativeCustomFormatAd(@Nullable
                                          java.lang.String customFormatId,
                                          @Nullable
                                          GAMNativeEventHandler.NativeCustomFormatAdListener nativeCustomFormatAdListener,
                                          @Nullable
                                          com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomClickListener nativeCustomFormatClickListener)

Prepares handler to request GAM's NativeCustomFormatAd by setting up GAMNativeEventHandler.NativeCustomFormatAdListener.

Parameters:

customFormatId - Custom format ID defined in the Ad Manager UI

nativeCustomFormatAdListener - an instance of GAMNativeEventHandler.NativeCustomFormatAdListener

nativeCustomFormatClickListener - an instance GAM's NativeCustomFormatAd.OnCustomClickListener, please refer the custom click behaviour @ https://developers.google.com/ad-manager/mobile-ads-sdk/android/native/custom-formats#respond_to_custom_click_actions

setAdManagerOptions

public void setAdManagerOptions(@Nullable
                                com.google.android.gms.ads.formats.AdManagerAdViewOptions adManagerOptions)

Sets AdManagerAdView options to use while requesting an ad using GAM AdLoader

Parameters:

adManagerOptions - the instance of AdManagerAdViewOptions

setNativeAdOptions

public void setNativeAdOptions(@Nullable
                               com.google.android.gms.ads.nativead.NativeAdOptions nativeAdOptions)

Sets NativeAd options to use while requesting an ad using GAM AdLoader

Parameters:

nativeAdOptions - the instance of NativeAdOptions

setConfigListener

public void setConfigListener(@Nullable
                              GAMNativeEventHandler.GAMConfigListener configListener)

Use this method to set GAMNativeEventHandler.GAMConfigListener reference and implement its method to set the additional targeting parameters for GAM's AdLoader.

Parameters:

configListener - GAM data listener

setAppEventListener

public void setAppEventListener(@Nullable
                                GAMAppEventListener listener)

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

Parameters:

listener - POB app event listener

setEventListener

public void setEventListener(@NonNull
                             com.pubmatic.sdk.openwrap.banner.POBBannerEventListener listener)

Specified by:

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

getAdSize

@Nullable
public com.pubmatic.sdk.common.POBAdSize getAdSize()

Overrides:

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

requestedAdSizes

@Nullable
public com.pubmatic.sdk.common.POBAdSize[] requestedAdSizes()

Overrides:

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

getAdServerView

@Nullable
public android.view.View getAdServerView()

Overrides:

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

requestAd

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

Specified by:

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

destroy

public void destroy()

Specified by:

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

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

onAdManagerAdViewLoaded

public void onAdManagerAdViewLoaded(@NonNull
                                    com.google.android.gms.ads.admanager.AdManagerAdView adManagerAdView)

Specified by:

onAdManagerAdViewLoaded in interface com.google.android.gms.ads.formats.OnAdManagerAdViewLoadedListener

onNativeAdLoaded

public void onNativeAdLoaded(@NonNull
                             com.google.android.gms.ads.nativead.NativeAd nativeAd)

Specified by:

onNativeAdLoaded in interface com.google.android.gms.ads.nativead.NativeAd.OnNativeAdLoadedListener

onCustomFormatAdLoaded

public void onCustomFormatAdLoaded(@NonNull
                                   com.google.android.gms.ads.nativead.NativeCustomFormatAd nativeCustomFormatAd)

Specified by:

onCustomFormatAdLoaded in interface com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomFormatAdLoadedListener