wx.createRewardedVideoAd
wx.createRewardedVideoAd(Object object)
功能描述:创建激励视频广告组件。调用该方法创建的激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用)。
参数:Object object。
|
adUnitId | string | - | 是 | 广告单元 id |
multiton | boolean | - | 否 | 是否启用多例模式,默认为 false |
RewardedVideoAd
激励视频广告组件。激励视频广告组件是一个原生组件,层级比普通组件高。激励视频广告是一个单例,默认是隐藏的,需要调用 RewardedVideoAd.show() 将其显示。
方法
RewardedVideoAd.load()
功能描述:加载激励视频广告。
返回值:Promise,激励视频广告加载数据的结果。
RewardedVideoAd.show()
功能描述:显示激励视频广告。激励视频广告将从屏幕下方推入。
返回值:Promise,激励视频广告显示操作的结果。
RewardedVideoAd.destroy()
功能描述:销毁激励视频广告实例。
RewardedVideoAd.onLoad(function listener)
功能描述:监听激励视频广告加载事件。
参数:function listener,激励视频广告加载事件的监听函数。
RewardedVideoAd.offLoad(function listener)
功能描述:移除激励视频广告加载事件的监听函数。
参数:function listener,onLoad 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
RewardedVideoAd.onLoad(listener)
RewardedVideoAd.offLoad(listener)
RewardedVideoAd.onError(function listener)
功能描述:监听激励视频错误事件。
参数:function listener,激励视频错误事件的监听函数。
返回参数:Object res。
|
errMsg | string | 错误信息 |
| number | 错误码 |
RewardedVideoAd.offError(function listener)
功能描述:移除激励视频错误事件的监听函数。
参数:function listener,onError 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
RewardedVideoAd.onError(listener)
RewardedVideoAd.offError(listener)
RewardedVideoAd.onClose(function listener)
功能描述:监听用户点击关闭广告按钮的事件。
参数:function listener,用户点击关闭广告按钮的事件的监听函数。
返回参数:Object res。
|
isEnded | boolean | 视频是否是在用户完整观看的情况下被关闭的 |
RewardedVideoAd.offClose(function listener)
功能描述:移除用户点击关闭广告按钮的事件的监听函数。
参数:function listener,onClose 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
RewardedVideoAd.onClose(listener)
RewardedVideoAd.offClose(listener)
wx.createBannerAd
wx.createBannerAd(Object object)
功能描述:创建 banner 广告组件。每次调用该方法创建 banner 广告都会返回一个全新的实例。
参数:Object object。
|
adUnitId | string | - | 是 | 广告单元 id |
style | Object | - | 是 | banner 广告组件的样式 |
style 的取值如下:
|
left | number | - | 是 | banner 广告组件的左上角横坐标 |
top | number | - | 是 | banner 广告组件的左上角纵坐标 |
width | number | - | 是 | banner 广告组件的宽度 |
height | number | - | 是 | banner 广告组件的高度 |
BannerAd
banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。
属性
Object style
banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。
|
left | number | banner 广告组件的左上角横坐标 |
top | number | banner 广告组件的左上角纵坐标 |
width | number | banner 广告组件的宽度。最小 300,最大至屏幕宽度(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。 |
height | number | banner 广告组件的高度 |
realWidth | number | banner 广告组件经过缩放后真实的宽度 |
realHeight | number | banner 广告组件经过缩放后真实的高度 |
方法
BannerAd.show()
功能描述:显示 banner 广告。
返回值:Promise,banner 广告显示操作的结果。
BannerAd.hide()
功能描述:隐藏 banner 广告。
BannerAd.destroy()
功能描述:销毁 banner 广告。
BannerAd.onResize(function listener)
功能描述:监听 banner 广告尺寸变化事件。
参数:function listener,banner 广告尺寸变化事件的监听函数。
返回参数:Object res。
|
width | number | 缩放后的宽度 |
height | number | 缩放后的高度 |
BannerAd.offResize(function listener)
功能描述:移除 banner 广告尺寸变化事件的监听函数。
参数:function listener,onResize 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
BannerAd.onResize(listener)
BannerAd.offResize(listener)
BannerAd.onLoad(function listener)
功能描述:监听 banner 广告加载事件。
参数:function listener,banner 广告加载事件的监听函数。
BannerAd.offLoad(function listener)
功能描述:移除 banner 广告加载事件的监听函数。
参数:function listener,onLoad 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
BannerAd.onLoad(listener)
BannerAd.offLoad(listener)
BannerAd.onError(function listener)
功能描述:监听 banner 广告错误事件。
参数:function listener,banner 广告错误事件的监听函数。
返回参数:Object res。
|
errMsg | string | 错误信息 |
| number | 错误码 |
BannerAd.offError(function listener)
功能描述:移除 banner 广告错误事件的监听函数。
参数:function listener,onError 传入的监听函数。不传此参数则移除所有监听函数。
示例代码:
const listener = function (res) { console.log(res) }
BannerAd.onError(listener)
BannerAd.offError(listener)
错误码信息
错误码是通过 onError 获取到的错误信息。调试期间,可以通过异常返回来捕获信息。可以针对异常返回加上适当的监控信息辅助排查现网情况。
|
1000 | 后端接口调用失败 | 该项错误不是开发者导致的异常情况 |
1001 | 参数错误 | 使用方法错误 |
1002 | 广告单元无效 | 可能是广告位 ID 拼写错误或者是误用了其他 APP 的广告 ID |
1003 | 内部错误 | 该项错误不是开发者导致的异常情况 |
1004 | 无合适的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 |
1010 | 广告功能已禁用 | 您的广告功能已禁用 |