net.pubnative.library.request.model

Class PubnativeAdModel

java.lang.Object

net.pubnative.library.request.model.PubnativeAdModel

All Implemented Interfaces:

java.io.Serializable, PubnativeImpressionTracker.Listener

public class PubnativeAdModel
extends java.lang.Object
implements PubnativeImpressionTracker.Listener, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PubnativeAdModel.Listener Interface definition for callbacks to be invoked when impression confirmed/failed, ad clicked/clickfailed

Constructor Summary

Constructors

Constructor and Description
PubnativeAdModel()

Method Summary

Modifier and Type	Method and Description
static PubnativeAdModel	create(android.content.Context context, PubnativeAPIV3AdModel data)
void	fetch() This method prepares all possible resources
PubnativeAPIV3DataModel	getAsset(java.lang.String asset) Gets the specified asset field raw data
int	getAssetGroupId() Gets the asset group id of the ad
java.lang.String	getAssetHtml(java.lang.String asset)
java.lang.String	getAssetUrl(java.lang.String asset) Gets url of the assets (html banner page, standard banner etc.)
java.lang.String	getBannerUrl() Gets the banner image url of the ad
java.lang.String	getBeacon(java.lang.String beaconType) Deprecated. Beacons are multiple now, so this method will not cover all options, IT could even return a beacon with null url, since there are other type of beacons supported.
java.util.List<net.pubnative.library.request.model.PubnativeBeacon>	getBeacons() Deprecated. Beacons returned by this method won't contain all the data, and will return null in the future, direct access to beacons will be stopped.
java.lang.String	getClickUrl() Gets the click url of the ad
android.view.View	getContentInfo(android.content.Context context) Gets content info view
java.lang.String	getContentInfoClickUrl() Gets content info click url
java.lang.String	getContentInfoIconUrl() Gets content info icon url
java.lang.String	getCtaText() Gets the call to action string of the ad
java.lang.String	getDescription() Gets the description string of the ad
java.lang.String	getIconUrl() Gets the icon image url of the ad
PubnativeAPIV3DataModel	getMeta(java.lang.String meta) Gets the specified meta field raw data
java.lang.String	getPortraitBannerUrl() Deprecated. This resource is no longer served, so it will always return null
int	getRating() Gets rating of the app in a value from 0 to 5
java.lang.String	getTitle() Gets the title string of the ad
java.lang.String	getType() Deprecated. There are no longer differencies about video/native ad, it's implicit to the request so you should stop using this method
java.lang.String	getVast()
boolean	isRevenueModelCPA()
void	onImpression(android.view.View visibleView)
void	onURLDrillerFail(java.lang.String url, java.lang.Exception exception)
void	onURLDrillerFinish(java.lang.String url)
void	onURLDrillerRedirect(java.lang.String url)
void	onURLDrillerStart(java.lang.String url)
void	setUseClickCaching(boolean enabled)
void	setUseClickInBackground(boolean enabled)
void	setUseClickLoader(boolean enabled) This will enable / disable the spin that takes the screen on click.
void	startTracking(android.view.View view, PubnativeAdModel.Listener listener) Start tracking of ad view to auto confirm impressions and handle clicks
void	startTracking(android.view.View view, android.view.View clickableView, java.util.Map<java.lang.String,java.lang.String> extras, PubnativeAdModel.Listener listener) Start tracking of ad view to auto confirm impressions and handle clicks
void	startTracking(android.view.View view, android.view.View clickableView, PubnativeAdModel.Listener listener)
void	stopTracking() stop tracking of ad view

Methods inherited from class java.lang.Object

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

Constructor Detail

PubnativeAdModel

public PubnativeAdModel()

Method Detail

create

public static PubnativeAdModel create(android.content.Context context,
                                      PubnativeAPIV3AdModel data)

getMeta

public PubnativeAPIV3DataModel getMeta(java.lang.String meta)

Gets the specified meta field raw data

Parameters:

meta - meta field type name

Returns:

valid PubnativeAPIV3DataModel if present, null if not

getAsset

public PubnativeAPIV3DataModel getAsset(java.lang.String asset)

Gets the specified asset field raw data

Parameters:

asset - asset field type name

Returns:

valid PubnativeAPIV3DataModel if present, null if not

getTitle

public java.lang.String getTitle()

Gets the title string of the ad

Returns:

String representation of the ad title, null if not present

getDescription

public java.lang.String getDescription()

Gets the description string of the ad

Returns:

String representation of the ad Description, null if not present

getCtaText

public java.lang.String getCtaText()

Gets the call to action string of the ad

Returns:

String representation of the call to action value, null if not present

getIconUrl

public java.lang.String getIconUrl()

Gets the icon image url of the ad

Returns:

valid String with the url value, null if not present

getVast

public java.lang.String getVast()

getBannerUrl

public java.lang.String getBannerUrl()

Gets the banner image url of the ad

Returns:

valid String with the url value, null if not present

getAssetUrl

public java.lang.String getAssetUrl(java.lang.String asset)

Gets url of the assets (html banner page, standard banner etc.)

Parameters:

asset - asset name for which url requested.

Returns:

valid String with the url value, null if not present.

getAssetHtml

public java.lang.String getAssetHtml(java.lang.String asset)

getAssetGroupId

public int getAssetGroupId()

Gets the asset group id of the ad

Returns:

int value with the id of the asset group ad, 0 if not present

getClickUrl

public java.lang.String getClickUrl()

Gets the click url of the ad

Returns:

String value with the url of the click, null if not present

getRating

public int getRating()

Gets rating of the app in a value from 0 to 5

Returns:

int value, 0 if not present

getContentInfo

public android.view.View getContentInfo(android.content.Context context)

Gets content info view

Parameters:

context - Valid context

Returns:

View containing content info

getContentInfoIconUrl

public java.lang.String getContentInfoIconUrl()

Gets content info icon url

Returns:

icon url of content info

getContentInfoClickUrl

public java.lang.String getContentInfoClickUrl()

Gets content info click url

Returns:

click url of content info

getType

@Deprecated
public java.lang.String getType()

Deprecated. There are no longer differencies about video/native ad, it's implicit to the request so you should stop using this method

Gets the type of the ad "native" or "video"

Returns:

valid String native/video depending on the ad type

getPortraitBannerUrl

@Deprecated
public java.lang.String getPortraitBannerUrl()

Deprecated. This resource is no longer served, so it will always return null

Gets the portrait banner asset of the ad

Returns:

String with the url value

getBeacons

@Deprecated
public java.util.List<net.pubnative.library.request.model.PubnativeBeacon> getBeacons()

Deprecated. Beacons returned by this method won't contain all the data, and will return null in the future, direct access to beacons will be stopped.

Gets all the present beacons in the ad

Returns:

Returns the list of all present beacons of the ad

isRevenueModelCPA

public boolean isRevenueModelCPA()

setUseClickLoader

public void setUseClickLoader(boolean enabled)

This will enable / disable the spin that takes the screen on click. Default behaviour is enabled

Parameters:

enabled - true will show a spinner on top of the screen, false will disable the click spin view

setUseClickInBackground

public void setUseClickInBackground(boolean enabled)

setUseClickCaching

public void setUseClickCaching(boolean enabled)

getBeacon

@Deprecated
public java.lang.String getBeacon(java.lang.String beaconType)

Deprecated. Beacons are multiple now, so this method will not cover all options, IT could even return a beacon with null url, since there are other type of beacons supported.

This function will return the first present beacon URL of the specified type

Parameters:

beaconType - type of beacon

Returns:

return Beacon URL or null if not present.

fetch

public void fetch()

This method prepares all possible resources

startTracking

public void startTracking(android.view.View view,
                          PubnativeAdModel.Listener listener)

Start tracking of ad view to auto confirm impressions and handle clicks

Parameters:

view - ad view

listener - listener for callbacks

startTracking

public void startTracking(android.view.View view,
                          android.view.View clickableView,
                          PubnativeAdModel.Listener listener)

startTracking

public void startTracking(android.view.View view,
                          android.view.View clickableView,
                          java.util.Map<java.lang.String,java.lang.String> extras,
                          PubnativeAdModel.Listener listener)

Start tracking of ad view to auto confirm impressions and handle clicks

Parameters:

view - ad view

clickableView - clickable view

listener - listener for callbacks

stopTracking

public void stopTracking()

stop tracking of ad view

onImpression

public void onImpression(android.view.View visibleView)

Specified by:

onImpression in interface PubnativeImpressionTracker.Listener

onURLDrillerStart

public void onURLDrillerStart(java.lang.String url)

onURLDrillerRedirect

public void onURLDrillerRedirect(java.lang.String url)

onURLDrillerFinish

public void onURLDrillerFinish(java.lang.String url)

onURLDrillerFail

public void onURLDrillerFail(java.lang.String url,
                             java.lang.Exception exception)