UnifiedNativeAd

public abstract class UnifiedNativeAd extends Object

A Google native ad. Unlike NativeAppInstallAd and NativeContentAd, this class may contain either an app install ad or a content ad.

Nested Class Summary

interface UnifiedNativeAd.MediaContent An object representing the media content from the ad that is rendered within the MediaView. 
interface UnifiedNativeAd.OnUnifiedNativeAdLoadedListener An interface defining a callback that is called when a native ad is loaded. 
interface UnifiedNativeAd.UnconfirmedClickListener A listener interface apps can use to receive unconfirmed click events when using the Confirmed Click feature. 

Public Constructor Summary

UnifiedNativeAd()

Public Method Summary

abstract void
cancelUnconfirmedClick()
Cancels an unconfirmed click that was previously recorded for the ad.
abstract void
destroy()
Destroy the ad object.
abstract void
enableCustomClickGesture()
Enable publishers reporting clicks using custom gestures for this UnifiedNativeAd.
abstract NativeAd.AdChoicesInfo
getAdChoicesInfo()
Returns the information for the AdChoices attribution.
abstract String
getAdvertiser()
Returns text that identifies the advertiser.
abstract String
getBody()
Returns body text.
abstract String
getCallToAction()
Returns the ad's call to action (such as "Buy" or "Install").
abstract Bundle
getExtras()
Returns a bundle of extra assets associated with the native ad.
abstract String
getHeadline()
Returns the primary text headline.
abstract NativeAd.Image
getIcon()
Returns a small image identifying the advertiser.
abstract List<NativeAd.Image>
getImages()
Returns a list of large images.
abstract UnifiedNativeAd.MediaContent
getMediaContent()
Returns the UnifiedNativeAd.MediaContent associated with this ad.
abstract String
getMediationAdapterClassName()
Returns the mediation adapter class name.
abstract List<MuteThisAdReason>
getMuteThisAdReasons()
Returns Mute This Ad reasons available for this ad.
abstract String
getPrice()
For ads about apps, returns a string representing how much the app costs.
abstract Double
getStarRating()
For ads about apps, returns a star rating from 0 to 5 representing how many stars the app has in the store offering it.
abstract String
getStore()
For ads about apps, returns the name of the store offering the app for download.
abstract VideoController
getVideoController()
Returns the VideoController associated with this ad.
abstract boolean
isCustomClickGestureEnabled()
Indicates whether clicks can be reported using custom click gestures.
abstract boolean
isCustomMuteThisAdEnabled()
Returns true if this ad can be muted programmatically.
abstract void
muteThisAd(MuteThisAdReason muteThisAdReason)
Mutes This Ad programmatically.
abstract void
performClick(Bundle clickData)
Should be called when the user has clicked on the ad.
abstract void
recordCustomClickGesture()
Report clicks for this UnifiedNativeAd using custom click gesture.
abstract boolean
recordImpression(Bundle impressionData)
Should be called when the ad is first displayed.
abstract void
reportTouchEvent(Bundle touchEventData)
Should be called when a touch event happens on the ad.
abstract void
setMuteThisAdListener(MuteThisAdListener listener)
Sets the MuteThisAdListener for the ad.
abstract void
setUnconfirmedClickListener(UnifiedNativeAd.UnconfirmedClickListener listener)
Set the UnconfirmedClickListener for the ad.

Inherited Method Summary

Public Constructors

public UnifiedNativeAd ()

Public Methods

public abstract void cancelUnconfirmedClick ()

Cancels an unconfirmed click that was previously recorded for the ad.

public abstract void destroy ()

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

public abstract void enableCustomClickGesture ()

Enable publishers reporting clicks using custom gestures for this UnifiedNativeAd. The ad unit must be whitelisted to be able to use this method.

By default SDK tracks clicks on asset views. If this method is called, SDK will no longer track clicks for this UnifiedNativeAd. It should be called before showing the ad.

public abstract NativeAd.AdChoicesInfo getAdChoicesInfo ()

Returns the information for the AdChoices attribution.

public abstract String getAdvertiser ()

Returns text that identifies the advertiser. Apps are not required to display this asset, though it's recommended.

public abstract String getBody ()

Returns body text. Apps are required to display this asset.

public abstract String getCallToAction ()

Returns the ad's call to action (such as "Buy" or "Install"). Apps are not required to display this asset, though it's recommended.

public abstract Bundle getExtras ()

Returns a bundle of extra assets associated with the native ad. If a mediation partner's ad have assets besides the standard ones (price, store, etc.), they can be set by calling the method in setExtras(Bundle), and can be retrieved via this method. For non-mediation flow, it returns an empty bundle.

public abstract String getHeadline ()

Returns the primary text headline. Apps are required to display this asset.

public abstract NativeAd.Image getIcon ()

Returns a small image identifying the advertiser. Apps are not required to display this asset, though it's recommended.

public abstract List<NativeAd.Image> getImages ()

Returns a list of large images. Apps are not required to display this asset, though it's recommended.

public abstract UnifiedNativeAd.MediaContent getMediaContent ()

Returns the UnifiedNativeAd.MediaContent associated with this ad.

public abstract String getMediationAdapterClassName ()

Returns the mediation adapter class name. In the case of a mediated ad response, this is the name of the class that was responsible for performing the ad request and returning the ad.

public abstract List<MuteThisAdReason> getMuteThisAdReasons ()

Returns Mute This Ad reasons available for this ad. Use the text description from MuteThisAdReason class for showing to user.

public abstract String getPrice ()

For ads about apps, returns a string representing how much the app costs. Apps are not required to display this asset, though it's recommended.

public abstract Double getStarRating ()

For ads about apps, returns a star rating from 0 to 5 representing how many stars the app has in the store offering it. Apps are not required to display this asset, though it's recommended.

public abstract String getStore ()

For ads about apps, returns the name of the store offering the app for download. For example, "Google Play". Apps are not required to display this asset, though it's recommended.

public abstract VideoController getVideoController ()

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

public abstract boolean isCustomClickGestureEnabled ()

Indicates whether clicks can be reported using custom click gestures. Reach out to your account manager to whitelist your ad unit for this feature.

public abstract boolean isCustomMuteThisAdEnabled ()

Returns true if this ad can be muted programmatically. Use setRequestCustomMuteThisAd(boolean) to request custom implementation of Mute This Ad.

public abstract void muteThisAd (MuteThisAdReason muteThisAdReason)

Mutes This Ad programmatically.

Parameters
muteThisAdReason The mute reason selected by the user. Get mute reasons from getMuteThisAdReasons(). Use null to Mute This Ad with default reason.

public abstract void performClick (Bundle clickData)

Should be called when the user has clicked on the ad. The ad unit must be whitelisted to be able to use this api. This method should only be used by Unity plugin publishers.

Parameters
clickData bundle of the app environment when the click happens. For details to construct the click data Bundle, see NativeAdConstants.

public abstract void recordCustomClickGesture ()

Report clicks for this UnifiedNativeAd using custom click gesture. The ad unit must be whitelisted to be able to use this method.

enableCustomClickGesture() must be called before calling this method.

public abstract boolean recordImpression (Bundle impressionData)

Should be called when the ad is first displayed. The ad unit must be whitelisted to be able to use this api.

Parameters
impressionData bundle of the app environment when the impression happens. For details to construct the click data Bundle, see NativeAdConstants.
Returns
  • true if the impression is recorded successfully

public abstract void reportTouchEvent (Bundle touchEventData)

Should be called when a touch event happens on the ad. The ad unit must be whitelisted to be able to use this api. If you are interested in using this feature, reach out to your account manager.

Parameters
touchEventData bundle of touch event coordinates and duration.

Example JSON representation of touchEventData Bundle:

   {
     "x": "100",  // The x-coordinate of the touch event relative to the window.
     "y": "50",  // The y-coordinate of the touch event relative to the window.
     "duration_millis": "500",  // The amount of milliseconds the user pressed on the asset.
   }

public abstract void setMuteThisAdListener (MuteThisAdListener listener)

Sets the MuteThisAdListener for the ad.

public abstract void setUnconfirmedClickListener (UnifiedNativeAd.UnconfirmedClickListener listener)

Set the UnconfirmedClickListener for the ad.