NativeCustomFormatAd

An Ad Manager custom native ad format. Custom (user-defined) native ad formats allow you to define your own variables for traditional native ads. Custom native ad formats let you define and render your own assets, and allows you to define the click behavior of the ad.

Nested Class Summary

interface	NativeCustomFormatAd.DisplayOpenMeasurement	An interface for open measurement in display ads.
interface	NativeCustomFormatAd.OnCustomClickListener	Interface definition for a callback to be invoked when a user clicks on a custom native ad format.
interface	NativeCustomFormatAd.OnCustomFormatAdLoadedListener	Interface definition for a callback to be invoked when a custom native ad format has successfully 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	getCustomFormatId() Returns the custom native ad format's ID as defined in the Ad Manager UI.
abstract NativeCustomFormatAd.DisplayOpenMeasurement	getDisplayOpenMeasurement() Returns the `NativeCustomFormatAd.DisplayOpenMeasurement` associated with 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 content 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() Pings impression URLs and records 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 NativeCustomFormatAd.OnCustomClickListener.onCustomClick(NativeCustomFormatAd, 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 getCustomFormatId ()

Returns the custom native ad format's ID as defined in the Ad Manager UI.

public abstract NativeCustomFormatAd.DisplayOpenMeasurement getDisplayOpenMeasurement ()

Returns the NativeCustomFormatAd.DisplayOpenMeasurement associated with this ad.

Returns

null if display open measurement is not available for 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 VideoController.hasVideoContent() method on the returned VideoController object.

public abstract MediaView getVideoMediaView ()

Returns a MediaView containing this ad's video content 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 was clicked.

public abstract void recordImpression ()

Pings impression URLs and records the impression. Called when the ad is first displayed.