com.mopub.nativeads

Class StaticNativeAd

java.lang.Object

com.mopub.nativeads.BaseNativeAd

com.mopub.nativeads.StaticNativeAd

All Implemented Interfaces:

ClickInterface, ImpressionInterface

public abstract class StaticNativeAd
extends BaseNativeAd
implements ImpressionInterface, ClickInterface

This the base class for implementations of the static native ad format.

Nested Class Summary

Nested classes/interfaces inherited from class com.mopub.nativeads.BaseNativeAd

BaseNativeAd.NativeEventListener

Constructor Summary

Constructors

Constructor and Description
StaticNativeAd()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtra(java.lang.String key, java.lang.Object value)
void	clear(android.view.View view) Your BaseNativeAd subclass should implement this method if the network requires the developer to reset or clear state of the native ad after it goes off screen and before it is rendered again.
void	destroy() Your BaseNativeAd subclass should implement this method if the network requires the developer to destroy or cleanup their native ad when they are permanently finished with it.
java.lang.String	getCallToAction() Returns the Call To Action String (i.e.
java.lang.String	getClickDestinationUrl() Returns the String url that the device will attempt to resolve when the ad is clicked.
java.lang.Object	getExtra(java.lang.String key) Given a particular String key, return the associated Object value from the ad's extras map.
java.util.Map<java.lang.String,java.lang.Object>	getExtras() Returns a copy of the extras map, reflecting additional ad content not reflected in any of the above hardcoded setters.
java.lang.String	getIconImageUrl() Returns the String url corresponding to the ad's icon image.
int	getImpressionMinPercentageViewed() Returns the minimum viewable percentage of the ad that must be onscreen for it to be considered visible.
int	getImpressionMinTimeViewed() Returns the minimum amount of time (in milliseconds) the ad that must be onscreen before an impression is recorded.
java.lang.String	getMainImageUrl() Returns the String url corresponding to the ad's main image.
java.lang.String	getPrivacyInformationIconClickThroughUrl() Returns the Privacy Information click through url.
java.lang.String	getPrivacyInformationIconImageUrl() Returns the Privacy Information image url.
java.lang.Double	getStarRating() For app install ads, this returns the associated star rating (on a 5 star scale) for the advertised app.
java.lang.String	getText() Returns the String corresponding to the ad's body text.
java.lang.String	getTitle() Returns the String corresponding to the ad's title.
void	handleClick(android.view.View view) Your StaticNativeAd subclass should implement this method if the network requires the developer to explicitly handle click events of views rendered to screen.
boolean	isImpressionRecorded()
void	prepare(android.view.View view) Your BaseNativeAd subclass should implement this method if the network requires the developer to prepare state for recording an impression or click before a view is rendered to screen.
void	recordImpression(android.view.View view) Your StaticNativeAd subclass should implement this method if the network requires the developer to explicitly record an impression of a view rendered to screen.
void	setCallToAction(java.lang.String callToAction)
void	setClickDestinationUrl(java.lang.String clickDestinationUrl)
void	setIconImageUrl(java.lang.String iconImageUrl)
void	setImpressionMinTimeViewed(int impressionMinTimeViewed)
void	setImpressionRecorded()
void	setMainImageUrl(java.lang.String mainImageUrl)
void	setPrivacyInformationIconClickThroughUrl(java.lang.String privacyInformationIconClickThroughUrl)
void	setPrivacyInformationIconImageUrl(java.lang.String privacyInformationIconImageUrl)
void	setStarRating(java.lang.Double starRating)
void	setText(java.lang.String text)
void	setTitle(java.lang.String title)

Methods inherited from class com.mopub.nativeads.BaseNativeAd

addClickTracker, addClickTrackers, addImpressionTracker, addImpressionTrackers, notifyAdClicked, notifyAdImpressed, setNativeEventListener

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticNativeAd

public StaticNativeAd()

Method Detail

getTitle

public final java.lang.String getTitle()

Returns the String corresponding to the ad's title.

getText

public final java.lang.String getText()

Returns the String corresponding to the ad's body text.

getMainImageUrl

public final java.lang.String getMainImageUrl()

Returns the String url corresponding to the ad's main image.

getIconImageUrl

public final java.lang.String getIconImageUrl()

Returns the String url corresponding to the ad's icon image.

getCallToAction

public final java.lang.String getCallToAction()

Returns the Call To Action String (i.e. "Download" or "Learn More") associated with this ad.

getStarRating

public final java.lang.Double getStarRating()

For app install ads, this returns the associated star rating (on a 5 star scale) for the advertised app. Note that this method may return null if the star rating was either never set or invalid.

getPrivacyInformationIconClickThroughUrl

public final java.lang.String getPrivacyInformationIconClickThroughUrl()

Returns the Privacy Information click through url. No Privacy Information Icon will be shown unless this is set to something non-null using setPrivacyInformationIconClickThroughUrl(String).

Returns:

String representing the Privacy Information Icon click through url, or null if not set.

getPrivacyInformationIconImageUrl

public java.lang.String getPrivacyInformationIconImageUrl()

Returns the Privacy Information image url.

Returns:

String representing the Privacy Information Icon image url, or null if not set.

getExtra

public final java.lang.Object getExtra(java.lang.String key)

Given a particular String key, return the associated Object value from the ad's extras map. See getExtras() for more information.

getExtras

public final java.util.Map<java.lang.String,java.lang.Object> getExtras()

Returns a copy of the extras map, reflecting additional ad content not reflected in any of the above hardcoded setters. This is particularly useful for passing down custom fields with MoPub's direct-sold native ads or from mediated networks that pass back additional fields.

getClickDestinationUrl

public final java.lang.String getClickDestinationUrl()

Returns the String url that the device will attempt to resolve when the ad is clicked.

setMainImageUrl

public final void setMainImageUrl(java.lang.String mainImageUrl)

setIconImageUrl

public final void setIconImageUrl(java.lang.String iconImageUrl)

setClickDestinationUrl

public final void setClickDestinationUrl(java.lang.String clickDestinationUrl)

setCallToAction

public final void setCallToAction(java.lang.String callToAction)

setTitle

public final void setTitle(java.lang.String title)

setText

public final void setText(java.lang.String text)

setStarRating

public final void setStarRating(java.lang.Double starRating)

setPrivacyInformationIconClickThroughUrl

public final void setPrivacyInformationIconClickThroughUrl(java.lang.String privacyInformationIconClickThroughUrl)

setPrivacyInformationIconImageUrl

public final void setPrivacyInformationIconImageUrl(java.lang.String privacyInformationIconImageUrl)

addExtra

public final void addExtra(java.lang.String key,
            java.lang.Object value)

setImpressionMinTimeViewed

public final void setImpressionMinTimeViewed(int impressionMinTimeViewed)

prepare

public void prepare(android.view.View view)

Description copied from class: BaseNativeAd

Your BaseNativeAd subclass should implement this method if the network requires the developer to prepare state for recording an impression or click before a view is rendered to screen. This method is optional.

Specified by:

prepare in class BaseNativeAd

clear

public void clear(android.view.View view)

Description copied from class: BaseNativeAd

Your BaseNativeAd subclass should implement this method if the network requires the developer to reset or clear state of the native ad after it goes off screen and before it is rendered again. This method is optional.

Specified by:

clear in class BaseNativeAd

destroy

public void destroy()

Description copied from class: BaseNativeAd

Your BaseNativeAd subclass should implement this method if the network requires the developer to destroy or cleanup their native ad when they are permanently finished with it. This method is optional.

Specified by:

destroy in class BaseNativeAd

recordImpression

public void recordImpression(android.view.View view)

Your StaticNativeAd subclass should implement this method if the network requires the developer to explicitly record an impression of a view rendered to screen. This method is optional.

Specified by:

recordImpression in interface ImpressionInterface

getImpressionMinPercentageViewed

public final int getImpressionMinPercentageViewed()

Returns the minimum viewable percentage of the ad that must be onscreen for it to be considered visible. See getImpressionMinTimeViewed() for additional impression tracking considerations.

Specified by:

getImpressionMinPercentageViewed in interface ImpressionInterface

getImpressionMinTimeViewed

public final int getImpressionMinTimeViewed()

Returns the minimum amount of time (in milliseconds) the ad that must be onscreen before an impression is recorded. See getImpressionMinPercentageViewed() for additional impression tracking considerations.

Specified by:

getImpressionMinTimeViewed in interface ImpressionInterface

isImpressionRecorded

public final boolean isImpressionRecorded()

Specified by:

isImpressionRecorded in interface ImpressionInterface

setImpressionRecorded

public final void setImpressionRecorded()

Specified by:

setImpressionRecorded in interface ImpressionInterface

handleClick

public void handleClick(android.view.View view)

Your StaticNativeAd subclass should implement this method if the network requires the developer to explicitly handle click events of views rendered to screen. This method is optional.

Specified by:

handleClick in interface ClickInterface