com.applovin.nativeAds

Interface AppLovinNativeAd

public interface AppLovinNativeAd

Defines an in-content ad which should be rendered by you into a custom view that matches the look and feel of your application.

Method Summary

Modifier and Type	Method and Description
long	getAdId() Retrieve a unique identifier for this ad, which can be provided to AppLovin should you see issues with this particular ad.
java.lang.String	getCaptionText() Retrieve the caption of the application being advertised.
java.lang.String	getCtaText() Retrieve the call-to-action / button text of the application being advertised.
java.lang.String	getDescriptionText() Retrieve the description of the application being advertised.
java.lang.String	getIconUrl() Retrieve the URL of an image containing the launcher icon of the application being advertised
java.lang.String	getImageUrl() Retrieve the URL of an image containing a promotional image or screenshot of the application being advertised.
float	getStarRating() Retrieve the URL of an image containing the current Google Play star rating of the application being advertised.
java.lang.String	getTitle() Retrieve the title of the application being advertised.
java.lang.String	getVideoEndTrackingUrl(int percentViewed, boolean firstPlay) Retrieve the URL which should be fired upon video completion.
java.lang.String	getVideoStartTrackingUrl() Retrieve the URL which should be fired upon video start.
java.lang.String	getVideoUrl() Retrieve the URL of a promotional video, if this ad contains a video.
java.lang.String	getZoneId() Deprecated. - Native ads do not have support for zones. This API will be removed in a future SDK release.
boolean	isImagePrecached() Check whether or not all image assets for this ad have been precached.
boolean	isVideoPrecached() Check whether or not this ad's video have been precached.
void	launchClickTarget(android.content.Context context) Handle a click on this native ad by launching the ad's destination.
void	trackImpression() Fires the impression asynchronously.
void	trackImpression(AppLovinPostbackListener postbackListener) Fires the impression asynchronously and notifies the provided delegate.

Method Detail

getAdId

long getAdId()

Retrieve a unique identifier for this ad, which can be provided to AppLovin should you see issues with this particular ad.

getTitle

java.lang.String getTitle()

Retrieve the title of the application being advertised.

getDescriptionText

java.lang.String getDescriptionText()

Retrieve the description of the application being advertised.

getCaptionText

java.lang.String getCaptionText()

Retrieve the caption of the application being advertised. May be null.

getCtaText

java.lang.String getCtaText()

Retrieve the call-to-action / button text of the application being advertised. May be null.

getIconUrl

java.lang.String getIconUrl()

Retrieve the URL of an image containing the launcher icon of the application being advertised

getImageUrl

java.lang.String getImageUrl()

Retrieve the URL of an image containing a promotional image or screenshot of the application being advertised.

getStarRating

float getStarRating()

Retrieve the URL of an image containing the current Google Play star rating of the application being advertised.

getVideoUrl

java.lang.String getVideoUrl()

Retrieve the URL of a promotional video, if this ad contains a video.

Not all native advertisements will contain a video. Therefore, may be null.

trackImpression

void trackImpression()

Fires the impression asynchronously.

trackImpression

void trackImpression(AppLovinPostbackListener postbackListener)

Fires the impression asynchronously and notifies the provided delegate.

getVideoStartTrackingUrl

java.lang.String getVideoStartTrackingUrl()

Retrieve the URL which should be fired upon video start.

getVideoEndTrackingUrl

java.lang.String getVideoEndTrackingUrl(int percentViewed,
                                        boolean firstPlay)

Retrieve the URL which should be fired upon video completion.

Parameters:

percentViewed - The percentage of the video (0 - 100) that was viewed by the user.

firstPlay - Whether or not this postback represents initial playback of the video. The first time you begin playback, you should pass true. If the video is paused for any reason and then later resumed mid-playback, you should fire this postback a second time, passing false to firstPlay.

isImagePrecached

boolean isImagePrecached()

Check whether or not all image assets for this ad have been precached.

Returns:

True if image resources have been pre-cached. In this case, resource URLs retrieved from this instance will point to the local filesystem. False if image resources have not been pre-cached. In this case, resource URLs will point to HTTP or HTTPS resources on the web.

isVideoPrecached

boolean isVideoPrecached()

Check whether or not this ad's video have been precached.

Returns:

True if this ad has a video resource, and it has been pre-cached. In this case, getVideoUrl will point to the local filesystem for this instance. False if video resources have not been pre-cached. In this case, getVideoUrl will point to an HTTP or HTTPS resource on the web.

launchClickTarget

void launchClickTarget(android.content.Context context)

Handle a click on this native ad by launching the ad's destination.

You should call this method anytime the user taps anywhere on your native ad. Calling this method launches Chrome or the Google Play Store and will result in your app being paused.

getZoneId

@Deprecated
java.lang.String getZoneId()

Deprecated. - Native ads do not have support for zones. This API will be removed in a future SDK release.