com.pubmatic.sdk.openwrap.eventhandler.dfp

Class GAMNativeEventHandler

java.lang.Object

com.pubmatic.sdk.nativead.POBNativeAdEvent

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

All Implemented Interfaces:

com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

public class GAMNativeEventHandler
extends com.pubmatic.sdk.nativead.POBNativeAdEvent
implements com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

This class manages GAM's Native Ad header bidding requests using AdLoader and listens to the respective callbacks. It also communicates with the OpenWrap SDK, via POBNativeEventListener, to inform the GAM ad events.

Please refer: GAM Native Overview GAM NativeCustomFormatAd

Nested Class Summary

Nested classes/interfaces inherited from interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.GAMAdTypes, com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeAdRendererListener, com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeCustomFormatAdRendererListener

Constructor Summary

Constructors

Constructor and Description
GAMNativeEventHandler(Context context, java.lang.String adUnitId, java.lang.String openWrapFormatId, com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.GAMAdTypes... adTypes) Constructor to initialize required properties using that Event Handler build ad request.

Method Summary

Modifier and Type	Method and Description
void	addNativeCustomFormatAd(java.lang.String customFormatId, com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomClickListener customClickListener) Enables the GAMNativeEventHandler to load custom format ads through GAMs API.
com.pubmatic.sdk.nativead.POBNativeAdEventBridge	createNativeAdEventBridge() Creates and returns the instance of POBNativeAdEventBridge, which faciliates bridging the Primary ad server SDK through OpenWrap SDK for Native ads
void	setConfigListener(com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMConfigListener configListener) With configListener publisher can configure the ad request properties on the provided objects.
void	setNativeAdOptions(com.google.android.gms.ads.nativead.NativeAdOptions nativeAdOptions) Used to configure native ad requests by additional customizations like setReturnUrlsForImageAssets, setAdChoicesPlacement, setMediaAspectRatio, etc.
void	setNativeAdRendererListener(com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeAdRendererListener nativeAdRendererListener) Used for runtime rendering of NativeAd by providing native ad rendering on the app side
void	setNativeCustomFormatAdRendererListener(com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeCustomFormatAdRendererListener nativeCustomFormatAdRendererListener) Used for runtime rendering of NativeCustomFormatAd by providing native ad rendering on the app side

Methods inherited from class java.lang.Object

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

Constructor Detail

GAMNativeEventHandler

public GAMNativeEventHandler(@NonNull
                             Context context,
                             @NonNull
                             java.lang.String adUnitId,
                             @NonNull
                             java.lang.String openWrapFormatId,
                             @NonNull
                             com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.GAMAdTypes... adTypes)

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

Parameters:

context - Instance of application context

adUnitId - GAM ad unit id

openWrapFormatId - Custom format ID defined in the Ad Manager UI for openwrap creative

adTypes - varargs containing ad type GAMAdTypes

Method Detail

createNativeAdEventBridge

@NonNull
public com.pubmatic.sdk.nativead.POBNativeAdEventBridge createNativeAdEventBridge()

Description copied from class: com.pubmatic.sdk.nativead.POBNativeAdEvent

Creates and returns the instance of POBNativeAdEventBridge, which faciliates bridging the Primary ad server SDK through OpenWrap SDK for Native ads

Specified by:

createNativeAdEventBridge in class com.pubmatic.sdk.nativead.POBNativeAdEvent

Returns:

new instance of POBNativeAdEventBridge

setNativeAdOptions

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

Description copied from interface: com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Used to configure native ad requests by additional customizations like setReturnUrlsForImageAssets, setAdChoicesPlacement, setMediaAspectRatio, etc. The NativeAdOptions object allows apps to set specific options used in making the request

Specified by:

setNativeAdOptions in interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Parameters:

nativeAdOptions - Instance of NativeAdOptions

setConfigListener

public void setConfigListener(@Nullable
                              com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMConfigListener configListener)

Description copied from interface: com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

With configListener publisher can configure the ad request properties on the provided objects.

Specified by:

setConfigListener in interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Parameters:

configListener - Instance of GAMConfigListener

setNativeAdRendererListener

public void setNativeAdRendererListener(@Nullable
                                        com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeAdRendererListener nativeAdRendererListener)

Description copied from interface: com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Used for runtime rendering of NativeAd by providing native ad rendering on the app side

Specified by:

setNativeAdRendererListener in interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Parameters:

nativeAdRendererListener - Instance of GAMNativeConfiguration.NativeAdRendererListener

setNativeCustomFormatAdRendererListener

public void setNativeCustomFormatAdRendererListener(@Nullable
                                                    com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration.NativeCustomFormatAdRendererListener nativeCustomFormatAdRendererListener)

Description copied from interface: com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Used for runtime rendering of NativeCustomFormatAd by providing native ad rendering on the app side

Specified by:

setNativeCustomFormatAdRendererListener in interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Parameters:

nativeCustomFormatAdRendererListener - Instance of GAMNativeConfiguration.NativeCustomFormatAdRendererListener

addNativeCustomFormatAd

public void addNativeCustomFormatAd(@NonNull
                                    java.lang.String customFormatId,
                                    @Nullable
                                    com.google.android.gms.ads.nativead.NativeCustomFormatAd.OnCustomClickListener customClickListener)

Description copied from interface: com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Enables the GAMNativeEventHandler to load custom format ads through GAMs API.

Specified by:

addNativeCustomFormatAd in interface com.pubmatic.sdk.openwrap.eventhandler.dfp.GAMNativeConfiguration

Parameters:

customFormatId - Custom format ID defined in the Ad Manager UI.

customClickListener - An optional listener to define custom click logic for ad clicks. When set, this overrides the ad's default click through behavior of navigating to the click URL defined in the Ad Manager UI.