# 广告
# createInterstitialAd
基础库 3.5.4 起支持
createInterstitialAd(Object object)
创建插屏广告组件,返回 InterstitialAd 示例
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
adUnitId | string | 是 | 广告 ID | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
# InterstitialAd
# InterstitialAd.show()
显示插屏广告,返回一个 Promise。
# InterstitialAd.load()
加载插屏广告,返回一个 Promise。
# InterstitialAd.destroy()
销毁插屏广告实例。
# InterstitialAd.onLoad
接收函数作为参数,监听插屏广告加载事件。
# InterstitialAd.offLoad
移除插屏广告加载事件的监听函数,不传参数则移除所有
# InterstitialAd.onError
接收函数作为参数,监听插屏错误事件。
# InterstitialAd.offError
移除插屏错误事件的监听函数,不传参数则移除所有
# InterstitialAd.onClose
接收函数作为参数,监听插屏广告关闭事件。
# InterstitialAd.offClose
移除插屏广告关闭事件的监听函数,不传参数则移除所有
# createRewardedVideoAd
基础库 3.5.4 起支持
createRewardedVideoAd(Object object)
创建插屏广告组件,返回 RewardedVideoAd 实例
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
adUnitId | string | 是 | 广告 ID | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
# RewardedVideoAd
# RewardedVideoAd.show()
显示插屏广告,返回一个 Promise。
# RewardedVideoAd.load()
加载插屏广告,返回一个 Promise。
# RewardedVideoAd.destroy()
销毁插屏广告实例。
# RewardedVideoAd.onLoad
接收函数作为参数,监听插屏广告加载事件。
# RewardedVideoAd.offLoad
移除插屏广告加载事件的监听函数,不传参数则移除所有
# RewardedVideoAd.onError
接收函数作为参数,监听插屏错误事件。
# RewardedVideoAd.offError
移除插屏错误事件的监听函数,不传参数则移除所有
# RewardedVideoAd.onClose
接收函数作为参数,监听插屏广告关闭事件。
# RewardedVideoAd.offClose
移除插屏广告关闭事件的监听函数,不传参数则移除所有
# APP 实现广告流程
# 1、实现 invokeNativeAd 自定义 API
广告的 create 方法内部是调用了 invokeNativeAd API,因此 APP 需实现同名的自定义 API
自定义 API 的实现方式:
# 2、APP 收到 invokeNativeAd 的调用后,根据参数做不同类型处理(处理 show、load、destroy)
APP 收到的 invokeNativeAd API 参数包括以下字段:
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
type | string | 广告 ID,值为 InterstitialAd 或 RewardedVideoAd 其中之一 | |
method | string | 广告调用的方法,值为 create、show、load、destroy 其中之一,对应小程序的广告实例的各个方法 | |
adUnitId | string | create 时传入的广告 ID | |
instanceId | string | create 时生成的唯一实例 id |
APP 根据参数做不同处理即可
# 3、APP 根据广告展示流程触发 onLoad、onClose、onError 逻辑
触发时需通过 SDK 发送事件到小程序,参数实例如下:
{
name: 'onNativeAdEvent', // 必需,onNativeAdEvent 表示是广告回调事件
data: {
method: 'onLoad', // 必需,表示广告回调的事件,合法值为 onLoad、onError、onClose
adUnitId: '', // 非必需,表示广告 ID
instanceId: 'xxx', // 必需,create 时传的实例 id
}
}
自定义事件的发送方式: