NativeAd

abstract class NativeAd

Google 原生广告。

摘要

嵌套类型
abstract class NativeAd.AdChoicesInfo

提供方信息。
abstract class NativeAd.Image

原生广告图片素材资源。

接口定义，用于在原生广告成功加载时调用回调。

一种监听器接口，应用可在使用“确认点击”功能时通过该接口接收未确认的点击事件。

公共构造函数

公共函数
abstract Unit

取消之前为相应广告记录的未经确认的点击。
abstract Unit

销毁广告对象。
abstract Unit

此函数已弃用。

使用 enableCustomClickGestureDirection。
abstract NativeAd.AdChoicesInfo?

返回“广告选项”标示的相关信息。
abstract String?

返回用于标识广告客户的文字。
abstract String?

返回正文。
abstract String?

返回广告的号召性用语（例如“购买”或“安装”）。
abstract Bundle!

返回与原生广告关联的一组额外的素材资源。
abstract String?

返回主要文字标题。
abstract NativeAd.Image?

返回用于标识广告客户的小图片。
abstract (Mutable)List<NativeAd.Image!>!

返回大型图片的列表。
abstract MediaContent?

返回与相应广告相关联的 MediaContent。
abstract (Mutable)List<MuteThisAdReason!>!

返回适用于相应广告的“不再显示该广告”原因。
abstract Long

返回相应 NativeAd 的展示位置 ID。
abstract String?

对于有关应用的广告，返回表示应用费用的字符串。
abstract ResponseInfo?

返回已加载广告的 ResponseInfo 对象。
abstract Double?

对于与应用相关的广告，返回一个介于 0 到 5 之间的星级评分，表示应用在提供它的商店中的星级。
abstract String?

对于有关应用的广告，返回提供应用下载服务的商店的名称。
abstract Boolean

此函数已弃用。

使用 enableCustomClickGestureDirection 加载广告时，返回的所有广告都将支持自定义点击手势。
abstract Boolean

如果可以通过编程方式将此广告静音，则返回 true。
abstract Unit
muteThisAd(muteThisAdReason: MuteThisAdReason!)

以编程方式将相应广告设为不再显示。
abstract Unit
performClick(clickData: Bundle!)

应在用户点击广告时调用。
abstract Unit

此函数已弃用。

Google 移动广告 SDK 现在会使用 enableCustomClickGestureDirection 中请求的点击手势方向来跟踪自定义点击手势。
abstract Boolean
recordImpression(impressionData: Bundle!)

应在首次展示广告时调用。
abstract Unit
reportTouchEvent(touchEventData: Bundle!)

当广告上发生触摸事件时，应调用此方法。
abstract Unit

为广告设置 MuteThisAdListener。
abstract Unit

注册一个回调，以便在估计此广告已赚取收入时调用该回调。
abstract Unit
setPlacementId(placementId: Long)

为原生广告设置展示位置 ID。
abstract Unit

为广告设置 UnconfirmedClickListener。

公共构造函数

NativeAd

NativeAd()

公共函数

cancelUnconfirmedClick

abstract fun cancelUnconfirmedClick(): Unit

取消之前为相应广告记录的未经确认的点击。

销毁

abstract fun destroy(): Unit

销毁广告对象。在调用 destroy 后，不应再对广告对象调用任何其他方法。

enableCustomClickGesture

abstract fun enableCustomClickGesture(): Unit

允许发布商针对此 NativeAd 使用自定义手势报告点击。广告单元必须列入许可名单，才能使用此方法。

默认情况下，SDK 会跟踪素材资源视图上的点击。如果调用此方法，SDK 将不再跟踪相应 NativeAd 的点击。应在展示广告之前调用。

getAdChoicesInfo

abstract fun getAdChoicesInfo(): NativeAd.AdChoicesInfo?

返回“广告选项”标示的相关信息。

getAdvertiser

abstract fun getAdvertiser(): String?

返回用于标识广告客户的文字。应用不一定需要展示此素材资源，但建议展示。

getBody

abstract fun getBody(): String?

返回正文。应用必须显示此素材资源。

getCallToAction

abstract fun getCallToAction(): String?

返回广告的号召性用语（例如“购买”或“安装”）。应用不一定需要展示此素材资源，但建议展示。

getExtras

abstract fun getExtras(): Bundle!

返回与原生广告关联的一组额外的素材资源。如果中介合作伙伴的广告除了标准素材资源（价格、商店等）之外还有其他素材资源，则可以通过调用 setExtras 中的方法来设置这些素材资源，也可以通过此方法来检索这些素材资源。对于非中介流程，它会返回一个空 bundle。

getHeadline

abstract fun getHeadline(): String?

返回主要文字标题。应用必须显示此素材资源。

getIcon

abstract fun getIcon(): NativeAd.Image?

返回用于标识广告客户的小图片。应用不一定需要展示此素材资源，但建议展示。

getImages

abstract fun getImages(): (Mutable)List<NativeAd.Image!>!

返回大型图片的列表。应用不一定需要展示此素材资源，但建议展示。

getMediaContent

abstract fun getMediaContent(): MediaContent?

返回与相应广告相关联的 MediaContent。

getMuteThisAdReasons

abstract fun getMuteThisAdReasons(): (Mutable)List<MuteThisAdReason!>!

返回适用于相应广告的“不再显示该广告”原因。使用类中的文本说明向用户显示。

getPlacementId

abstract fun getPlacementId(): Long

返回相应 NativeAd 的展示位置 ID。

getPrice

abstract fun getPrice(): String?

对于有关应用的广告，返回表示应用价格的字符串。应用不一定需要展示此素材资源，但建议展示。

getResponseInfo

abstract fun getResponseInfo(): ResponseInfo?

返回已加载广告的 ResponseInfo 对象。在广告成功加载之前，返回 null。

getStarRating

abstract fun getStarRating(): Double?

对于与应用相关的广告，返回 0 到 5 之间的星级评分，表示提供相应应用的商店中该应用的星级。应用不一定需要展示此素材资源，但建议展示。

getStore

abstract fun getStore(): String?

对于有关应用的广告，返回提供应用下载服务的商店的名称。例如，“Google Play”。应用不一定需要展示此素材资源，但建议展示。

isCustomClickGestureEnabled

abstract fun isCustomClickGestureEnabled(): Boolean

表示是否可以使用自定义点击手势报告点击。与您的客户经理联系，请其将您的广告单元列入此功能的许可名单。

isCustomMuteThisAdEnabled

abstract fun isCustomMuteThisAdEnabled(): Boolean

如果可以通过编程方式将此广告静音，则返回 true。使用 setRequestCustomMuteThisAd 请求自定义版“不再显示该广告”功能。

muteThisAd

abstract fun muteThisAd(muteThisAdReason: MuteThisAdReason!): Unit

以编程方式将相应广告设为不再显示。

参数
muteThisAdReason: MuteThisAdReason!

用户选择的静音原因。从 getMuteThisAdReasons 获取静音原因。使用 null 可不再显示该广告，并提供默认原因。

performClick

abstract fun performClick(clickData: Bundle!): Unit

应在用户点击广告时调用。广告单元必须已列入许可名单，才能使用此 API。此方法应仅供 Unity 插件发布商使用。

参数
clickData: Bundle!

点击发生时应用环境的软件包。如需了解如何构建点击数据 Bundle 的详细信息，请参阅 NativeAdConstants。

recordCustomClickGesture

abstract fun recordCustomClickGesture(): Unit

使用自定义点击手势报告相应 NativeAd 的点击次数。广告单元必须列入许可名单，才能使用此方法。

必须先调用 enableCustomClickGesture，然后才能调用此方法。

recordImpression

abstract fun recordImpression(impressionData: Bundle!): Boolean

应在首次展示广告时调用。广告单元必须已列入许可名单，才能使用此 API。

参数
impressionData: Bundle!

发生展示时应用环境的软件包。如需了解如何构建点击数据 Bundle 的详细信息，请参阅 NativeAdConstants。
返回
Boolean

如果成功记录展示，则为 true

reportTouchEvent

abstract fun reportTouchEvent(touchEventData: Bundle!): Unit

当广告上发生触摸事件时，应调用此方法。广告单元必须已列入许可名单，才能使用此 API。如果您有意使用此功能，请与您的客户经理联系。

参数
touchEventData: Bundle!

触控事件坐标和时长的 bundle。

touchEventData Bundle 的 JSON 表示法示例：

  {    "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.  }

setMuteThisAdListener

abstract fun setMuteThisAdListener(listener: MuteThisAdListener!): Unit

为广告设置 MuteThisAdListener。

setOnPaidEventListener

abstract fun setOnPaidEventListener(listener: OnPaidEventListener?): Unit

注册一个回调，以便在估计此广告已赚取收入时调用该回调。

setPlacementId

abstract fun setPlacementId(placementId: Long): Unit

为原生广告设置展示位置 ID。

为确保此展示位置 ID 包含在报告中，请在将广告与 NativeAdView 相关联之前调用此方法。

参数
placementId: Long

AdMob 界面为配置的展示位置提供的长整数。

setUnconfirmedClickListener

abstract fun setUnconfirmedClickListener(
    listener: NativeAd.UnconfirmedClickListener!
): Unit

为广告设置 UnconfirmedClickListener。