NativeAd

public abstract void cancelUnconfirmedClick()

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

public abstract void destroy()

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

public abstract void enableCustomClickGesture()

Enables publishers reporting clicks using custom gestures for this NativeAd. The ad unit must be allowlisted 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 NativeAd. It should be called before showing the ad.

public abstract @Nullable NativeAd.AdChoicesInfo getAdChoicesInfo()

Returns the information for the AdChoices attribution.

public abstract @Nullable String getAdvertiser()

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

public abstract @Nullable String getBody()

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

public abstract @Nullable 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, and can be retrieved via this method. For non-mediation flow, it returns an empty bundle.

public abstract @Nullable String getHeadline()

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

public abstract @Nullable 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 @Nullable MediaContent getMediaContent()

Returns the MediaContent associated with this ad.

public abstract List<MuteThisAdReason> getMuteThisAdReasons()

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

public abstract @Nullable 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 @Nullable ResponseInfo getResponseInfo()

Returns the ResponseInfo object for the loaded ad. Returns null until the ad successfully loads.

public abstract @Nullable 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 @Nullable 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 boolean isCustomClickGestureEnabled()

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

public abstract boolean isCustomMuteThisAdEnabled()

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

public abstract void muteThisAd(MuteThisAdReason muteThisAdReason)

Mutes This Ad programmatically.

public abstract void performClick(Bundle clickData)

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

public abstract void recordCustomClickGesture()

Reports clicks for this NativeAd using custom click gesture. The ad unit must be allowlisted 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 allowlisted to be able to use this api.

public abstract void reportTouchEvent(Bundle touchEventData)

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

  {    "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 setOnPaidEventListener(@Nullable OnPaidEventListener listener)

Register a callback to be invoked when this ad is estimated to have earned money.

public abstract void setUnconfirmedClickListener(
    NativeAd.UnconfirmedClickListener listener
)

Sets the UnconfirmedClickListener for the ad.