激励视频广告

激励视频广告组件是由客户端原生的图片、文本、视频控件组成的，层级最高，会覆盖在上屏 Canvas 上。

开发者可以调用 wx.createRewardedVideoAd 创建激励视频广告组件。该方法返回的是一个全局单例。

  1. let video1 = wx.createRewardedVideoAd({ adUnitId: 'xxxx' })
  2. let video2 = wx.createRewardedVideoAd({ adUnitId: 'xxxx' })
  3. console.log(video1 === video2)
  4. // true

激励视频广告组件默认是隐藏的，因此可以提前创建，以提前初始化组件。

  1. let rewardedVideoAd = wx.createRewardedVideoAd({ adUnitId: 'xxxx' })

为避免滥用广告资源，目前每个用户每天可观看激励式视频广告的次数有限，建议展示广告按钮前先判断广告是否拉取成功。

显示/隐藏

激励视频广告组件默认是隐藏的，需要调用 RewardedVideoAd.show() 进行显示。

  1. bannerAd.show()

只有在用户点击激励视频广告组件上的 关闭广告 按钮时，广告才会关闭。开发者不可控制激励视频广告组件的隐藏。

广告拉取成功与失败

激励视频广告组件是自动拉取广告并进行更新的。在组件创建后会拉取一次广告，用户点击 关闭广告 后会去拉取下一条广告。

如果拉取成功。RewardedVideoAd.onLoad() 会执行，RewardedVideoAd.show() 返回的 Promise 也会是一个 resolved Promise。两者的回调函数中都没有参数传递。

  1. rewardedVideoAd.onLoad(() => {
  2.   console.log('激励视频 广告加载成功')
  3. })
  5. rewardedVideoAd.show()
  6. .then(() => console.log('激励视频 广告显示'))

如果拉取失败，通过 RewardedVideoAd.onError() 注册的回调函数会执行，回调函数的参数是一个包含错误信息的对象。常见异常错误参考文档

  1. rewardedVideoAd.onError(err => {
  2.   console.log(err)
  3. })

RewardedVideoAd.show() 返回的 Promise 也会是一个 rejected Promise。

  1. rewardedVideoAd.show()
  2. .catch(err => console.log(err))

拉取失败，重新拉取

如果组件的某次自动拉取失败，那么之后调用的 show() 将会被 reject。此时可以调用 RewardedVideoAd.load() 手动重新拉取广告。

  1. rewardedVideoAd.show()
  2. .catch(err => {
  3.     rewardedVideoAd.load()
  4.     .then(() => rewardedVideoAd.show())
  5. })

如果组件的自动拉取是成功的，那么调用 load() 方法会直接返回一个 resolved Promise，而不会去拉取广告。

  1. rewardedVideoAd.load()
  2. .then(() => rewardedVideoAd.show())

监听用户关闭广告

只有在用户点击激励视频广告组件上的 关闭广告 按钮时，广告才会关闭。这个事件可以通过 RewardedVideoAd.onClose() 监听。

小于 2.1.0 的基础库版本，关闭按钮 是在激励式视频播放结束后才出现，所以触发 onClose 时已经播放结束，onClose 触发时可以认为用户已经看完了广告。

大于等于 2.1.0 的基础库版本，关闭按钮 将会常驻，如下图所示

激励视频广告 - 图1

RewardedVideoAd.onClose() 的回调函数会传入一个参数 res，res.isEnded 描述广告被关闭时的状态。

属性类型说明
isEndedboolean视频是否是在用户完整观看的情况下被关闭的，true 表示用户是在视频播放完以后关闭的视频，false 表示用户在视频播放过程中关闭了视频

大于等于 2.1.0 的基础库版本，开发者需要根据 res.isEnded 判断是否视频是否播放结束、可以向用户下发奖励。

  1. rewardedVideoAd.onClose(res => {
  2.     // 用户点击了【关闭广告】按钮
  3.     // 小于 2.1.0 的基础库版本，res 是一个 undefined
  4.     if (res && res.isEnded || res === undefined) {
  5.       // 正常播放结束，可以下发游戏奖励
  6.     }
  7.     else {
  8.         // 播放中途退出，不下发游戏奖励
  9.     }
  10. })