Package com.my.target.nativeads

Class NativeBannerAd

java.lang.Object

com.my.target.common.BaseAd

com.my.target.nativeads.NativeBannerAd

All Implemented Interfaces:

IAd, INativeBannerAd

public final class NativeBannerAd
extends BaseAd
implements INativeBannerAd

The native banner does not support MediaAdView and therefore cannot display media content (video, cards, large image).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NativeBannerAd.NativeBannerAdChoicesListener
static interface	NativeBannerAd.NativeBannerAdChoicesOptionListener
static interface	NativeBannerAd.NativeBannerAdListener
static interface	NativeBannerAd.NativeBannerAdMediaListener

Constructor Summary

Constructors

Constructor	Description
NativeBannerAd(int slotId, android.content.Context context)	Public constructor
NativeBannerAd(int slotId, MenuFactory menuFactory, android.content.Context context)	Public constructor

Method Summary

Modifier and Type	Method	Description
NativeBannerAd.NativeBannerAdChoicesListener	getAdChoicesListener()
NativeBannerAd.NativeBannerAdChoicesOptionListener	getAdChoicesOptionListener()	Returns listener for ad choice menu.
int	getAdChoicesPlacement()	Retrieve current position for AdChoices icon
String	getAdSource()	Get the name of source network.
float	getAdSourcePriority()	Ad Source Priority is the value representing current ad network place in the queue of received advertisements.
NativeBanner	getBanner()	Banner model for current ad.
int	getCachePolicy()	Retrieve current cachePolicy set previously
NativeBannerAd.NativeBannerAdListener	getListener()	Get events listener of an advertisement
NativeBannerAd.NativeBannerAdMediaListener	getMediaListener()	Gets listener for media objects events, such as icon loading
void	handleAdChoicesClick(android.content.Context context)	Call to display adChoices options whose implementation has been passed using MenuFactory.
void	handleData(String data)	Loads data for s2s partners
boolean	isMediationEnabled()	Get enable/disable mediation flag
void	load()	Start loading ads.
void	loadFromBid(String bidId)	Start loading ad with the bidding ID
void	registerView(android.view.View view)	Deprecated. use NativeBannerAd#registerView(NativeBannerAdViewBinder)
void	registerView(android.view.View view, List<android.view.View> clickableViews)	Deprecated. use NativeBannerAd#registerView(NativeBannerAdViewBinder, List)
void	registerView(NativeBannerAdViewBinder nativeBannerAdViewBinder)	Registration of the Advertising view.
void	registerView(NativeBannerAdViewBinder nativeBannerAdViewBinder, List<android.view.View> clickableViews)	Registration of the Advertising view.
void	registerView(NativeBannerAdView nativeBannerAdView)	Registration of the Advertising view.
void	registerView(NativeBannerAdView nativeBannerAdView, List<android.view.View> clickableViews)	Registration of the Advertising view.
void	setAdChoicesListener(NativeBannerAd.NativeBannerAdChoicesListener adChoicesListener)	Set events listener of adChoices icon load Must be called before NativeBannerAd#load()
void	setAdChoicesOptionListener(NativeBannerAd.NativeBannerAdChoicesOptionListener adChoicesOptionListener)	Sets listener for ad choice menu.
void	setAdChoicesPlacement(int adChoicesPlacement)	Sets the place for AdChoices icon, by default used top-right position
void	setCachePolicy(int cachePolicy)	By default, images and videos are preloaded.
void	setListener(NativeBannerAd.NativeBannerAdListener listener)	Set events listener of an advertisement Must be called before NativeBannerAd#load()
void	setMediaListener(NativeBannerAd.NativeBannerAdMediaListener mediaListener)	Sets listener for media objects events, such as icon loading
void	setMediationEnabled(boolean mediationEnabled)	Enables/disables mediation for current ad.
void	unregisterView()	View de-registration.

Methods inherited from class com.my.target.common.BaseAd

getCustomParams, isLoadCalled, setAdNetworkConfig

Methods inherited from class java.lang.Object

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

Constructor Details

NativeBannerAd

public NativeBannerAd(int slotId,
 android.content.Context context)

Public constructor

Parameters:

slotId - your slot id

context - app context

NativeBannerAd

public NativeBannerAd(int slotId,
 MenuFactory menuFactory,
 android.content.Context context)

Public constructor

Parameters:

slotId - your slot id

context - app context

menuFactory - menuFactory for drawing adChoices options

Method Details

getListener

public NativeBannerAd.NativeBannerAdListener getListener()

Get events listener of an advertisement

Returns:

an instance of listener

See Also:

• NativeBannerAd.NativeBannerAdListener

setListener

public void setListener(NativeBannerAd.NativeBannerAdListener listener)

Set events listener of an advertisement Must be called before NativeBannerAd#load()

See Also:

• NativeBannerAd.NativeBannerAdListener

getBanner

public NativeBanner getBanner()

Banner model for current ad. Null if not loaded

Returns:

NativeBanner

isMediationEnabled

public boolean isMediationEnabled()

Get enable/disable mediation flag

Returns:

flag

setMediationEnabled

public void setMediationEnabled(boolean mediationEnabled)

Enables/disables mediation for current ad. Default is true. Disabling this option may cause lower fill-rate

Parameters:

mediationEnabled - if true - enable mediation, otherwise not

getCachePolicy

public int getCachePolicy()

Retrieve current cachePolicy set previously

Specified by:

getCachePolicy in interface IAd

Returns:

Value is CachePolicy.ALL, CachePolicy.IMAGE, CachePolicy.VIDEO, or CachePolicy.NONE

See Also:

• CachePolicy

setCachePolicy

public void setCachePolicy(int cachePolicy)

By default, images and videos are preloaded. You can turn off the automatic loading of images and videos, but keep in mind that downloading them will take extra time, which will create an additional delay in displaying ads in your application.

Specified by:

setCachePolicy in interface IAd

Parameters:

cachePolicy - Value is CachePolicy.ALL, CachePolicy.IMAGE, CachePolicy.VIDEO, or CachePolicy.NONE

getAdChoicesPlacement

public int getAdChoicesPlacement()

Retrieve current position for AdChoices icon

Specified by:

getAdChoicesPlacement in interface IAd

Returns:

Value is AdChoicesPlacement.TOP_RIGHT, AdChoicesPlacement.TOP_LEFT, AdChoicesPlacement.BOTTOM_RIGHT, AdChoicesPlacement.BOTTOM_LEFT, AdChoicesPlacement.MANUAL, or AdChoicesPlacement.DRAWING_MANUAL

See Also:

• AdChoicesPlacement

setAdChoicesPlacement

public void setAdChoicesPlacement(int adChoicesPlacement)

Sets the place for AdChoices icon, by default used top-right position

Specified by:

setAdChoicesPlacement in interface IAd

Parameters:

adChoicesPlacement - Value is AdChoicesPlacement.TOP_RIGHT, AdChoicesPlacement.TOP_LEFT, AdChoicesPlacement.BOTTOM_RIGHT, AdChoicesPlacement.BOTTOM_LEFT, AdChoicesPlacement.MANUAL, or AdChoicesPlacement.DRAWING_MANUAL

See Also:

• AdChoicesPlacement

load

public void load()

Start loading ads. In case of successful loading, the onLoad method will be called on the object passed as a listener, in case of loading error or if there is no advertisement to be shown - the onNoAd

Ad listener should be added before this call

Specified by:

load in interface IAd

loadFromBid

public void loadFromBid(String bidId)

Start loading ad with the bidding ID

Specified by:

loadFromBid in interface IAd

Parameters:

bidId - bidding ID

registerView

public void registerView(NativeBannerAdViewBinder nativeBannerAdViewBinder,
 List<android.view.View> clickableViews)

Description copied from interface: INativeBannerAd

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface INativeBannerAd

Parameters:

nativeBannerAdViewBinder - Advertising view binder

clickableViews - specific clickable views inside Advertising view. If set, the only views in this list will be clickable. Otherwise, whole view will be clickable

registerView

public void registerView(NativeBannerAdView nativeBannerAdView)

Description copied from interface: INativeBannerAd

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface INativeBannerAd

Parameters:

nativeBannerAdView - Default advertising view for native banner ad

registerView

public void registerView(NativeBannerAdView nativeBannerAdView,
 List<android.view.View> clickableViews)

Description copied from interface: INativeBannerAd

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface INativeBannerAd

Parameters:

nativeBannerAdView - Default advertising view for native banner ad

clickableViews - specific clickable views inside Advertising view. If set, the only views in this list will be clickable. Otherwise, whole view will be clickable

registerView

public void registerView(NativeBannerAdViewBinder nativeBannerAdViewBinder)

Description copied from interface: INativeBannerAd

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface INativeBannerAd

Parameters:

nativeBannerAdViewBinder - Advertising view binder

registerView

@Deprecated
public void registerView(android.view.View view,
 List<android.view.View> clickableViews)

Deprecated.

use NativeBannerAd#registerView(NativeBannerAdViewBinder, List)

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface IAd

Parameters:

view - Advertising view

clickableViews - specific clickable views inside Advertising view. If set, the only views in this list will be clickable. Otherwise, whole view will be clickable

registerView

@Deprecated
public void registerView(android.view.View view)

Deprecated.

use NativeBannerAd#registerView(NativeBannerAdViewBinder)

Registration of the Advertising view. Must be called before showing the ad

Specified by:

registerView in interface IAd

Parameters:

view - Advertising view

unregisterView

public void unregisterView()

View de-registration. Stops timers, frees resources. Must be called after view is no longer needed

Specified by:

unregisterView in interface IAd

handleData

public void handleData(String data)

Loads data for s2s partners

Specified by:

handleData in interface IAd

Parameters:

data - s2s data

getAdSource

public String getAdSource()

Get the name of source network. It always will be "myTarget" if no mediation enabled. returns null if ad is not loaded

Returns:

ad source

getAdSourcePriority

public float getAdSourcePriority()

Ad Source Priority is the value representing current ad network place in the queue of received advertisements. Works only with mediation. 0f if not loaded yet.

Returns:

priority of ad source network

getAdChoicesOptionListener

public NativeBannerAd.NativeBannerAdChoicesOptionListener getAdChoicesOptionListener()

Returns listener for ad choice menu.

Returns:

Object which implements NativeBannerAd.NativeBannerAdChoicesOptionListener interface.

setAdChoicesOptionListener

public void setAdChoicesOptionListener(NativeBannerAd.NativeBannerAdChoicesOptionListener adChoicesOptionListener)

Sets listener for ad choice menu.

Parameters:

adChoicesOptionListener - Object which implements NativeBannerAdChoicesOptionListener interface.

getMediaListener

public NativeBannerAd.NativeBannerAdMediaListener getMediaListener()

Gets listener for media objects events, such as icon loading

Returns:

listener object

See Also:

• NativeBannerAd.NativeBannerAdMediaListener

setMediaListener

public void setMediaListener(NativeBannerAd.NativeBannerAdMediaListener mediaListener)

Sets listener for media objects events, such as icon loading

Parameters:

mediaListener - listener object

See Also:

• NativeBannerAd.NativeBannerAdMediaListener

getAdChoicesListener

public NativeBannerAd.NativeBannerAdChoicesListener getAdChoicesListener()

Returns:

events listener of adChoices icon load Must be called before NativeBannerAd#load()

See Also:

• NativeBannerAd.NativeBannerAdChoicesListener

setAdChoicesListener

public void setAdChoicesListener(NativeBannerAd.NativeBannerAdChoicesListener adChoicesListener)

Set events listener of adChoices icon load Must be called before NativeBannerAd#load()

See Also:

• NativeBannerAd.NativeBannerAdChoicesListener

handleAdChoicesClick

public void handleAdChoicesClick(android.content.Context context)

Call to display adChoices options whose implementation has been passed using MenuFactory.