NativeAd

Kotlin |Java

interface NativeAd : Ad

---

A native ad is composed of ad assets that are displayed using Android UI components.

Summary

Nested types
enum NativeAd.NativeAdType : Enum Ad types of a native request.
enum NativeAd.NativeMediaAspectRatio : Enum Media aspect ratio.
enum NativeAd.SwipeGestureDirection : Enum Custom click swipe gesture direction.

Public functions
Unit	enableCustomClickGesture() Enables publishers reporting clicks using custom gestures for this NativeAd.
Boolean	isCustomClickGestureEnabled() Indicates whether clicks can be reported using custom click gestures.
Unit	recordCustomClickGesture() Reports clicks for this NativeAd using custom click gesture.

Public properties
AdChoicesInfo?	adChoicesInfo The information for the AdChoices attribution.
NativeAdEventCallback?	adEventCallback Callback for receiving native ad lifecycle events.
String?	advertiser The text that identifies the advertiser.
String?	body The body text.
String?	callToAction The ad's call to action (such as "Buy" or "Install").
Bundle	extras Retrieves extras assets associated with a native ad, if set by a mediation partner using com.google.android.gms.ads.mediation.NativeAdMapper.extras.
String?	headline The primary text headline.
Image?	icon A small image identifying the advertiser.
Image?	image The main image.
MediaContent	mediaContent The media content associated with this ad.
String?	price For ads about apps, returns a string representing how much the app costs.
Double?	starRating For ads about apps, returns a star rating from 0 to 5 representing how many stars the app has in the store offering it.
String?	store For ads about apps, returns the name of the store offering the app for download.

Inherited functions
From com.google.android.libraries.ads.mobile.sdk.common.Ad Unit destroy() Destroys the ad, stopping any extra processing and destroying resources associated with the ad. ResponseInfo getResponseInfo() Gets information about the ad response for this ad.

Inherited properties
From com.google.android.libraries.ads.mobile.sdk.common.Ad Long placementId An identifier for a placement in reporting.

Public functions

enableCustomClickGesture

fun enableCustomClickGesture(): Unit

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.

isCustomClickGestureEnabled

fun isCustomClickGestureEnabled(): Boolean

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

recordCustomClickGesture

fun recordCustomClickGesture(): Unit

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 properties

adChoicesInfo

val adChoicesInfo: AdChoicesInfo?

The information for the AdChoices attribution.

adEventCallback

var adEventCallback: NativeAdEventCallback?

Callback for receiving native ad lifecycle events.

advertiser

val advertiser: String?

The text that identifies the advertiser.

body

val body: String?

The body text.

callToAction

val callToAction: String?

The ad's call to action (such as "Buy" or "Install").

extras

val extras: Bundle

Retrieves extras assets associated with a native ad, if set by a mediation partner using com.google.android.gms.ads.mediation.NativeAdMapper.extras. Returns an empty bundle in non-mediation scenario.

headline

val headline: String?

The primary text headline.

icon

val icon: Image?

A small image identifying the advertiser.

image

val image: Image?

The main image.

mediaContent

val mediaContent: MediaContent

The media content associated with this ad.

price

val price: String?

For ads about apps, returns a string representing how much the app costs.

starRating

val starRating: Double?

For ads about apps, returns a star rating from 0 to 5 representing how many stars the app has in the store offering it.

store

val store: String?

For ads about apps, returns the name of the store offering the app for download. For example, "Google Play".