NativeCustomTemplateAd

public interface NativeCustomTemplateAd

A native custom template ad. In addition to NativeContentAd and NativeAppInstallAd, custom templates let you define and render your own assets, and allows you to define the click behavior of the ad.

Nested Class Summary

interface NativeCustomTemplateAd.OnCustomClickListener An interface defining a callback that is called when a user clicks on a custom template native ad that has a custom click action. 
interface NativeCustomTemplateAd.OnCustomTemplateAdLoadedListener An interface defining a callback that is called when a native custom template ad is loaded. 

Constant Summary

String ASSET_NAME_VIDEO The asset name associated with the MediaView returned by getVideoMediaView().

Public Method Summary

abstract void
destroy()
Destroys the ad object.
abstract List<String>
getAvailableAssetNames()
Returns a list of all available assets.
abstract String
getCustomTemplateId()
Returns the ID of the custom template used to request this ad.
abstract NativeAd.Image
getImage(String assetName)
Returns an image asset.
abstract CharSequence
getText(String assetName)
Returns a string asset of numbers, URLs, or other types other than an image asset.
abstract VideoController
getVideoController()
Returns the VideoController associated with this ad.
abstract MediaView
getVideoMediaView()
Returns a MediaView containing this ad's video conten or null if there is no video content.
abstract void
performClick(String assetName)
Called when the user has clicked on the ad.
abstract void
recordImpression()
Ping impression URLs and record the impression.

Constants

public static final String ASSET_NAME_VIDEO

The asset name associated with the MediaView returned by getVideoMediaView(). This is the asset name that will be reported in onCustomClick(NativeCustomTemplateAd, String) when the user clicks on the video MediaView.

Constant Value: "_videoMediaView"

Public Methods

public abstract void destroy ()

Destroys the ad object. No other methods should be called on the ad object after destroy() is called.

public abstract List<String> getAvailableAssetNames ()

Returns a list of all available assets.

Returns
  • a list of all available assets, or an empty list if no asset is available.

public abstract String getCustomTemplateId ()

Returns the ID of the custom template used to request this ad.

public abstract NativeAd.Image getImage (String assetName)

Returns an image asset.

Parameters
assetName The name of the asset to be retrieved.
Returns
  • the value of the asset with the asset name, or null if there's no such asset name.

public abstract CharSequence getText (String assetName)

Returns a string asset of numbers, URLs, or other types other than an image asset.

Parameters
assetName The name of the asset to be retrieved.
Returns
  • the value of the asset with the asset name, or null if there's no such asset name.

public abstract VideoController getVideoController ()

Returns the VideoController associated with this ad. This is never null. To check if an ad has video content, call the hasVideoContent() method on the returned VideoController object.

public abstract MediaView getVideoMediaView ()

Returns a MediaView containing this ad's video conten or null if there is no video content.

public abstract void performClick (String assetName)

Called when the user has clicked on the ad.

Parameters
assetName The name of the asset that is performed the click.

public abstract void recordImpression ()

Ping impression URLs and record the impression. Called when the ad is first displayed.