NativeCustomFormatAd
public interface 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.
Summary
Nested types |
|---|
public interface NativeCustomFormatAd.DisplayOpenMeasurementAn interface for open measurement in display ads. |
public interface NativeCustomFormatAd.OnCustomClickListenerInterface definition for a callback to be invoked when a user clicks on a custom native ad format. |
public interface NativeCustomFormatAd.OnCustomFormatAdLoadedListenerInterface definition for a callback to be invoked when a custom native ad format has successfully loaded. |
Constants |
|
|---|---|
default static final String |
ASSET_NAME_VIDEO = "_videoMediaView"The asset name associated with the video content returned by |
Public methods |
|
|---|---|
abstract void |
destroy()Destroys the ad object. |
abstract @Nullable List<String> |
Returns a list of all available assets. |
abstract @Nullable String |
Returns the custom native ad format's ID as defined in the Ad Manager UI. |
abstract NativeCustomFormatAd.DisplayOpenMeasurement |
Returns the |
abstract @Nullable NativeAd.Image |
Returns an image asset. |
abstract @Nullable MediaContent |
Returns the |
abstract @Nullable CharSequence |
Returns a string asset of numbers, URLs, or other types other than an image asset. |
abstract void |
performClick(String assetName)Performs a click on the ad, executing its clickthrough behavior. |
abstract void |
Records an impression. |
Constants
ASSET_NAME_VIDEO
default static final String ASSET_NAME_VIDEO = "_videoMediaView"
The asset name associated with the video content returned by getMediaContent. This is the asset name that will be reported in onCustomClick when the user clicks on the MediaView containing with the video content returned by getMediaContent.
Public methods
destroy
abstract void destroy()
Destroys the ad object. No other methods should be called on the ad object after destroy is called.
getAvailableAssetNames
abstract @Nullable List<String> getAvailableAssetNames()
Returns a list of all available assets.
getCustomFormatId
abstract @Nullable String getCustomFormatId()
Returns the custom native ad format's ID as defined in the Ad Manager UI.
getDisplayOpenMeasurement
abstract NativeCustomFormatAd.DisplayOpenMeasurement getDisplayOpenMeasurement()
Returns the DisplayOpenMeasurement associated with this ad.
| Returns | |
|---|---|
NativeCustomFormatAd.DisplayOpenMeasurement |
|
getImage
abstract @Nullable NativeAd.Image getImage(String assetName)
Returns an image asset.
| Parameters | |
|---|---|
String assetName |
The name of the asset to be retrieved. |
| Returns | |
|---|---|
@Nullable NativeAd.Image |
the value of the asset with the asset name, or null if there's no such asset name. |
getMediaContent
abstract @Nullable MediaContent getMediaContent()
Returns the MediaContent associated with this ad.
getText
abstract @Nullable CharSequence getText(String assetName)
Returns a string asset of numbers, URLs, or other types other than an image asset.
| Parameters | |
|---|---|
String assetName |
The name of the asset to be retrieved. |
| Returns | |
|---|---|
@Nullable CharSequence |
the value of the asset with the asset name, or null if there's no such asset name. |
performClick
abstract void performClick(String assetName)
Performs a click on the ad, executing its clickthrough behavior.
| Parameters | |
|---|---|
String assetName |
The name of the asset that was clicked. |
recordImpression
abstract void recordImpression()
Records an impression. Call this method when the ad is first shown to the user.