sud.createInterstitialAd
创建插屏广告对象。每次调用都会返回一个新实例。
typescript
createInterstitialAd(params: {
adUnitId: string;
}): InterstitialAd;参数
Object object
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| adUnitId | string | 是 | SUD OpenPaaS 控制台配置的广告单元 ID |
返回值
InterstitialAd 广告对象。
方法
| 方法 | 返回值 | 说明 |
|---|---|---|
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) | 移除指定的广告关闭监听函数 |
onError 回调参数
onError 的监听函数接收以下对象:
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | number | 参见广告错误码 |
| errMsg | string | 错误信息 |
示例代码
进入关卡时创建并加载广告,在关卡结束时调用 onLevelFinished();广告未就绪时继续游戏,不展示广告。
javascript
const interstitialAd = sud.createInterstitialAd({
adUnitId: 'adunit-xxxxxxxx',
});
let ready = false;
let disposed = false;
let showRequested = false;
function onLoad() {
if (disposed) return;
ready = true;
}
function onError(err) {
if (disposed) return;
console.error('插屏广告失败', err);
onInterstitialSceneExit();
}
function onClose() {
if (disposed) return;
onInterstitialSceneExit();
}
function onLevelFinished() {
if (disposed || !ready || showRequested) return;
showRequested = true;
ready = false;
interstitialAd.show().catch(onError);
}
function onInterstitialSceneExit() {
if (disposed) return;
disposed = true;
ready = false;
interstitialAd.offLoad(onLoad);
interstitialAd.offError(onError);
interstitialAd.offClose(onClose);
interstitialAd.destroy();
}
interstitialAd.onLoad(onLoad);
interstitialAd.onError(onError);
interstitialAd.onClose(onClose);
interstitialAd.load().catch(onError);将 onInterstitialSceneExit() 绑定到场景退出时机。完整流程见 游戏开发示例。
