广告-华为服务-API-快应用

接口声明

在manifest.json文件的 features属性中增加如下配置。

收起
自动换行
深色代码主题
复制
{"name": "service.ad"}

导入模块

在调用接口页面的<script>部分增加如下配置。

收起
自动换行
深色代码主题
复制
import ad from '@service.ad'

或

收起
自动换行
深色代码主题
复制
var ad = require("@service.ad")

使用限制

展开

限制条件	说明
适用终端	手机、平板
适用区域	全球

接口定义

展开

接口	描述
ad.getProvider()	获取服务提供商，如厂商的英文品牌名称。
consent接口
ad.requestConsentUpdate(object)	请求用户意见更新状态。
ad.setUnderAgeOfPromise(boolean underAgeOfPromise)	设置未达到法定承诺年龄用户的标记。
ad.setConsentStatus(number consentStatus)	设置用户意见。
ad.setTagForChildProtection(number childProtection)	设置儿童保护标签。
ad.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置面向未达到法定承诺年龄用户。
ad.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
ad.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
原生广告接口
ad.createNativeAd(object)	创建 native 广告，如果已经创建过 native 广告，则返回已创建的广告。
nativeAd.load()	拉取广告数据。
nativeAd.reportAdShow()	上报广告曝光，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
nativeAd.reportAdClick()	上报广告点击，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。
nativeAd.showAppDetailPage()	跳转应用详情页，adId 为 load 方法获取的广告数据的 adId 字段。
nativeAd.onRewardActive(function callback)	监听原生广告激励产生事件，仅AGD类广告返回。
nativeAd.offRewardActive()	移除原生广告激励产生监听。
nativeAd.onLoad(function callback)	设置广告加载成功回调。
nativeAd.offLoad(function callback)	移除原生广告加载成功监听。
nativeAd.onError(function callback)	监听原生广告错误事件。
nativeAd.offError(function callback)	移除原生广告加载错误监听。
nativeAd.setTagForChildProtection(number childProtection)	设置儿童保护标签。
nativeAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置面向未达到法定承诺年龄用户标签。
nativeAd.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
nativeAd.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
nativeAd.getDownloadProgress(OBJECT)	获取下载进度。
nativeAd.getAppStatus(OBJECT)	获取下载状态。
nativeAd.onStatusChanged(function)	监听下载状态变化。
nativeAd.offStatusChanged()	取消监听下载状态变化。
nativeAd.onDownloadProgress(function)	监听下载进度变化。
nativeAd.offDownloadProgress()	取消监听下载进度变化。
nativeAd.destroy()	销毁原生广告。
激励视频广告接口
ad.createRewardedVideoAd(object)	创建激励视频广告。
rewardedVideoAd.load()	手动拉取广告，用于刷新广告。
rewardedVideoAd.show()	激励视频广告默认是隐藏的，调用 show 方法展示广告。
rewardedVideoAd.onLoad(function callback)	设置广告加载成功回调。
rewardedVideoAd.offLoad(function callback)	移除激励视频广告加载成功监听。
rewardedVideoAd.onClose(function callback)	监听激励视频广告关闭事件。只有在用户主动关闭激励视频广告时，广告才会关闭。
rewardedVideoAd.offClose(function callback)	移除激励视频广告关闭监听。
rewardedVideoAd.onError(function callback)	监听激励视频广告加载错误事件。
rewardedVideoAd.offError(function callback)	移除激励视频广告加载错误监听。
rewardedVideoAd.setTagForChildProtection(number childProtection)	设置儿童保护标签。
rewardedVideoAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)	设置面向未达到法定承诺年龄用户标签。
rewardedVideoAd.setAdContentClassification(string adContentClassification)	设置广告内容分级上限。
rewardedVideoAd.setNonPersonalizedAd(number personalizedAd)	设置是否请求非个性化广告。
rewardedVideoAd.destroy()	销毁激励视频广告。
Banner广告接口
ad.createBannerAd(OBJECT)	创建 Banner 广告，如果已经创建过 Banner 广告，则返回已创建的广告。
bannerAd.show()	加载展示banner广告。
bannerAd.hide()	隐藏 banner 广告。
bannerAd.onError(function callback)	监听 banner 广告错误事件。
bannerAd.offError()	移除 banner 广告错误监听。
bannerAd.onLoad()	监听 banner 广告加载事件。
bannerAd.offLoad()	移除 banner 广告加载事件。
bannerAd.onClose()	监听 banner 广告关闭事件。
bannerAd.offClose()	移除 banner 广告关闭事件
bannerAd.destroy()	销毁 banner 广告。
插屏广告接口
ad.createInterstitialAd(OBJECT)	创建 Interstitial 广告。
interstitialAd.load()	加载插屏视频广告。
interstitialAd.show()	显示插屏视频广告。
interstitialAd.onLoad(function callback)	监听插屏广告加载事件。
interstitialAd.offLoad()	移除插屏广告加载事件。
interstitialAd.onError(function callback)	监听插屏广告错误事件。
interstitialAd.offError()	移除插屏广告错误监听。
interstitialAd.onClose(function callback)	监听插屏广告关闭事件。
interstitialAd.offClose()	移除插屏广告关闭事件。
interstitialAd.onClick(function callback)	监听插屏广告点击事件。
interstitialAd.offClick()	移除插屏广告点击监听。
interstitialAd.destroy()	销毁插屏广告。
模板广告接口
ad.createTemplateAd(OBJECT)	创建 Template 广告，如果已经创建过 Template 广告，则返回已创建的广告。
templateAd.load(OBJECT)	加载模板广告。
templateAd.destroy()	销毁模板广告。
互推盒子广告接口
ad.createAppBoxAd (OBJECT)	创建互推盒子广告，如果已经创建过互推盒子广告，则返回已创建的广告。
appBoxAd.load()	加载互推盒子广告。
appBoxAd.show()	显示互推盒子广告。
appBoxAd.onLoad(function callback)	监听互推盒子广告加载事件。
appBoxAd.offLoad()	移除互推盒子广告加载事件。
appBoxAd.onError(function callback)	监听互推盒子广告错误事件。
appBoxAd.offError()	移除互推盒子广告错误监听。
appBoxAd.onClose(function callback)	监听互推盒子广告关闭事件。
appBoxAd.offClose()	移除互推盒子广告关闭事件。
appBoxAd.onClick(function callback)	监听互推盒子广告点击事件。
appBoxAd.offClick()	移除互推盒子广告点击监听。
appBoxAd.destroy()	销毁互推盒子广告。
互推盒子横划榜单广告接口
ad.createAppBoxBannerAd (OBJECT)	创建互推盒子横划榜单广告，如果已经创建过互推盒子横划榜单广告，则返回已创建的广告。
bannerBoxAd.show()	加载并显示互推盒子横划榜单广告。
bannerBoxAd.hide()	隐藏互推盒子横划榜单广告。
bannerBoxAd.onLoad(function callback)	监听互推盒子横划榜单广告加载事件。
bannerBoxAd.offLoad()	移除互推盒子横划榜单广告加载事件。
bannerBoxAd.onError(function callback)	监听互推盒子横划榜单广告错误事件。
bannerBoxAd.offError()	移除互推盒子横划榜单广告错误监听。
bannerBoxAd.onClose(function callback)	监听互推盒子横划榜单广告关闭事件。
appBoxAd.offClose()	移除互推盒子横划榜单广告关闭事件。
bannerBoxAd.onClick(function callback)	监听互推盒子横划榜单广告点击事件。
bannerBoxAd.offClick()	移除互推盒子横划榜单广告点击监听。
bannerBoxAd.destroy()	销毁互推盒子横划榜单广告。

ad.getProvider()（1075+）

描述

获取服务提供商，如厂商的英文品牌名称。

返回值

字符串，服务提供商的代号，如厂商的英文品牌名称，如果无此服务则返回空字符串。返回空字符串时，请勿调用该服务其他接口，否则将抛出异常。

示例代码

收起
自动换行
深色代码主题
复制
ad.getProvider();

ad.requestConsentUpdate(object)（1077+）

描述

请求用户意见更新状态。

参数

展开

参数	类型	是否必填	说明
success	function	否	请求用户意见更新状态成功。
fail	function	否	请求用户意见更新状态失败。
complete	function	否	执行结束后的回调。

success回调参数

展开

参数	类型	说明
consentStatus	number	用户意见状态。 0：用户已同意接收个性化广告与非个性化广告。 1：用户已同意仅接收非个性化广告。 2：用户既未同意接收也未拒绝接收个性化广告或非个性化广告。
isNeedConsent	boolean	是否需要用户确认意见。取值为false，表明可以向鲸鸿动能SDK请求个性化广告。取值为true，表明用户在欧洲经济区内或其他敏感地区，需进一步确认用户意见。
AdProviderList	array	广告技术提供商信息列表。AdProvider对象结构详细请参见“AdProvider说明”。

参数

类型

说明

consentStatus

number

用户意见状态。

0：用户已同意接收个性化广告与非个性化广告。
1：用户已同意仅接收非个性化广告。
2：用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

isNeedConsent

boolean

是否需要用户确认意见。

取值为false，表明可以向鲸鸿动能SDK请求个性化广告。
取值为true，表明用户在欧洲经济区内或其他敏感地区，需进一步确认用户意见。

AdProviderList

array

广告技术提供商信息列表。AdProvider对象结构详细请参见“AdProvider说明”。

AdProvider说明

展开

字段	定义
id	广告技术提供商的ID。
name	广告技术提供商的名称。
serviceArea	广告技术提供商的服务地。
privacyPolicyUrl	广告技术提供商的隐私政策链接URL。

示例代码

收起
自动换行
深色代码主题
复制
ad.requestConsentUpdate({
  success: function(data) {
    console.log('requestConsentUpdate success data ' + JSON.stringify(data))
  },
  fail: function(data) {
    console.log('requestConsentUpdate fail data ' + JSON.stringify(data))
  },
  complete: function() {},
})

ad.setUnderAgeOfPromise(boolean underAgeOfPromise)（1077+）

描述

设置未达到法定承诺年龄用户的标记。

参数

展开

参数	类型	是否必填	说明
underAgeOfPromise	boolean	是	true：按适合未达到法定承诺年龄的用户的方式来处理广告请求。 false：不按适合未达到法定承诺年龄的用户的方式来处理广告请求。

示例代码

收起
自动换行
深色代码主题
复制
ad.setUnderAgeOfPromise(true)

ad.setConsentStatus(number consentStatus)（1077+）

描述

设置用户意见。

参数

展开

参数	类型	是否必填	说明
consentStatus	number	是	用户意见。 0：PERSONALIZED 用户已同意接收个性化广告与非个性化广告。 1：NON_PERSONALIZED 用户已同意仅接收非个性化广告。 2：UNKNOWN 用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

参数

类型

是否必填

说明

consentStatus

number

是

用户意见。

0：PERSONALIZED 用户已同意接收个性化广告与非个性化广告。
1：NON_PERSONALIZED 用户已同意仅接收非个性化广告。
2：UNKNOWN 用户既未同意接收也未拒绝接收个性化广告或非个性化广告。

示例代码

收起
自动换行
深色代码主题
复制
ad.setConsentStatus(1)

ad.setTagForChildProtection(number childProtection) (1078+)

描述

设置儿童保护标签。

参数

展开

参数	类型	是否必填	说明
childProtection	number	是	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

是否必填

说明

childProtection

number

是

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码

收起
自动换行
深色代码主题
复制
ad.setTagForChildProtection(1)

ad.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) (1078+)

描述

设置面向未达到法定承诺年龄用户。

参数

展开

参数	类型	是否必填	说明
underAgeOfPromiseStr	number	是	未达到法定承诺年龄用户的设置。 -1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。 0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。 1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

参数

类型

是否必填

说明

underAgeOfPromiseStr

number

是

未达到法定承诺年龄用户的设置。

-1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。
0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。
1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

示例代码

收起
自动换行
深色代码主题
复制
ad.setTagForUnderAgeOfPromise(1)

ad.setAdContentClassification(string adContentClassification) (1078+)

描述

设置广告内容分级上限。

参数

展开

参数	类型	是否必填	说明
adContentClassification	string	是	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

是否必填

说明

adContentClassification

string

是

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码

收起
自动换行
深色代码主题
复制
ad.setAdContentClassification('W')

ad.setNonPersonalizedAd(number personalizedAd) (1078+)

描述

设置是否请求非个性化广告。

参数

展开

参数	类型	是否必填	说明
personalizedAd	number	是	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

参数

类型

是否必填

说明

personalizedAd

number

是

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。

示例代码

收起
自动换行
深色代码主题
复制
ad.setNonPersonalizedAd(1)

ad.createNativeAd(object)（1075+）

描述

创建 native 广告，如果已经创建过 native 广告，则返回已创建的广告。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	原生广告位标识。
channel(1104+)	string	否	AGD Pro启动渠道来源，由数字和字母组成的字符串，长度不超过64。说明 ads的启动渠道来源，请通过nativeAd.load()的extra传递

返回值

原生广告。

示例代码

收起
自动换行
深色代码主题
复制
let nativeAd = ad.createNativeAd({ 
   adUnitId: 'xxx',
   channel:'xxx'
})

nativeAd.load()（1075+）

描述

拉取广告数据，成功回调 onLoad，失败回调 onError。

说明

华为目前每次调用返回一条广告数据。

参数

说明

为保证版本兼容，请判断当前引擎版本号，低于1111版本时请使用不带参数方法请求。

展开

参数	类型	是否必填	说明
extra（1111+）	object	否	扩展参数。说明可通过 key-value传入ads的的启动渠道来源，其中key为customerChannel，value为0-100的数字
supportTemplate（1113+）	boolean	否	是否支持鲸鸿动能模板广告，请求模板广告必须设置：true。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.load({
  supportTemplate:true,
  extra:{
    // adUnitId
    "testy63txaom86":
    {
      "key1":"value1",
      "key2":"value2",
      "customerChannel":24
    }
  }
})

nativeAd.reportAdShow()（1075+）

描述

上报广告曝光，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。

参数

展开

参数	类型	是否必填	说明
adId	string	是	广告信息标识，由onload回调返回。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.reportAdShow({
    adId: "xxx"
})

nativeAd.reportAdClick()（1075+）

描述

上报广告点击，一个广告只有一次上报有效，adId 为 load 方法获取的广告数据的 adId 字段。

参数

展开

参数	类型	是否必填	说明
adId	string	是	广告信息标识，由onload回调返回。
clickInfo(1105+)	object	否	广告点击信息，详细内容参见“clickInfo说明”。

clickInfo说明

展开

参数	类型	是否必填	说明
clickX	number	否	点击按下位置相对于广告位的横坐标，单位为px。
clickY	number	否	点击按下位置相对于广告位的纵坐标，单位为px。
upX(1106+)	number	否	点击抬起位置相对于广告位的横坐标，单位为px。
upY(1106+)	number	否	点击抬起位置相对于广告位的纵坐标，单位为px。
density(1106+)	float	否	设备密度。
sld(1106+)	int	否	广告触发类型。取值范围如下： 0：常规触屏点击 1：滑动点击，广告上引导用户进行滑动以触发点击 2：摇一摇，由重力加速变化触发点击 5：扭一扭，由屏幕角度变化触发点击 6：擦除触发点击
creativeSize	object	否	广告区域的尺寸，即完整广告容器大小，详细内容参见“creativeSize说明”。

creativeSize说明（1106+）

展开

参数	类型	是否必填	说明
width	number	否	广告区域的宽度，单位为px。
height	number	否	广告区域的高度，单位为px。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.reportAdClick({ adId: "xxx",
      clickInfo: {
          clickX:750,
          clickY:200,
          upX:740,
          upY:202,
          sld:0,
          density:3.0,
          creativeSize:{
            width:1500,
            height:750
          }
      }
})

nativeAd.showAppDetailPage()（1106+）

描述

跳转应用详情页，adId 为 load 方法获取的广告数据的 adId 字段。

参数

展开

参数	类型	是否必填	说明
adId	string	是	广告信息标识，由onload回调返回。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.showAppDetailPage({ adId: "xxx" })

nativeAd.onRewardActive(function callback)（1106+）

描述

监听原生广告激励产生事件，仅AGD类广告返回。

参数

展开

参数	类型	说明
uniqueId	string	广告唯一标识。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onRewardActive((data) => {
    console.log('onRewardActive data = ', data)
})

nativeAd.offRewardActive()（1106+）

描述

移除原生广告激励产生监听。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.offRewardActive()

nativeAd.onLoad(function callback)（1075+）

描述

设置广告加载成功回调。

参数

展开

参数	类型	是否必填	说明
callback	function	是	广告加载完成触发执行的函数，回调数据为包含广告列表的对象{adList: xxx}。

展开

参数	类型	说明
adList	array	广告详细信息，详细内容参见“广告item说明”。

广告item说明

展开

参数	类型	说明
adId	string	广告标识，用于上报曝光与点击。
title	string	广告标题。
appName(1106+)	string	应用名称。
appVersion(1106+)	string	应用版本号。
appPermissionUrl(1106+)	string	应用权限链接。
appPrivacyUrl(1106+)	string	应用隐私政策链接。
appCompany(1106+)	string	应用开发者名称。
desc	string	广告描述。
source(1077+)	string	广告来源。
ext(1112+)	object	拓展字段。说明鲸鸿动能广告返回的ext信息对象。当前支持获取价格标签ext.hwPriceTag。
icon	string	推广应用的Icon图标。
imgUrlList	array	广告图片。
videoUrlList	array	广告视频。
videoRatio(1078+)	array	广告视频宽高比。
logoUrl	string	广告标签图片。说明华为目前仅返回空字符串""。
clickBtnTxt	string	点击按钮文本描述。
creativeType	number	获取广告类型，取值说明如下： 1：文字 2：大图片 3：大图文 4：GIF 6：视频文 7：小图文 8：三小图文 9：视频 10：图标（文） 99：原生模板广告（1113+） 101：文字带下载按钮 102：大图片带下载按钮 103：大图文带下载按钮 104：GIF带下载按钮 106：视频文带下载按钮 107：小图文带下载按钮 108：三小图文带下载按钮 0或110：图标（文）带下载按钮说明华为类型取值和联盟有所不同。返回值为99时，该广告对象只能用于绑定模板广告，请勿调用nativeAd.reportAdShow()、nativeAd.reportAdClick()、nativeAd.showAppDetailPage()和nativeAd.destroy()接口或绑定ad-button和ad-native-view组件，以免影响您的计费。
interactionType	number	获取广告点击之后的交互类型，取值说明如下： 0：无 1：浏览类 2：下载类 3：浏览器（下载中间页广告） 4：打开应用首页 5：打开应用详情页说明华为当前始终返回为0。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onLoad((data) => {
 console.info('ad data loaded: ' + JSON.stringify(data))
 this.adItemData = data.adList[0]
})

nativeAd.offLoad(function callback)（1075+）

描述

移除原生广告加载成功监听。

参数

展开

参数	类型	是否必填	说明
callback	function	否	移除的回调函数对象。说明华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

nativeAd.onError(function callback)（1075+）

描述

监听原生广告错误事件。

参数

展开

参数	类型	是否必填	说明
callback	function	是	广告加载出错时触发执行的函数，回调数据为包含错误码和错误描述的对象。

callback回调对象

展开

参数	类型	说明
errCode	number	错误码，详细内容参见错误码说明。
errMsg	string	错误信息。

错误码说明：

展开

错误码	说明
1001	参数错误。
1002	广告单元无效。
1003	内部错误。
1004	无合适的广告。
1100	过于频繁调用相关API。
1102	调用了不支持的方法。
1104	网络错误。
2000	未知错误。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onError((e) => {
  console.error('load ad error:' + JSON.stringify(e));
  const errCode = e.errCode
  const errMsg = e.errMsg
})

nativeAd.offError(function callback)（1075+）

描述

移除原生广告加载错误监听。

参数

展开

参数	类型	是否必填	说明
callback	function	否	移除的回调函数对象。说明华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

nativeAd.setTagForChildProtection(number childProtection)（1077+）

描述

设置儿童保护标签。建议使用 ad.setTagForChildProtection(number childProtection) 代替此接口。

参数

展开

参数	类型	是否必填	说明
childProtection	number	是	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

是否必填

说明

childProtection

number

是

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.setTagForChildProtection(1)

nativeAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)（1077+）

描述

设置面向未达到法定承诺年龄用户。建议使用 ad.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) 代替此接口。

参数

展开

参数	类型	是否必填	说明
underAgeOfPromiseStr	number	是	未达到法定承诺年龄用户的设置。 -1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。 0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。 1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准

参数

类型

是否必填

说明

underAgeOfPromiseStr

number

是

未达到法定承诺年龄用户的设置。

-1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。
0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。
1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.setTagForUnderAgeOfPromise(1)

nativeAd.setAdContentClassification(string adContentClassification)（1077+）

描述

设置广告内容分级上限。建议使用 ad.setAdContentClassification(string adContentClassification) 代替此接口。

参数

展开

参数	类型	是否必填	说明
adContentClassification	string	是	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

是否必填

说明

adContentClassification

string

是

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.setAdContentClassification('W')

nativeAd.setNonPersonalizedAd(number personalizedAd)（1077+）

描述

设置是否请求非个性化广告。建议使用 ad.setNonPersonalizedAd(number personalizedAd) 代替此接口。

参数

展开

参数	类型	是否必填	说明
personalizedAd	number	是	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

参数

类型

是否必填

说明

personalizedAd

number

是

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.setNonPersonalizedAd(1)

nativeAd.getDownloadProgress(OBJECT) (1078+)

描述

获取下载进度。

参数

展开

参数	类型	是否必填	说明
adId	string	是	广告信息标识，由onload回调返回。

返回值

应用下载进度，Number类型，取值范围：0 ~ 100。

示例代码

收起
自动换行
深色代码主题
复制
const progress = nativeAd.getDownloadProgress({
    adId: "xxx"
})
console.log('getDownloadProgress progress = ' + progress);

nativeAd.getAppStatus(OBJECT) (1078+)

描述

获取下载状态。

参数

展开

参数	类型	是否必填	说明
adId	string	是	广告信息标识，由onload回调返回。

返回值

应用下载状态，string类型，数值含义如下。

展开

状态	类型	说明
DOWNLOAD	string	下载未开始，应用初始状态。
DOWNLOADING	string	应用下载中。
DOWNLOADFAILED	string	下载失败。
WAITING	string	下载等待中。
PAUSE	string	应用下载暂停中。
INSTALL	string	等待安装。
INSTALLING	string	安装中。
INSTALLED	string	安装完毕，此时应用可打开。

示例代码

收起
自动换行
深色代码主题
复制
const status = nativeAd.getAppStatus({
    adId: "xxx"
})
console.log('getAppStatus status = ' + status );

nativeAd.onStatusChanged(function) (1078+)

描述

监听下载状态变化。

说明

请在广告加载接口nativeAd.onLoad中调用，否则无法监听到下载状态。

参数

展开

参数	类型	说明
status	string	当前广告应用的下载状态。
uniqueId	string	应用唯一标识。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onStatusChanged((data) => {
    console.log('onStatusChanged data = ', data)
})

nativeAd.offStatusChanged() (1078+)

描述

取消监听下载状态变化。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.offStatusChanged()

nativeAd.onDownloadProgress(function) (1078+)

描述

监听下载进度变化。

说明

请在广告加载接口nativeAd.onLoad中调用，否则无法监听到下载进度。

参数

展开

参数	类型	说明
progress	number	下载进度，取值范围0 ~ 100。
uniqueId	string	应用唯一标识。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.onDownloadProgress((data) => {
    console.log('onDownloadProgress data = ', data)
})

nativeAd.offDownloadProgress() (1078+)

描述

取消监听下载进度变化。

示例代码

收起
自动换行
深色代码主题
复制
nativeAd.offDownloadProgress()

nativeAd.destroy()（1075+）

描述

销毁原生广告。

ad.createRewardedVideoAd(object)（1075+）

描述

创建激励视频广告，同一个 adUnitId，如果已经创建，会复用之前的对象，创建后会加载广告素材，该方法返回的是一个单例，该实例仅对当前页面有效，不允许跨页面使用。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	激励视频广告位标识。

返回值

激励视频广告。

示例代码

收起
自动换行
深色代码主题
复制
let rewardedVideoAd = ad.createRewardedVideoAd({
    adUnitId: 'xxx'
})

rewardedVideoAd.load()（1075+）

描述

手动拉取广告，用于刷新广告，成功回调 resolved Promise，失败回调 onError。

说明

请求广告频率太高可能回调onError。

参数

展开

参数	类型	是否必填	说明
extra（1111+）	object	否	扩展参数。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.load({
  extra:{
    // adUnitId
    "testx9dtjwj8hp":
    {
      "key1":"value1",
      "key2":"value2"
    }
  }
})

rewardedVideoAd.show()（1075+）

描述

激励视频广告默认是隐藏的，调用 show 方法展示广告，失败回调 onError。

rewardedVideoAd.onLoad(function callback)（1075+）

描述

设置广告加载成功回调。

参数

展开

参数	类型	是否必填	说明
callback	function	是	广告加载完成触发执行的函数。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onLoad(() => {
  console.log('ad loaded.')
})

rewardedVideoAd.offLoad(function callback)（1075+）

描述

移除激励视频广告加载成功监听。

参数

展开

参数	类型	是否必填	说明
callback	function	否	移除的回调函数对象。说明：华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

参数

类型

是否必填

说明

callback

function

否

移除的回调函数对象。

说明：华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.offLoad(() => {
  console.log('ad off loaded.')
})

rewardedVideoAd.onClose(function callback)（1075+）

描述

监听激励视频广告关闭事件。只有在用户主动关闭激励视频广告时，广告才会关闭。

参数

展开

参数	类型	说明
callback	function	广告关闭时触发执行的函数，回调参数为{isEnded: xxx}。

展开

参数	类型	说明
isEnded	boolean	视频是否是在用户完整观看的情况下被关闭的。 true 表示用户是在视频播放完以后关闭的 false 表示用户在视频播放过程中关闭的

参数

类型

说明

isEnded

boolean

视频是否是在用户完整观看的情况下被关闭的。

true 表示用户是在视频播放完以后关闭的
false 表示用户在视频播放过程中关闭的

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onClose((res) => {
  console.log('ad onClose: ' + res.isEnded)
})

rewardedVideoAd.offClose(function callback)（1075+）

描述

移除激励视频广告关闭监听。

参数

展开

参数	类型	是否必填	说明
callback	function	否	移除的回调函数对象。说明华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

rewardedVideoAd.onError(function callback)（1075+）

描述

监听激励视频广告错误事件。

参数

展开

参数	类型	是否必填	说明
callback	function	是	广告加载出错时触发执行的函数，回调数据为包含错误码和错误描述的对象。

callback回调对象

展开

参数	类型	说明
errCode	number	错误码。
errMsg	string	错误信息。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.onError((e) => {
  console.error('load ad error:' + JSON.stringify(e));
  const errCode = e.errCode
  const errMsg = e.errMsg
})

rewardedVideoAd.offError(function callback)（1075+）

描述

移除激励视频广告加载错误监听。

参数

展开

参数	类型	是否必填	说明
callback	function	否	移除的回调函数对象。说明：华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

参数

类型

是否必填

说明

callback

function

否

移除的回调函数对象。

说明：华为暂不支持移除某个回调对象；支持传空，移除所有回调对象。

rewardedVideoAd.setTagForChildProtection(number childProtection)（1077+）

描述

设置儿童保护标签。

参数

展开

参数	类型	是否必填	说明
childProtection	number	是	儿童保护标签。 -1：您不希望表明您的广告内容是否需要符合COPPA的规定。 0：表明您的广告内容不需要符合COPPA的规定。 1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

参数

类型

是否必填

说明

childProtection

number

是

儿童保护标签。

-1：您不希望表明您的广告内容是否需要符合COPPA的规定。
0：表明您的广告内容不需要符合COPPA的规定。
1：表明您的广告内容需要符合COPPA的规定（该广告请求无法获取到任何广告）。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.setTagForChildProtection(1)

rewardedVideoAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr)（1077+）

描述

设置面向未达到法定承诺年龄用户。

参数

展开

参数	类型	是否必填	说明
underAgeOfPromiseStr	number	是	未达到法定承诺年龄用户的设置。 -1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。 0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。 1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

参数

类型

是否必填

说明

underAgeOfPromiseStr

number

是

未达到法定承诺年龄用户的设置。

-1: 表明您尚未指定广告请求是否要符合未达到法定承诺年龄用户的广告标准。
0: 表明您不希望广告请求符合未达到法定承诺年龄用户的广告标准。
1: 表明您希望广告请求符合未达到法定承诺年龄用户的广告标准。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.setTagForUnderAgeOfPromise(1)

rewardedVideoAd.setAdContentClassification(string adContentClassification)（1077+）

描述

设置广告内容分级上限。

参数

展开

参数	类型	是否必填	说明
adContentClassification	string	是	广告内容类型。 W：适合幼儿及以上年龄段观众的内容。 PI：适合少儿及以上年龄段观众的内容。 J：适合青少年及以上年龄段观众的内容。 A：仅适合成人观众的内容。

参数

类型

是否必填

说明

adContentClassification

string

是

广告内容类型。

W：适合幼儿及以上年龄段观众的内容。
PI：适合少儿及以上年龄段观众的内容。
J：适合青少年及以上年龄段观众的内容。
A：仅适合成人观众的内容。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.setAdContentClassification('W')

rewardedVideoAd.setNonPersonalizedAd(number personalizedAd)（1077+）

描述

设置是否请求非个性化广告。

参数

展开

参数	类型	是否必填	说明
personalizedAd	number	是	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

参数

类型

是否必填

说明

personalizedAd

number

是

非个性化广告标记。

0：请求个性化广告与非个性化广告。
1：请求非个性化广告。

示例代码

收起
自动换行
深色代码主题
复制
rewardedVideoAd.setNonPersonalizedAd(1)

rewardedVideoAd.destroy()（1075+）

描述

销毁激励视频广告。

ad.createBannerAd(OBJECT)（1078+）

描述

创建 Banner 广告，如果已经创建过 Banner 广告，则返回已创建的广告。

参数

展开

参数

类型

是否必填

说明

adUnitId

string

是

Banner 广告位标识。

style

object

是

Banner 广告的样式，详细内容参见“style说明”。

adIntervals

number

否

广告自动刷新的间隔时间，单位为秒，参数值30 ~ 120之间（如果不传入此参数 Banner 广告不会自动刷新），建议设置为60。

该参数只有首次调用该接口传入有效，如果首次未设置，后续再调用接口设置无效，除非调用bannerAd.destroy()销毁广告后，重新创建新的广告。

style说明

展开

参数	类型	必填	说明
top	number	是	banner 广告的左上角纵坐标。
left	number	是	banner 广告的左上角横坐标。
width	number	是	banner 广告的宽度，单位：dp。
height	number	是	banner 广告的高度，单位：dp。

广告宽高设置值限制如下表所示。

展开

宽	高	说明
360	57	普通Banner广告，适用于1080*170px的广告素材。
360	144	大型Banner广告，适用于1080*432px的广告素材。
160	600	中国大陆地区不支持。
300	250	中国大陆地区不支持。
320	100	中国大陆地区不支持。
320	50	中国大陆地区不支持。
468	60	中国大陆地区不支持。
728	90	中国大陆地区不支持。
-1	-2	根据屏幕宽高度自动匹配。

返回值

Banner广告 bannerAd。通过bannerAd.style可以获取广告的真实宽高，其返回值如下表所示。

展开

参数名	类型	说明
top	number	banner 广告的左上角纵坐标。
left	number	banner 广告的左上角横坐标。
width	number	banner 广告的宽度，单位dp。
height	number	banner 广告的高度，单位dp。
realWidth	number	banner 广告的真实宽度，单位px。
realHeight	number	banner 广告的真实高度，单位px。

示例代码

收起
自动换行
深色代码主题
复制
let bannerAd = ad.createBannerAd({
    adUnitId: 'testw6vs28auh3',
    style:{
        top:20,
        left:20,
        height:57,
        width:360
    }
})

bannerAd.show() （1078+）

描述

加载展示banner广告，出错的时候回调 onError，分为加载和展示两个阶段，加载成功回调onLoad。

参数

展开

参数	类型	是否必填	说明
extra（1111+）	object	否	扩展参数。

示例代码

收起
自动换行
深色代码主题
复制
bannerAd.show({
  extra:{
    // adUnitId
    "testw6vs28auh3":
    {
      "key1":"value1",
      "key2":"value2"
    }
  }
})

bannerAd.hide() （1078+）

描述

隐藏 banner 广告。

bannerAd.onError(function callback)（1078+）

描述

监听 banner 广告错误事件。

返回值

Object类型。

展开

参数	类型	是否必填	说明
errMsg	string	是	错误信息。
errCode	number	是	错误码。

示例代码

收起
自动换行
深色代码主题
复制
bannerAd.onError((err)=>{
    console.log(err)
})

bannerAd.offError() （1078+）

描述

移除 banner 广告错误监听。

bannerAd.onLoad() （1078+）

描述

监听 banner 广告加载事件。

bannerAd.offLoad() （1078+）

描述

移除 banner 广告加载事件。

bannerAd.onClose() （1078+）

描述

监听 banner 广告关闭事件。

bannerAd.offClose() （1078+）

描述

移除 banner 广告关闭事件。

bannerAd.onResize() （1078+）

描述

监听 banner 广告尺寸变化事件（华为暂未实现功能）。

bannerAd.offResize() （1078+）

描述

移除 banner 广告尺寸变化事件（华为暂未实现功能）。

bannerAd.destroy() （1078+）

描述

销毁 banner 广告。

ad.createInterstitialAd(OBJECT)（1078+）

描述

创建 Interstitial 广告，如果已经创建过 Interstitial 广告，则返回已创建的广告。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	Interstitial 广告位标识。

示例代码

收起
自动换行
深色代码主题
复制
let interstitialAd = ad.createInterstitialAd({
    adUnitId: 'xxxx'
})

interstitialAd.load()（1078+）

描述

拉起插屏广告数据，成功回调 onLoad，失败回调 onError。

参数

展开

参数	类型	是否必填	说明
extra（1111+）	object	否	扩展参数

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.load({
  extra:{
    // adUnitId
    "testb4znbuh3n2":
    {
      "key1":"value1",
      "key2":"value2"
    }
  }
})

interstitialAd.show()（1078+）

描述

显示插屏视频广告。

返回值

Promise，插屏广告显示操作的结果。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.show().then(
    () => { console.log('插屏广告show成功') },
    () => { console.log('插屏广告show失败') }
)

interstitialAd.onLoad(function callback)（1078+）

描述

设置插屏广告加载成功回调。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onLoad(function (data) {
    console.log('onLoad data ' + JSON.stringify(data));
});

interstitialAd.offLoad()（1078+）

描述

移除插屏广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.offLoad();

interstitialAd.onError(function callback)（1078+）

描述

监听插屏广告错误事件。

返回值

object类型。

展开

参数	类型	说明
errMsg	string	错误信息。
errCode	number	错误码。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onError((err)=>{
    console.log(err)
})

interstitialAd.offError()（1078+）

描述

移除插屏广告错误监听。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.offError();

interstitialAd.onClose(function callback)（1078+）

描述

监听插屏广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onClose(()=>{
    console.log('interstitialAd closed');
})

interstitialAd.offClose()（1078+）

描述

移除插屏广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.offClose();

interstitialAd.onClick(function callback)（1078+）

描述

监听插屏广告点击事件。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.onClick(()=>{
    console.log('interstitialAd clicked');
})

interstitialAd.offClick()（1078+）

描述

移除插屏广告点击监听。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.offClick();

interstitialAd.destroy() （1078+）

描述

销毁插屏广告。

示例代码

收起
自动换行
深色代码主题
复制
interstitialAd.destroy()

ad.createTemplateAd(OBJECT)（1101+）

描述

创建 Template 广告，如果已经创建过 Template 广告，则返回已创建的广告。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	模板广告标识位。
type	string	是	支持两种类型的广告。 appList：应用榜单 infoCard：信息流应用榜单和信息流有多种模板样式，设置宽高时，请参见“广告的宽高建议值”。
channel(1104+)	string	否	启动渠道来源，长度不超过64。
darkMode	number	否	深色模式开关。 0：浅色模式 1：深色模式 -1：跟随当前快应用的显示模式
width	number	否	期望模板广告宽度，单位为px。
height	number	否	期望模板广告高度，单位为px。
personalizedAd	number	否	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

广告的宽高建议值

展开

广告类型	样式	建议宽高
应用榜单	上图下文可横划；上图下文不可横划	Width：750px ；Height：308px
	左图右文可横划	Width：750px ；Height：183px
	左图右文不可横划	Width：750px ；Height：217px
	竖向列表	Width：750px ；Height：142px
信息流	上图下文可横划；上图下文不可横划	Width：750px ；Height：621px
	单图单文-文字浮层样式	Width：750px ；Height：519px
	左图右文样式；左文右图样式	Width：750px ；Height：217px
	三图样式	Width：750px ；Height：365px
	竖版样式	Width：750px ；Height：812px

返回值

模板广告。

示例代码

收起
自动换行
深色代码主题
复制
let templateAd = ad.createTemplateAd({
    adUnitId: 'xxx',
    type:'infoCard',
    channel:'xxx',
    darkMode:0,
    width:1200,
    height:800,
    personalizedAd:0
})

templateAd.load(OBJECT)（1101+）

描述

加载模板广告。

OBJECT参数

展开

参数	类型	是否必填	说明
success	function	否	成功回调。
fail	function	否	失败回调。

fail返回错误代码

展开

错误码	说明
200	请求广告失败。
202	参数错误。
203	初始化错误。
205	不支持该服务地。

示例代码

收起
自动换行
深色代码主题
复制
templateAd.load({
    success:function(data){
        console.log('load success = ' + data );
    },
     fail: function(data, code) {
        console.log("load fail, code=" + code);
    }
})

load成功后可创建ad-view组件。

templateAd.destroy()（1101+）

描述

销毁模板广告。

示例代码

收起
自动换行
深色代码主题
复制
templateAd.destroy()

ad.createAppBoxAd (OBJECT)（1101+）

描述

创建互推盒子广告，如果已经创建过互推盒子广告，则返回已创建的广告。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	互推盒子广告位标识。
channel(1104+)	string	否	启动渠道来源，长度不超过64。
darkMode	number	否	深色模式开关。 0：浅色模式 1：深色模式 -1：跟随当前快应用的显示模式
personalize	number	否	个性化总开关。 1：（默认）开启 0：关闭

示例代码

收起
自动换行
深色代码主题
复制
let appBoxAd = ad.createAppBoxAd({
    adUnitId: 'xxxx',
    channel:'xxx',
    darkMode: 0,
    personalize: 0
})

appBoxAd.load()（1101+）

描述

加载互推盒子广告。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.load();

appBoxAd.show()（1101+）

描述

显示互推盒子广告。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.show();

appBoxAd.onLoad(function callback)（1101+）

描述

监听互推盒子广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.onLoad(()=> {
  console.log('onLoad success');
});

appBoxAd.offLoad()（1101+）

描述

移除互推盒子广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.offLoad();

appBoxAd.onError(function callback)（1101+）

描述

监听互推盒子广告错误事件。

返回值

object类型。

展开

参数	类型	说明
errMsg	string	错误信息。
errCode	number	错误码。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.onError((err)=>{
    console.log(err)
})

appBoxAd.offError()（1101+）

描述

移除互推盒子广告错误监听。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.offError();

appBoxAd.onClose(function callback)（1101+）

描述

监听互推盒子广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.onClose(()=>{
console.log('appBoxAd closed');
})

appBoxAd.offClose()（1101+）

描述

移除互推盒子广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.offClose();

appBoxAd.onClick(function callback)（1101+）

描述

监听互推盒子广告点击事件。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.onClick(()=>{
console.log(' appBoxAd clicked');
})

appBoxAd.offClick()（1101+）

描述

移除互推盒子广告点击监听。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.offClick();

appBoxAd.destroy()（1101+）

描述

销毁互推盒子广告。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.destroy()

ad.createAppBoxBannerAd (OBJECT)（1101+）

描述

创建互推盒子横划榜单广告，如果已经创建过互推盒子横划榜单广告，则返回已创建的广告。

参数

展开

参数	类型	是否必填	说明
adUnitId	string	是	互推盒子横划榜单广告位标识。
channel(1104+)	string	否	启动渠道来源，长度不超过64。
style	object	是	互推盒子横划榜单广告组件的样式，详细内容参见“style说明”。
darkMode	number	否	深色模式开关。 0：浅色模式 1：深色模式 -1：跟随当前快应用的显示模式
personalizedAd	number	否	非个性化广告标记。 0：请求个性化广告与非个性化广告。 1：请求非个性化广告。

style说明

展开

参数	类型	是否必填	说明
top	number	是	互推盒子横划榜单广告组件的左上角纵坐标。
left	number	是	互推盒子横划榜单广告组件的左上角横坐标。
width	number	是	互推盒子横划榜单广告组件的宽度，单位：dp。
height	number	是	互推盒子横划榜单广告组件的高度，单位：dp。
orientation	string	否	定义榜单的放置方向。 horizontal：（默认）横向 vertical：竖向

返回值

互推盒子横划榜单广告组件为bannerBoxAd，通过bannerBoxAd.style可以获取广告的真实宽高，其返回值如下表所示：

展开

参数名	类型	说明
top	number	互推盒子横划榜单广告组件的左上角纵坐标。
left	number	互推盒子横划榜单广告组件的左上角横坐标。
width	number	互推盒子横划榜单广告组件的宽度，单位dp。
height	number	互推盒子横划榜单广告组件的高度，单位dp。
realWidth	number	互推盒子横划榜单广告组件的真实宽度，单位px。
realHeight	number	互推盒子横划榜单广告组件的真实高度，单位px。

示例代码

收起
自动换行
深色代码主题
复制
let bannerBoxAd = ad.createAppBoxBannerAd({
        adUnitId: “CdwQHgNKip8”,
        channel:'xxx',
        darkMode: 0,
        personalizedAd: 0
        style: {
          top: 20,
          left: 200,
          width: 360,
          height: 111,
          orientation: “horizontal”
     },
})

bannerBoxAd.show()（1101+）

描述

加载并显示互推盒子横划榜单广告。

出错时回调onError，加载成功回调onLoad。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.show();

bannerBoxAd.hide()（1101+）

描述

隐藏互推盒子横划榜单广告。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.hide();

bannerBoxAd.onLoad(function callback)（1101+）

描述

监听互推盒子横划榜单广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.onLoad(()=> {
  console.log('onLoad success');
});

bannerBoxAd.offLoad()（1101+）

描述

移除互推盒子横划榜单广告加载事件。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.offLoad();

bannerBoxAd.onError(function callback)（1101+）

描述

监听互推盒子横划榜单广告错误事件。

返回值

object类型。

展开

参数	类型	说明
errMsg	string	错误信息。
errCode	number	错误码。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.onError((err)=>{
    console.log(err)
})

bannerBoxAd.offError()（1101+）

描述

移除互推盒子横划榜单广告错误监听。

示例代码

收起
自动换行
深色代码主题
复制
appBoxAd.offError();

bannerBoxAd.onClose(function callback)（1101+）

描述

监听互推盒子横划榜单广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.onClose(()=>{
console.log('bannerBoxAd closed');
})

appBoxAd.offClose()（1101+）

描述

移除互推盒子横划榜单广告关闭事件。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.offClose();

bannerBoxAd.onClick(function callback)（1101+）

描述

监听互推盒子横划榜单广告点击事件。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.onClick(()=>{
console.log('bannerBoxAd clicked');
})

bannerBoxAd.offClick()（1101+）

描述

移除互推盒子横划榜单广告点击监听。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.offClick();

bannerBoxAd.destroy()（1101+）

描述

销毁互推盒子横划榜单广告。

示例代码

收起
自动换行
深色代码主题
复制
bannerBoxAd.destroy()

错误码

错误码为通过onError获取的错误信息。

展开

错误码	说明
200	通用错误。
202	参数错误。
1000	后端错误，调用失败。
1001	无效的广告请求，如未设置广告位ID、Banner广告尺寸无效等。
1002	横幅广告过期或者横幅广告任务下架。
1003	内部错误。
1004	广告请求成功，但是服务器没有返回可用的广告素材。
1005	广告组件审核中。
1006	广告组件被驳回。
1007	广告能力被封禁。
1008	广告位的广告能力已关闭。
1100	广告正在请求中，不能重复发起请求。
1101	广告在加载后，长时间没有展示，广告信息已过期。
1102	API版本不在广告服务支持范围内。
1103	环境监测失败，如应用无权限等。
1104	由于网络连接错误导致广告请求失败。
1105	广告未加载成功。
1106	广告展示失败。
2000	HMS Core版本过低，不支持设置AppInfo。

注意事项

提交验收前请参考如下规则对广告进行自检：

请勿设置定时器循环请求广告。
请勿失败后频繁重复请求广告。
【错误做法】失败后在onError中重新请求广告。如果每次都回调onError，会进入“请求广告—>失败—>请求广告”的恶性循环。

【推荐做法】正常情况下不管是成功还是失败都不要再次发起请求。如果业务希望请求失败后重试，只有激励视频可以再发起1次，其他类型广告都不要再次发起请求。
每次请求的广告不能重复展示，展示完成后需要重新实时获取后，再次展示。
【错误做法】在多个页面使用同一个全局的广告去展示广告。

【推荐做法】每个页面的广告对象是独立的，需要使用createXX的方法去创建广告、注册回调等。
预缓存的广告如激励视频插屏广告，请注意load和show接口调用的时间间隔，超过一个小时需重新请求新的广告来展示，否则计为无效展示，将不计费结算。
激励视频调用show接口前，建议先预加载，加载失败的时候，不要显示广告入口。否则从广告入口进入后，可能因为视频数据没有加载完成，导致空白。
【推荐做法】建议在onLoad回调中延时几秒或者几分钟调用show接口。

注意

延时时长不要超过1个小时，否则广告计为无效展示，将不计费结算。
没有任何内容或不以内容为主的屏幕上应避免展示广告。
广告必须有关闭按钮，特别是由开发者自行定义布局的原生广告，一定要在广告界面上设计关闭能力。
广告素材必须全尺寸等比例展示。展示广告时，要保证原有的宽高比，只能等比例缩放。
请勿将广告背景设置为可点区域，只允许广告的图片、标题、按钮等素材区域可以点击跳转落地页。
原生广告每次点击都需要调用reportAdClick接口上报点击事件。
【错误做法】原生广告多次点击只上报一次点击事件。
原生广告每次展示都需要上报曝光事件。
【错误做法】原生广告多次展示只上报一次曝光事件。例如：在首次展示广告的时候调用reportAdShow接口上报，但当从其他页面返回到广告页面时，仍然显示了广告，但是没有上报曝光事件。

【推荐做法】当页面可见时，如果还显示原生广告，需要再次上报曝光事件。一般在页面生命周期onShow中处理。
点击原生广告图片区域应调用reportAdClick接口实现落地页跳转。
原生广告的广告来源、广告标题、广告标识、关闭按钮、查看或者下载安装按钮，都不能有缺失。
除了需要预加载的激励视频和插屏广告，其他类型广告都需要实时请求成功后再实时展示。
【错误做法】请求了原生广告却没有展示。
必须用户同意了用户隐私协议才能展示广告，不同意请勿请求和展示广告。

建议优先选择test开头的测试广告位ID。

展开

广告位类型	测试广告位ID	展示形式	尺寸	推广类型
开屏	testq6zq98hecj	图片	1080*1620	网页
	q6zq98hecj	图片	1920*1080	网页
	n7p4mh57xs	图片	1080*1620	应用促活
	q1h4mvd5a3	图片	1080*1620	应用下载
	testd7c5cewoj6	视频	720*1280	网页
原生	testu7m3hc4gvm	大图	1080*607	网页
	i7ik1b3mgg	大图	1080*607	应用促活
	a5sz2rxpaj	大图	1080*607	应用下载
	u7m3hc4gvm	大图	1080*607	应用下载
	r6w14o0hqz	三图	225*150	应用下载
	testb65czjivt9	小图	225*150	应用下载
	b65czjivt9	小图	225*150	应用下载
	testy63txaom86	视频	640*360	应用下载
	y63txaom86	视频	640*360	应用下载
	j79gukslrn	图片	160*160	应用下载
激励视频	u2k89ub7vq	视频	640*360	网页
	e7hm5vx799	视频	640*360	应用下载
	testx9dtjwj8hp	视频	720*1080	应用下载
Banner	x0kvs12iu6	图片	1080*170	应用下载
Banner	testw6vs28auh3	图片	1080*170	应用下载
插屏	testb4znbuh3n2	视频	720*1080	网页
	t3u4pks711	视频	640*360	应用下载
	l7s7x17w20	视频	1280*720	应用下载
	g2tz5d4wkv	视频	720*1280	应用下载

FAQ

版本更新说明

展开

版本	发布日期	描述
1113	2024-04-19	nativeAd.onLoad说明新增返回值为99时的场景
1112	2024-04-08	nativeAd.onLoad新增ext参数。
1111	2024-03-06	nativeAd.load新增extra参数。 rewardedVideoAd.load新增extra参数。 bannerAd.show新增extra参数。 interstitialAd.load新增extra参数。
1106	2023-06-19	nativeAd.onLoad的广告item说明新增应用相关的参数。 nativeAd.reportAdClick的clickInfo参数中新增upX、upY等参数，并修改creativeSize参数说明。新增nativeAd.showAppDetailPage()接口：跳转应用详情页。新增nativeAd.onRewardActive(function callback)接口：监听原生广告激励产生事件，仅AGD类广告返回。新增nativeAd.offRewardActive()接口：移除原生广告激励产生监听。新增1005、1106等错误码。
1105	2023-04-25	nativeAd.reportAdClick新增clickInfo参数。
1104	2023-02-28	原生广告、模板广告、互推盒子广告和互推盒子横划榜单广告接口新增channel字段。修复了nativeAd.onLoad的desc参数内容不为广告描述的问题。
1101	2022-09-10	新增模板广告接口。 ad.createTemplateAd(OBJECT)：创建 Template 广告组件，如果已经创建过 Template 广告组件，则返回已创建的广告。添加了信息流和应用榜单的建议宽高值。 templateAd.load(OBJECT)：加载模板广告。 templateAd.destroy()：销毁模板广告。新增互推盒子广告接口。新增互推盒子横划榜单广告接口。
1070	2020-05-19	第一次正式发布。