Reference (Old Docs)
NativeAd

NativeAd provides ad creative for apps to rendered in custom layout.

To use NativeAd, do the following:

NativeAd nativeAd = new NativeAd(context, PLACEMENT_ID); nativeAd.setAdListener(new AbstractAdListener() { public void onAdLoaded(Ad ad) { if (ad == nativeAd) { // Renders the ad using creative properties String adTitle = getAdTitle(); } } }); nativeAd.loadAd();

Before displaying the ad, call NativeAd.registerViewForInteraction(android.view.View viewContainer) to handle logging of ad impressions and clicks.

Extends:Object
Implements:Ad
Package:ads
Constructors
NativeAd(Context, String)

Constructs an NativeAd using the given context and placement id.

public NativeAd(Context context, String placementId)
ParameterDescription
contextAndroid context
placementIdId of ad placement
NativeAd(Context, NativeAdapter, AdPlacementDefinition)
public NativeAd(Context context, NativeAdapter adapter, AdPlacementDefinition placementDefinition)
ParameterDescription
context
adapter
placementDefinition
Class Methods
downloadAndDisplayImage(Image, ImageView)

Downloads the given Image and displays it in the given ImageView.

This method always returns immediately. Image is downloaded asynchronously.

public static void downloadAndDisplayImage(Image image, ImageView imageView)
ParameterDescription
imageImage to be downloaded
imageViewView to show the downloaded image
viewIsRegisteredForInteraction(View)
protected static boolean viewIsRegisteredForInteraction(View view)
ParameterDescription
view
Instance Methods
setAdListener(AdListener)
public void setAdListener(AdListener adListener)
ParameterDescription
adListener
setImpressionListener(ImpressionListener)
public void setImpressionListener(ImpressionListener impListener)
ParameterDescription
impListenerThe listener
getAdNetwork()

Returns the enum for the ad network from which the ad has been loaded.

public AdNetwork getAdNetwork()
Returns
AdNetwork enum for the network from which the ad is from. Returns null if ad hasn't been loaded.
loadAd()

Loads an ad.

This method always returns immediately. The ad is loaded asynchronously. The control's ad listener will be called when loading finishes or fails.

public void loadAd()
loadAd()
public void loadAd()
loadAd(EnumSet)
public void loadAd(EnumSet mediaCacheFlags)
ParameterDescription
mediaCacheFlags
destroy()

Destroys the ad control.

This method should be called when the hosting activity of the ad control is destroyed.

public void destroy()
destroy()
public void destroy()
getPlacementId()

Get the placementId for this ad.

public String getPlacementId()
Returns
PlacementId String representing the placementId for this ad.
getPlacementId()
public String getPlacementId()
isAdLoaded()

Gets whether an ad is loaded and ready to show.

public boolean isAdLoaded()
Returns
Whether an ad is loaded
isNativeConfigEnabled()

Gets whether ad config settings are enabled or not

public boolean isNativeConfigEnabled()
Returns
Whether ad config settings are loaded
getAdIcon()

Gets the icon creative.

public Image getAdIcon()
Returns
The ad icon
getAdCoverImage()

Gets the cover image creative.

public Image getAdCoverImage()
Returns
The ad cover image
getAdViewAttributes()

Gets the ad configuration settings.

public NativeAdViewAttributes getAdViewAttributes()
Returns
The ad configuration settings
getAdTitle()

Gets the title.

public String getAdTitle()
Returns
The ad title
getAdSubtitle()

Gets the subtitle.

public String getAdSubtitle()
Returns
The ad subtitle
getAdBody()

Gets the body, usually a longer description of the ad.

public String getAdBody()
Returns
The ad body
getAdCallToAction()

Gets the call to action phrase.

public String getAdCallToAction()
Returns
The call to action phrase
getAdSocialContext()

Gets the social context.

public String getAdSocialContext()
Returns
The social content sentence
getAdStarRating()

Gets the star rating.

public Rating getAdStarRating()
Returns
The star rating
getId()

Gets a unique ID for the NativeAd.

public String getId()
Returns
The unique ID
getAdChoicesIcon()
public Image getAdChoicesIcon()
getAdChoicesLinkUrl()
public String getAdChoicesLinkUrl()
registerViewForInteraction(View)

Registers the given view as the container for this NativeAd to handle impressions and clicks. Applies a click handler to the entire unit.

public void registerViewForInteraction(View view)
ParameterDescription
viewThe View containing this NativeAd for display
registerViewForInteraction(View, List)

Registers the given view as the container for this NativeAd to handle impressions and clicks. Applies a click handler all views provided in clickableViews.

public void registerViewForInteraction(View view, List clickableViews)
ParameterDescription
viewThe View containing this NativeAd for display
clickableViewsA list of all view elements that should handle taps on this unit
setMediaViewAutoplay(boolean)
public void setMediaViewAutoplay(boolean mediaViewAutoplay)
ParameterDescription
mediaViewAutoplay
unregisterView()
public void unregisterView()
setOnTouchListener(OnTouchListener)

Sets an OnTouchListener to be notified of touch events on the ad unit. Touchable views that can trigger this listener are either the click-able views if a set was provided in registerViewForInteraction(), or the container view provided to registerViewForInteraction() and all of the container's sub-views.

public void setOnTouchListener(OnTouchListener touchListener)
ParameterDescription
touchListenerThe touch listener