InterstitialAd
插屏广告组件。插屏广告组件是一个原生组件,层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用),默认是隐藏的,需要调用 InterstitialAd.show() 将其显示。
方法
destroy
销毁插屏广告实例。
支持情况:
() => void
offClose
取消监听插屏广告关闭事件
支持情况:
(callback: OnCloseCallback) => void
参数 | 类型 |
---|---|
callback | OnCloseCallback |
offError
取消监听插屏错误事件
支持情况:
(callback: OnErrorCallback) => void
参数 | 类型 |
---|---|
callback | OnErrorCallback |
offLoad
取消监听插屏广告加载事件
支持情况:
(callback: OnLoadCallback) => void
参数 | 类型 |
---|---|
callback | OnLoadCallback |
onClose
监听插屏广告关闭事件。
支持情况:
(callback: OnCloseCallback) => void
参数 | 类型 |
---|---|
callback | OnCloseCallback |
onError
监听插屏错误事件。
支持情况:
(callback: OnErrorCallback) => void
参数 | 类型 |
---|---|
callback | OnErrorCallback |
onLoad
监听插屏广告加载事件。
支持情况:
(callback: OnLoadCallback) => void
参数 | 类型 |
---|---|
callback | OnLoadCallback |
load
加载插屏广告。
支持情况:
() => Promise<any>
show
显示插屏广告。
错误码信息表
如果插屏广告显示失败,InterstitialAd.show() 方法会返回一个rejected Promise,开发者可以获取到错误码及对应的错误信息。
代码 | 异常情况 | 理由 |
---|---|---|
2001 | 触发频率限制 | 小程序启动一定时间内不允许展示插屏广告 |
2002 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足,不允许展示插屏广告 |
2003 | 触发频率限制 | 当前正在播放激励视频广告或者插屏广告,不允许再次展示插屏广告 |
2004 | 广告渲染失败 | 该项错误不是开发者的异常情况,或因小程序页面切换导致广告渲染失败 |
2005 | 广告调用异常 | 插屏广告实例不允许跨页面调用 |
支持情况:
() => Promise<any>
参数
OnCloseCallback
插屏广告关闭事件的回调函数
(res: TaroGeneral.CallbackResult) => void
参数 | 类型 |
---|---|
res | TaroGeneral.CallbackResult |
OnErrorCallback
插屏错误事件的回调函数
(result: OnErrorCallbackResult) => void
参数 | 类型 |
---|---|
result | OnErrorCallbackResult |
OnLoadCallback
插屏广告加载事件的回调函数
(res: TaroGeneral.CallbackResult) => void
参数 | 类型 |
---|---|
res | TaroGeneral.CallbackResult |
OnErrorCallbackResult
参数 | 类型 | 说明 |
---|---|---|
errCode | string or number or symbol | 错误码 参考地址 |
errMsg | string | 错误信息 |
API 支持度
API | 微信小程序 | H5 | React Native | Harmony |
---|---|---|---|---|
InterstitialAd.destroy | ✔️ | |||
InterstitialAd.offClose | ✔️ | |||
InterstitialAd.offError | ✔️ | |||
InterstitialAd.offLoad | ✔️ | |||
InterstitialAd.onClose | ✔️ | |||
InterstitialAd.onError | ✔️ | |||
InterstitialAd.onLoad | ✔️ | |||
InterstitialAd.load | ✔️ | |||
InterstitialAd.show | ✔️ |