文档管理中心
API参考广告服务Android-JavaScript基础类和组件NativeAd

NativeAd

概述

原生广告对象。

方法

展开

方法名

描述

参数

返回值

load()

加载广告。

-

-

setRequestConfig(object)

设置广告请求配置参数。

广告位通用广告参数RequestConfig。

-

onLoad(callback)

广告加载成功监听。

callback:广告加载成功的回调函数,callback的参数为Array<AdData>。

Promise<Array<AdData>>:广告加载成功的返回数据。

offLoad()

移除广告加载成功监听。

-

-

onError(callback)

广告加载失败监听。

callback:素材加载失败携带错误码的回调函数,callback的参数为errorcode。

-

offError()

移除广告加载失败监听。

-

-

reportAdShow(object)

上报广告曝光事件。

注意

1、通过工单或者邮箱petalads@huawei.com,向流量运营申请使用该能力。

2、在鲸鸿动能媒体服务平台上选择“媒体管理 > > 设置媒体 > 域名通行名单”进行域名通行名单的设置。

adId:广告素材标识ID。

-

reportAdClick(object)

上报广告点击事件。

注意

1、通过工单或者邮箱petalads@huawei.com,向流量运营申请使用该能力。

2、在鲸鸿动能媒体服务平台上选择“媒体管理 > > 设置媒体 > 域名通行名单”进行域名通行名单的设置。

  • adId:广告素材标识ID。
  • (可选)clickX:点击位置相对于广告位的横坐标。类型:整数,长度单位:px。例如:10。
  • (可选)clickY:点击位置相对于广告位的纵坐标。类型:整数,长度单位:px。例如:10。
  • (可选)clickDTime: number //点击时的时间戳(精确到毫秒) 如: 1710311431611。
  • (可选)clickUTime: number //抬起时的时间戳(精确到毫秒) 如: 1710311431892。
  • (可选)creativeSize:广告位的尺寸(宽*高)。类型:字符串,长度单位:px。例如:360*160。

说明:可传入clickX,clickY,creativeSize用于广告变现服务优化。

-

reportAdClose(object)

上报广告关闭事件。

  • adId:广告素材标识ID。
  • (可选)keyWords:string[]:广告关闭理由。

-

onAdClick(object)

触发点击,广告跳转落地页。

  • adId:广告素材标识ID。
  • (可选)clickX:点击位置相对于广告位的横坐标。类型:整数,长度单位:px。例如:10。
  • (可选)clickY:点击位置相对于广告位的纵坐标。类型:整数,长度单位:px。例如:10。
  • (可选)clickDTime: number //点击时的时间戳(精确到毫秒) 如: 1710311431611。
  • (可选)clickUTime: number //抬起时的时间戳(精确到毫秒) 如: 1710311431892。
  • (可选)creativeSize:广告位的尺寸(宽*高)。类型:字符串,长度单位:px。例如:360*160。

说明:可传入clickX,clickY,creativeSize用于广告变现服务优化。

-

gotoWhyThisAdPage(object)

跳转为什么看到此广告页面。

adId:广告素材标识ID。

-

startDownload(object)

调用开始下载接口。

注意

1、通过工单或者邮箱petalads@huawei.com,向流量运营申请使用该能力。

2、在鲸鸿动能媒体服务平台上选择“媒体管理 > > 设置媒体 > 域名通行名单”进行域名通行名单的设置。

adId:广告素材标识ID。

Promise<number>:下载是否成功。

number取值:

  • 0:下载成功
  • -1:参数错误,下载失败
  • -2:无下载权限

resumeDownload(object)

调用重启下载接口。

adId:广告素材标识ID。

Promise<number>:重启下载是否成功。

number取值:

  • 0:下载成功
  • -1:参数错误,下载失败
  • -2:无下载权限

pauseDownload(object)

调用暂停下载接口。

adId:广告素材标识ID。

-

cancelDownload(object)

调用取消下载接口。

adId:广告素材标识ID。

-

getDownloadProgress(object)

获取应用下载进度。

adId:广告素材标识ID。

Promise<number>:获取当前下载进度。

number取值范围:[0, 100]。

getAppStatus(object)

获取应用下载状态。

adId:广告素材标识ID。

Promise<string>

取值:

  • DOWNLOAD:下载未开始,应用初始状态
  • DOWNLOADING: 应用下载中
  • DOWNLOADFAILED:下载失败
  • WAITING:下载等待中
  • PAUSE:应用下载暂停中
  • INSTALL:等待安装
  • INSTALLING: 安装中
  • INSTALLED:安装完毕,此时应用可打开

onStatusChanged(callback)

监听下载状态变化。

callback:下载状态变化回调函数,callback的参数为packageName和status。

-

offStatusChanged()

取消监听下载状态变化。

-

-

onDownloadProgress(callback)

监听下载进度变化。

callback:下载进度变化回调函数,callback的参数为packageName和progress。

-

offDownloadProgress()

取消监听下载进度变化。

-

-

destroy()

销毁广告对象。

-

-

showPrivacyPolicy(object: Object)

拉起浏览器展示隐私页面。

adId:广告素材标识ID。

  

showAppDetailPage(object: Object)

展示应用详情页面。

adId:广告素材标识ID。

  

showPermissionPage(object: Object)

拉起浏览器展示应用权限页面。

adId:广告素材标识ID。

  

onUserCancel(callback: (ret: Object)

监听取消下载状态变化。

callback: 取消下载状态变化回调函数。callback的参数为packageName和uniqueId。

  

offUserCancel()

取消监听取消下载状态变化。

     

showPrivacyPolicyInWeb(object: Object)

webview展示隐私页面。

adId:广告素材标识ID。

  

showPermissionPageInWeb(object: Object)

webview展示应用权限页面。

adId:广告素材标识ID。

  

onAppOpen(callback: (ret: Object)

监听APP打开。

callback: 下载状态变化回调函数。

callback的参数为packageName、status和uniqueId。

  

offAppOpen()

取消监听APP打开。

     

showTransparencyDialog(object: Object,rect: DOMRect, theme: number)

展示广告透明性弹框。

1.adId:广告素材标识ID。

2.rect:点击坐标。

属性值:

  • bottom: number
  • height: number
  • left: number
  • right: number
  • top: number
  • width: number
  • x: number
  • y: number
  • 3.theme:主题
  • 0:浅色模式(默认)
  • 1:深色模式
  

dismissTransparencyDialog()

销毁广告透明性弹框。

     

AdData

展开

属性

类型

描述

adId

String

广告素材标识ID。

adType

number

广告类型。

app

AppInfo

推广应用。

clickBtnTxt

String

广告行为按钮的显示文字(例如“查看详情”或“安装”)。

creativeType

number

广告创意类型,详细参见CreativeType和DetailedCreativeType与CreativeType对应关系。

desc

String

广告描述。

imgList

Array<ImageInfo>

广告图片。

interactionType

number

广告的推广目的。

  • 0:纯展示
  • 1:网页推广
  • 2:应用下载
  • 3:应用促活或快应用
  • 4:快应用推广(鲸鸿动能JavaScript API暂不支持)
  • 5:应用推广

keywords

Array<string>

不感兴趣的理由。

source

String

广告来源。

title

String

广告标题。

video

VideoInfo

广告视频。

slotId

String

广告位ID。

dspName

String

广告dsp名称。

dspLogo

String

广告dspLogo的url。

showAppElement

number

服务端下发是否展示六要素。

transparencyOpen

string

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

promoteInfo

PromoteInfo

被推广的实体信息。

abilityInfo

string

鸿蒙FA。

AppInfo

展开

属性

类型

描述

appName

String

应用名称。

appDesc

String

应用描述。

iconUrl

String

应用图标地址。

packageName

String

应用包名。

privacyLink

String

返回隐私链接。

permissionUrl

String

返回应用的权限声明页面对应的H5地址。

appDetailUrl

String

返回应用的应用详情介绍页面对应的H5地址。

versionName

String

获取应用的版本号(类似4.52.0形式)。

developerName

String

获取应用开发者信息。

ImageInfo

展开

属性

类型

描述

width

number

图片宽度,单位:px。

height

number

图片高度,单位:px。

imageType

string

图片类型,取值类型:

  • img
  • gif

url

String

图片地址。

VideoInfo

展开

属性

类型

描述

duration

Integer

视频文件的播放时长,单位:毫秒。

ratio

Float

视频比例。

fileSize

Integer

视频文件的大小,单位:字节。

url

String

视频地址。

PromoteInfo

展开

属性

类型

描述

type

number

推广子类型:

  1. 快应用。
  2. 微信小程序。

name

string

被推广的实体名称。是URL编码过的,客户端在使用前要进行URL解码。

在 API参考 中进行搜索
请输入您想要搜索的关键词