com.my.target.nativeads

Class NativeAd

java.lang.Object

com.my.target.common.BaseAd

com.my.target.nativeads.NativeAd

All Implemented Interfaces:

INativeAd

public final class NativeAd
extends BaseAd
implements INativeAd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NativeAd.NativeAdListener
static interface	NativeAd.NativeAdMediaListener

Field Summary

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

adConfig, metricFactory

Constructor Summary

Constructors

Constructor and Description
NativeAd(int slotId, android.content.Context context) Public constructor

Method Summary

Modifier and Type	Method and Description
int	getAdChoicesPlacement() Retrieve current position for AdChoices icon
java.lang.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.
NativePromoBanner	getBanner() Banner model for current ad.
int	getCachePolicy() Retrieve current cachePolicy set previously
NativeAd.NativeAdListener	getListener() Get events listener of an advertisement
NativeAd.NativeAdMediaListener	getMediaListener() Gets listener for media objects events, such as icon loading
void	handleData(java.lang.String data) Loads data for s2s partners
void	handleSection(NativeAdSection section)
boolean	isMediationEnabled() Get enable/disable mediation flag
boolean	isUseExoPlayer() Gets current flag of using ExoPlayer for video playing
void	load() Start loading ads.
void	loadFromBid(java.lang.String bidId) Start loading ad with the bidding ID
void	registerView(android.view.View view) Registration of the Advertising view.
void	registerView(android.view.View view, java.util.List<android.view.View> clickableViews) Registration of the Advertising view.
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(NativeAd.NativeAdListener listener) Set events listener of an advertisement Must be called before load()
void	setMediaListener(NativeAd.NativeAdMediaListener 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.
void	useExoPlayer(boolean useExoPlayer) Enables/disables ExoPlayer to play video.

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

getCustomParams, isLoadCalled

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeAd

public NativeAd(int slotId,
                @NonNull
                android.content.Context context)

Public constructor

Parameters:

slotId - your slot id

context - app context

Method Detail

getCachePolicy

public int getCachePolicy()

Retrieve current cachePolicy set previously

Specified by:

getCachePolicy in interface INativeAd

Returns:

current cachePolicy

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 INativeAd

Parameters:

cachePolicy - cache policy needed CachePolicy

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

isMediationEnabled

public boolean isMediationEnabled()

Get enable/disable mediation flag

Returns:

flag

getListener

@Nullable
public NativeAd.NativeAdListener getListener()

Get events listener of an advertisement

Returns:

an instance of listener

See Also:

NativeAd.NativeAdListener

setListener

public void setListener(@Nullable
                        NativeAd.NativeAdListener listener)

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

See Also:

NativeAd.NativeAdListener

getBanner

@Nullable
public NativePromoBanner getBanner()

Banner model for current ad. Null if not loaded

Returns:

NativePromoBanner

getAdChoicesPlacement

public int getAdChoicesPlacement()

Retrieve current position for AdChoices icon

Specified by:

getAdChoicesPlacement in interface INativeAd

Returns:

current adChoicesPlacement

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 INativeAd

Parameters:

adChoicesPlacement - position

See Also:

AdChoicesPlacement

load

public final 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 INativeAd

loadFromBid

public void loadFromBid(@NonNull
                        java.lang.String bidId)

Start loading ad with the bidding ID

Specified by:

loadFromBid in interface INativeAd

Parameters:

bidId - bidding ID

handleSection

public final void handleSection(@NonNull
                                NativeAdSection section)

registerView

public final void registerView(@NonNull
                               android.view.View view,
                               @Nullable
                               java.util.List<android.view.View> clickableViews)

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

Specified by:

registerView in interface INativeAd

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

public final void registerView(@NonNull
                               android.view.View view)

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

Specified by:

registerView in interface INativeAd

Parameters:

view - Advertising view

unregisterView

public final void unregisterView()

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

Specified by:

unregisterView in interface INativeAd

useExoPlayer

public void useExoPlayer(boolean useExoPlayer)

Enables/disables ExoPlayer to play video. If exoplayer disabled, android default MediaPlayer will be used. Default is true, and it's recommended to not turn it off.

Parameters:

useExoPlayer - flag to use ExoPlayer

See Also:

Android MediaPlayer, ExoPlayer

handleData

public void handleData(@NonNull
                       java.lang.String data)

Loads data for s2s partners

Specified by:

handleData in interface INativeAd

Parameters:

data - s2s data

isUseExoPlayer

public boolean isUseExoPlayer()

Gets current flag of using ExoPlayer for video playing

Returns:

param of using ExoPlayer

getAdSource

@Nullable
public java.lang.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

getMediaListener

@Nullable
public NativeAd.NativeAdMediaListener getMediaListener()

Gets listener for media objects events, such as icon loading

Returns:

listener object

See Also:

NativeAd.NativeAdMediaListener

setMediaListener

public void setMediaListener(@Nullable
                             NativeAd.NativeAdMediaListener mediaListener)

Sets listener for media objects events, such as icon loading

Parameters:

mediaListener - listener object

See Also:

NativeAd.NativeAdMediaListener