目录

NativeAd

Class Info

public abstract class NativeAd extends Object

原生广告。

Nested Class Summary

Qualifier and Type

Class Name and Description

static interface

NativeAd.NativeAdLoadedListener

原生广告加载成功的监听器。

Public Constructor Summary

Constructor Name

NativeAd()

原生广告构造函数。

Public Method Summary

Qualifier and Type

Method Name and Description

abstract void

destroy()

销毁广告对象。

abstract void

dislikeAd(DislikeAdReason reason)

不显示该广告，被调用后关闭广告。

abstract String

getAdSign()

标识本任务是否是广告。

abstract String

getAdSource()

获取广告来源。

abstract String

getCallToAction()

获取广告行为按钮的显示文字（例如“查看详情”或“安装”）。

abstract int

getCreativeType()

获取广告素材创意类型。

abstract String

getDescription()

获取广告描述。

abstract List<DislikeAdReason>

getDislikeAdReasons()

获取“不显示该广告”选项。

Map<String, String>

getExt()

获取广告的扩展信息。

abstract Image

getIcon()

获取广告的小图标。

abstract List<Image>

getImages()

获取广告内容多图素材。

abstract MediaContent

getMediaContent()

获取广告多媒体内容信息。

abstract String

getTitle()

获取广告标题。

abstract String

getUniqueId()

获取广告标识。

abstract Video

getVideo()

获取广告内容的视频素材。

abstract VideoOperator

getVideoOperator()

获取广告的视频控制器。

abstract String

getWhyThisAd()

获取“为什么显示此广告”跳转链接。

abstract void

gotoWhyThisAdPage(Context context)

打开为什么显示此广告。

abstract boolean

isCustomClickAllowed()

判断是否允许自定义点击手势。

abstract boolean

isCustomDislikeThisAdEnabled()

判断是否支持自定义关闭广告。

abstract void

onAdClose(Context context, List<String> keyWords)

用户关闭广告调用。

abstract void

recordClickEvent()

上报自定义的点击事件。

abstract boolean

recordClickEvent(Bundle data)

上报自定义的点击事件。

abstract boolean

recordImpressionEvent(Bundle data)

上报广告曝光事件。

abstract boolean

recordShowStartEvent(Bundle data)

上报广告开始展示事件。

abstract void

setAllowCustomClick()

设置允许使用自定义点击手势。

abstract void

setDislikeAdListener(DislikeAdListener listener)

设置关闭广告监听器。

abstract void

triggerClick(Bundle data)

上报点击操作。

abstract String

getDspName()

获取广告DSP名称。

abstract String

getDspLogo()

获取广告DspLogo的url。

abstract boolean

hasAdvertiserInfo()

当前广告是否下发广告主信息。

abstract List<AdvertiserInfo>

getAdvertiserInfo()

获取广告主信息列表。

abstract void

showAppDetailPage(Context context)

展示推广应用的介绍页。

abstract boolean

isTransparencyOpen()

是否需要展示广告透明性信息 。

abstract String

getTransparencyTplUrl()

获取广告透明性信息跳转链接。

abstract int

getInterActionType()

获取广告推广目的。

abstract void

setVideoConfiguration(VideoConfiguration videoConfiguration)

设置视频播放的参数。

具体参考VideoConfiguration。

abstract BiddingInfo

getBiddingInfo()

获取返回给媒体实时bidding相关数据。

void

sendBiddingSuccess(Map<String, Object> sendSuccessInfo, ReportUrlListener reportUrlListener)

上报Bidding竞价成功接口。

void

sendBiddingFailed(Map<String, Object> sendFailInfo, ReportUrlListener reportUrlListener)

上报Bidding竞价失败接口。

Public Constructors

[h2]NativeAd

Constructor

public NativeAd()

创原生广告构造函数。

Public Methods

[h2]destroy

Method

public abstract void destroy()

销毁广告对象。在调用destroy()之后，不得在广告对象上调用其他方法。

[h2]dislikeAd

Method

public abstract void dislikeAd(DislikeAdReason reason)

不显示该广告，被调用后关闭广告。

Parameters

Name

Description

reason

用户选择的不显示该广告的原因。

[h2]getAdSign

Method

public abstract String getAdSign()

标识本任务是否为广告。

Returns

Type

Description

String

本任务的标识：

  • 0：非广告
  • 1：广告

默认值为1。

[h2]getAdSource

Method

public abstract String getAdSource()

获取广告来源。

Returns

Type

Description

String

广告来源。

[h2]getCallToAction

Method

public abstract String getCallToAction()

获取广告行为按钮的显示文字（例如“查看详情”或“安装”）。

Returns

Type

Description

String

广告行为按钮的显示文字。

[h2]getCreativeType

Method

public abstract int getCreativeType()

获取广告素材创意类型。

Returns

Type

Description

int

广告素材创意类型。

  • 1：纯文字。
  • 2：大纯图片。
  • 3：大纯图加文字。
  • 4：GIF。
  • 5：无具体创意类型，针对的是杂志锁屏返回元数据的情况。
  • 6：视频加文字。
  • 7：小纯图加文字。
  • 8：三个小纯图加文字。
  • 9：视频。
  • 12：联动视频。
  • 100：未知类型，一般为出错的情况下使用。
  • 101：纯文字带下载按钮。
  • 102：大纯图片带下载按钮。
  • 103：大纯图加文字带下载按钮。
  • 106：视频加文字带下载按钮。
  • 107：小纯图加文字带下载按钮。
  • 108：三个小纯图加文字带下载按钮。

[h2]getDescription

Method

public abstract String getDescription()

获取广告描述。

Returns

Type

Description

String

广告描述。

[h2]getDislikeAdReasons

Method

public abstract List<DislikeAdReason> getDislikeAdReasons()

获取“不显示该广告”选项。

Returns

Type

Description

List<DislikeAdReason>

“不显示该广告”选项。

[h2]getExt

Method

public Map<String, String> getExt()

获取广告的扩展信息。

Returns

Type

Description

Map<String, String>

广告的扩展信息。

[h2]getIcon

Method

public abstract Image getIcon()

获取广告的小图标。

Returns

Type

Description

Image

广告的小图标。

[h2]getImages

Method

public abstract List<Image> getImages()

获取广告内容多图素材。

Returns

Type

Description

List<Image>

广告内容多图素材。

[h2]getMediaContent

Method

public abstract MediaContent getMediaContent()

获取广告多媒体内容信息。

Returns

Type

Description

MediaContent

广告多媒体内容信息。

[h2]getTitle

Method

public abstract String getTitle()

获取广告标题。

Returns

Type

Description

String

广告标题。

[h2]getUniqueId

Method

public abstract String getUniqueId()

获取广告标识。

Returns

Type

Description

String

广告标识。

[h2]getVideo

Method

public abstract Video getVideo()

获取广告内容的视频素材。

Returns

Type

Description

Video

广告内容的视频素材。

[h2]getVideoOperator

Method

public abstract VideoOperator getVideoOperator()

获取广告的视频控制器。

Returns

Type

Description

VideoOperator

广告的视频控制器。

[h2]getWhyThisAd

Method

public abstract String getWhyThisAd()

获取“为什么显示此广告”跳转链接。

Returns

Type

Description

String

“为什么显示此广告”跳转链接。

[h2]gotoWhyThisAdPage

Method

public abstract void gotoWhyThisAdPage(Context context)

打开为什么显示此广告或广告透明性信息 。

Parameters

Name

Description

context

上下文。

[h2]isCustomClickAllowed

Method

public abstract boolean isCustomClickAllowed()

判断是否允许自定义点击手势。

Returns

Type

Description

boolean

是否允许自定义点击手势：

  • true：是。
  • false：否。

默认值为false。

[h2]isCustomDislikeThisAdEnabled

Method

public abstract boolean isCustomDislikeThisAdEnabled()

判断是否支持自定义关闭广告。

Returns

Type

Description

boolean

是否支持自定义关闭广告：

  • true：是。
  • false：否。

默认值为false。

[h2]onAdClose

Method

public abstract void onAdClose(Context context, List<String> keyWords)

用户关闭广告调用。

Parameters

Name

Description

context

上下文。

keyWords

广告关键词。

[h2]recordClickEvent

Method

public abstract void recordClickEvent()

上报自定义的点击事件。

[h2]recordClickEvent(Bundle data)

Method

public abstract boolean recordClickEvent(Bundle data)

上报自定义的点击事件。

Parameters

Name

Description

data

传入的点击事件数据。可传入clickX，clickY，creativeSize用于流量变现优化。

  • clickX:点击位置相对于广告位的横坐标。

    类型:int。长度单位:px。例如:10。

  • clickY:点击位置相对于广告位的纵坐标。

    类型:int。长度单位:px。例如:10。

  • creativeSize:广告位的尺寸（宽*高）。

    类型:String。长度单位：px。例如:1080*600。

Returns

Type

Description

boolean

是否上报成功：

  • true：上报成功。
  • false：上报失败。

默认值为false。

[h2]recordImpressionEvent

Method

public abstract boolean recordImpressionEvent(Bundle data)

上报广告曝光事件。

Parameters

Name

Description

data

曝光发生时携带的曝光数据信息。

Returns

Type

Description

boolean

上报广告曝光事件：

  • true：曝光记录成功。
  • false：曝光记录失败。

[h2]recordShowStartEvent

Method

public abstract boolean recordShowStartEvent(Bundle data)

上报广告开始展示事件。

Parameters

Name

Description

data

上报事件中携带的数据。

Returns

Type

Description

boolean

上报广告开始展示事件：

  • true：展示事件记录成功。
  • false：展示事件记录失败。

[h2]setAllowCustomClick

Method

public abstract void setAllowCustomClick()

设置允许使用自定义点击手势。

[h2]setDislikeAdListener

Method

public abstract void setDislikeAdListener(DislikeAdListener listener)

设置关闭广告监听器。

Parameters

Name

Description

listener

关闭广告监听器。

[h2]triggerClick

Method

public abstract void triggerClick(Bundle data)

手动触发点击。

Parameters

Name

Description

data

点击发生时携带的点击数据信息。可传入clickX，clickY，creativeSize用于流量变现优化。

  • clickX：点击位置相对于广告位的横坐标。

    类型：int。长度单位：px。例如：10。

  • clickY：点击位置相对于广告位的纵坐标。

    类型：int。长度单位：px。例如：10。

  • creativeSize：广告位的尺寸（宽*高）。

    类型：String。长度单位：px。例如：1080*600。

[h2]getDspName

Method

public abstract String getDspName()

获取广告DSP名称。

Returns

Type

Description

String

广告DSP名称。

[h2]getDspLogo

Method

public abstract String getDspLogo()

获取广告DspLogo 的url。

Returns

Type

Description

String

广告DspLogo的url。

[h2]hasAdvertiserInfo

Method

public abstract boolean hasAdvertiserInfo()

当前广告是否下发广告主信息。

Returns

Type

Description

boolean

是否下发广告主信息，true：下发；false：未下发。

[h2]getAdvertiserInfo

Method

public abstract List getAdvertiserInfo()

获取广告主信息。

Returns

Type

Description

List<AdvertiserInfo>

广告主信息列表。

[h2]showAppDetailPage

Method

public abstract void showAppDetailPage(Context context)

展示推广应用的介绍页。

Parameters

Name

Description

context

上下文。

[h2]isTransparencyOpen

Method

public abstract boolean isTransparencyOpen()

是否需要展示广告透明性信息。

Parameters

Name

Description

boolean

是否需要展示广告透明性信息。

[h2]getTransparencyTplUrl

Method

public abstract String getTransparencyTplUrl()

获取广告透明性信息跳转链接。

Parameters

Name

Description

String

广告透明性信息跳转链接。

[h2]getInterActionType

Method

public abstract int getInterActionType()

获取广告推广目的。

Returns

Type

Description

int

推广目的:

0：纯展示（即点击无反应）。

1：网页推广（目的是点击打开网页）。

2：应用下载（目的是下载普通应用）。

3：应用促活（目的是点击进入应用内）或者快应用。

5：应用推广（未安装则下载，已安装则促活）。

7：电商网页（安装则进入应用，未安装打开网页）。

8：预约下载。

9：鸿蒙服务。

10：拉起小程序。

[h2]setVideoConfiguration(VideoConfiguration videoConfiguration)

Method

Public abstract void setVideoConfiguration(VideoConfiguration videoConfiguration)

视频播放参数设置。

Returns

Type

Description

videoConfiguration

视频配置，控制视频播放设置。

[h2]getBiddingInfo

Method

public abstract BiddingInfo getBiddingInfo()

获取返回给媒体实时bidding相关数据。

Returns

Type

Description

BiddingInfo

BiddingInfo实时bidding ADX返回的参数。

[h2]sendBiddingSuccess

Method

public void sendBiddingSuccess(Map<String, Object> sendSuccessInfo, ReportUrlListener reportUrlListener)

Bidding竞价成功调用该函数，上报竞价成功。

Parameters

Name

Description

sendSuccessInfo

竞价成功的宏替换参数，是Map类型。

key是URL中需要替换的宏，宏是String类型，value是对应替换的信息，是Object类型。

相关宏替换参考：实时竞价广告。

ReportUrlListener

竞价结果上报回调。

[h2]sendBiddingFailed

Method

public void sendBiddingFailed(Map<String, Object> sendFailInfo, ReportUrlListener reportUrlListener)

Bidding竞价失败调用该函数，上报竞价失败。

Parameters

Name

Description

sendFailInfo

竞价失败的宏替换参数，是Map类型

key是URL中需要替换的宏，宏是String类型，value是对应替换的信息，是Object类型。

相关宏替换参考：实时竞价广告。

ReportUrlListener

竞价结果上报回调。