sud.createRewardedVideoAd
创建激励视频广告对象。每次调用都会返回一个新实例。
typescript
createRewardedVideoAd(params: {
adUnitId: string;
/** 是否启用多例模式,默认为 true(预留参数,暂未生效) */
multiton?: boolean;
/** 是否禁用分享页,默认为 false(预留参数,暂未生效) */
disableFallbackSharePage?: boolean;
}): RewardedVideoAd;参数
Object object
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| adUnitId | string | 是 | SUD OpenPaaS 控制台配置的广告单元 ID |
| multiton | boolean | 否 | 是否启用多例模式,默认为 true(预留参数,暂未生效) |
| disableFallbackSharePage | boolean | 否 | 是否禁用分享页,默认为 false(预留参数,暂未生效) |
返回值
RewardedVideoAd 广告对象。
方法
| 方法 | 返回值 | 说明 |
|---|---|---|
load() | Promise<void> | 发起广告加载 |
show() | Promise<void> | 发起广告展示 |
destroy() | void | 销毁广告;销毁后不可继续使用 |
load() 和 show() 的 Promise 仅表示方法调用结果。广告加载成功通过 onLoad 通知,加载或展示失败通过 onError 通知,关闭通过 onClose 通知。
load()受请求频次限制,触发限制时通过 onError 返回错误码(errCode)和错误信息(errMsg)。
事件
| 方法 | 说明 |
|---|---|
onLoad(listener) | 监听广告加载成功 |
offLoad(listener) | 移除指定的加载成功监听函数 |
onError(listener) | 监听广告加载或展示失败 |
offError(listener) | 移除指定的错误监听函数 |
onClose(listener) | 监听广告关闭 |
offClose(listener) | 移除指定的广告关闭监听函数 |
onLoad 回调参数
onLoad 的监听函数接收以下对象:
| 属性 | 类型 | 说明 |
|---|---|---|
| useFallbackSharePage | boolean | 本次展示是否使用激励广告分享页(预留参数,暂未生效) |
onError 回调参数
onError 的监听函数接收以下对象:
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | number | 参见广告错误码 |
| errMsg | string | 错误信息 |
onClose 回调参数
onClose 的监听函数接收以下对象:
| 属性 | 类型 | 说明 |
|---|---|---|
| isEnded | boolean | 本次广告是否满足奖励条件 |
true 可进入游戏的奖励处理流程,false 不发放奖励。不要仅因广告关闭就发放奖励;同一次展示只处理一次奖励结果。
示例代码
进入奖励场景时创建并加载广告,用户点击观看广告按钮后调用 onRewardButtonClick();仅在 onClose 返回 isEnded === true 时发放奖励。
javascript
const rewardedVideoAd = sud.createRewardedVideoAd({
adUnitId: 'adunit-xxxxxxxx',
// 预留参数,暂未生效
multiton: true,
disableFallbackSharePage: false,
});
let ready = false;
let disposed = false;
let showRequested = false;
function onLoad(res) {
if (disposed) return;
// res.useFallbackSharePage 预留参数,暂未生效
ready = true;
}
function onError(err) {
if (disposed) return;
console.error('激励视频广告失败', err);
onRewardSceneExit();
}
function onClose(result) {
if (disposed) return;
onRewardSceneExit();
if (result?.isEnded === true) {
console.log('已满足奖励条件');
// 在此处理一次游戏奖励。
}
}
function onRewardButtonClick() {
if (disposed || !ready || showRequested) return;
showRequested = true;
ready = false;
rewardedVideoAd.show().catch(onError);
}
function onRewardSceneExit() {
if (disposed) return;
disposed = true;
ready = false;
rewardedVideoAd.offLoad(onLoad);
rewardedVideoAd.offError(onError);
rewardedVideoAd.offClose(onClose);
rewardedVideoAd.destroy();
}
rewardedVideoAd.onLoad(onLoad);
rewardedVideoAd.onError(onError);
rewardedVideoAd.onClose(onClose);
rewardedVideoAd.load().catch(onError);将 onRewardSceneExit() 绑定到场景退出时机。完整流程见 游戏开发示例。
