API 教程

RewardedVideoAd

rewardedVideoAd.show()

show() 是 RewardedVideoAd 对象的方法，返回一个 promise 对象。

rewardedVideoAd.show()

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}
const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.show()
.then()
.catch(err => console.log(err));

rewardedVideoAd.load()

load() 是 RewardedVideoAd 对象的方法，返回一个 promise 对象。

rewardedVideoAd.load()

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}
const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.load()
.then()
.catch(err => console.log(err));

rewardedVideoAd.onLoad()

onLoad() 是 RewardedVideoAd 对象的方法，监听激励视频的加载事件。

rewardedVideoAd.onLoad(callback)

参数值：

参数 类型 是否必填 描述
callback function 是 激励视频加载完成后的回调函数

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}
const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onLoad(() => {
    console.log('视频加载完成');
})

rewardedVideoAd.offLoad()

offLoad() 是 RewardedVideoAd 对象的方法，用于取消监听激励视频的加载事件。

rewardedVideoAd.offLoad(callback)

参数值：

参数 类型 是否必填 描述
callback function 否 取消监听激励视频加载事件对应的回调函数(如果不传参数，则清除所有监听激励视频加载事件的回调函数)

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}

let onLoadFuc = function () {
    console.log('视频加载完成')
}

const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onLoad(onLoadFuc);
rewardedVideoAd.offLoad(onLoadFuc); //offLoad对应的函数将取消对应的监听事件

rewardedVideoAd.onError()

onError() 是 RewardedVideoAd 对象的方法，监听激励视频的错误事件。

rewardedVideoAd.onError(callback)

参数值：

参数 类型 是否必填 描述
callback function 是 激励视频出现错误的回调函数

回调函数参数值：

属性 类型 描述
err Object 回调函数的参数
err.errCode number 错误码
err.errMsg string 错误信息

errCode与对应的错误信息

错误码 错误描述
103010 appSid 缺失
103011 appSid 错误，MSSP 未收录
103012 appSid 无效，MSSP 上未生效
103020 appSid 无效，渠道 ID 信息错误
107000 adUnitId 缺失
107001 adUnitId 未收录
107002 adUnitId 未启用
107003 adUnitId 与 appSid 不匹配
200000 无广告返回
201000 无广告数据
3010000 广告组件挂载失败
3010001 播放器内部错误
3010002 广告请求失败
3010003 网络连接错误
3010004 没有可以展示的广告
3010005 广告正在拉取中，不能重复请求
3010006 广告正在展示中，不能请求广告
3010007 广告请求参数为空
3010008 激励视频播放地址为空
3010009 激励视频重复初始化错误
else 其余错误码均为内部错误

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}
const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onError((err) => {
    console.log('激励视频错误');
})

rewardedVideoAd.offError()

offError() 是 RewardedVideoAd 对象的方法，用于取消监听激励视频的错误事件。

rewardedVideoAd.offError(callback)

参数值：

参数 类型 是否必填 描述
callback function 否 取消监听激励视频错误事件对应的回调函数(如果不传参数，则清除所有监听激励视频错误事件的回调函数)

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}

let onErrorFuc = function () {
    console.log('视频出现错误');
}

const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onError(onErrorFuc);
rewardedVideoAd.offError(onErrorFuc); //offError对应的函数将取消对应的监听事件

rewardedVideoAd.onClose()

onClose() 是 RewardedVideoAd 对象的方法，监听用户点击关闭广告按钮的事件。

rewardedVideoAd.onClose(callback)

参数值：

参数 类型 是否必填 描述
callback function 是 用户点击关闭广告按钮后的回调函数

回调函数参数值：

参数 类型 描述
res Object 回调函数的参数
res.isEnded boolean 用户是否在视频播放完成后关闭广告

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}
const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onClose((res) => {
    console.log('激励视频关闭');
})

rewardedVideoAd.offClose()

offClose() 是 RewardedVideoAd 对象的方法，用于取消监听点击关闭广告按钮的事件。

rewardedVideoAd.offClose(callback)

参数值：

参数 类型 是否必填 描述
callback function 否 取消监听点击关闭广告按钮事件对应的回调函数(如果不传参数，则清除所有监听用户点击关闭广告按钮事件的回调函数)

示例：

let example = {
    adUnitId: '000000',
    appSid: '000000'
}

let onCloseFuc = function () {
    console.log('视频出现错误');
}

const rewardedVideoAd = swan.createRewardedVideoAd(example);
rewardedVideoAd.onClose(onCloseFuc);
rewardedVideoAd.offClose(onCloseFuc); //offClose对应的函数将取消对应的监听事件