激励广告【此API使用场景为广告商业化能力接入，需要先完成相关的接入操作后，再申请此API调用】
小游戏接入指南：https://miniapp.open.taobao.com/doc.htm?docId=121691&docType=1&tag=game-info
名称 |
类型 |
必填 |
默认值 |
描述 |
基础库最低版本 |
adUnitId |
String |
必填 |
广告单元 id |
||
pReportExtra |
String |
非必填 |
广告链路的外部参数的透传。示例： {pReportExtra:{zoneId: 1}}，目前仅支持zoneId这一个固定key的透传，表示游戏区服id。 |
名称 |
类型 |
描述 |
RewardedAd |
Object |
激励广告组件 |
—onClose |
Function |
监听用户关闭广告的事件 / 回调返回包含是否完成的判断标志 { isCompleted:boolean } |
—offClose |
Function |
移除用户关闭广告的事件 |
—onComplete |
Function |
监听用户完成激励型广告 |
—offComplete |
Function |
移除户完成激励型广告的监听函数 |
—onLoad |
Function |
监听激励广告加载事件 |
—offLoad |
Function |
移除激励广告加载事件的监听函数 |
—onError |
Function |
监听激励广告错误事件 |
—offError |
Function |
移除激励广告错误事件的监听函数 |
—load |
Function |
加载激励广告 |
—show |
Function |
显示激励广告 |
—destroy |
Function |
销毁激励广告实例/需要主动调用销毁实例的方法，实例才会销毁 |
高性能模式：
const RewardedVideoAd = my.createRewardedAd({ adUnitId: "广告位ID",{pReportExtra:{zoneId: 1}} });
RewardedVideoAd
.load()
.then(() => RewardedVideoAd.show()
)
.catch((err) => {
console.log("广告组件出现问题", err);
})
const loadCallback = (res) => {
console.log('loadCallback:', res)
}
// 完成广告回回调
const completeCallback = (res) => { console.log('completeCallback', res) }
// 完成广告或者未完成广告，关闭广告会回调
const closeCallback = (res) => { console.warn('closeCallbak', res) }
// 广告接口报错的回调
const errorCallback = (e) => { console.error('errorCallback', e) }
// 监听广告的事件
RewardedVideoAd.onLoad(loadCallback)
RewardedVideoAd.onClose(closeCallback)
RewardedVideoAd.onComplete(completeCallback)
RewardedVideoAd.onError(errorCallback)
// 在合适的时机去释放监听
RewardedVideoAd.offLoad(callback)
RewardedVideoAd.offComplete(callback)
普通模式：
const RewardedVideoAd = my.createRewardedAd({ adUnitId: "adUnitId",{pReportExtra:{zoneId: 1}} });
let isLoaded = false
// 按钮或者自定义事件触发
const invoke = () => {
if (isLoaded) {
RewardedVideoAd
.show()
.then(() => {
console.log("广告显示成功");
// 展示成功清除
isLoaded = false
})
.catch((err) => {
console.log("广告组件出现问题", err);
// 再次重试加载一次
RewardedVideoAd
.load()
.then(() => {
console.log("手动加载成功");
invoke()
});
})
} else {
console.log('广告没加载完成');
}
}
const loadCallback = (res) => {
console.log('loadCallback:', res)
isLoaded = true
}
// 完成广告后，关闭广告会回调
const completeCallback = (res) => { console.log('completeCallback', res) }
// 完成广告或者未完成广告，关闭广告会回调
const closeCallback = (res) => { console.warn('closeCallbak', res) }
// 广告接口报错的回调
const errorCallback = (e) => { console.error('errorCallback', e) }
// 监听广告的事件
RewardedVideoAd.onLoad(loadCallback)
RewardedVideoAd.onClose(closeCallback)
RewardedVideoAd.onComplete(completeCallback)
RewardedVideoAd.onError(errorCallback)
// 在合适的时机去释放监听
// RewardedVideoAd.offLoad(callback)
// RewardedVideoAd.offComplete(callback)
