tt.createRewardedVideoAd

基础库 1.57.0 开始支持本方法,低版本需做兼容处理。这是一个同步方法。

注意,目前只能在抖音使用该方法,今日头条等宿主暂不支持。

开发者可以在小程序中使用激励视频广告获得收入。激励视频广告是由客户端原生渲染,覆盖在整个小程序页面区域之上。激励视频广告展示的时候用户不能操作小程序。

激励视频广告目前支持竖屏展示。开发者工具上暂不支持调试该 API,请直接在真机上进行调试。


参数

Object object

属性类型必填描述
adUnitIdstring必填广告位 id

返回值

videoAd实例。

提示

全局只有一个videoAd实例,重复创建没有用。


videoAd的方法列表

videoAd.show()

广告创建后默认是隐藏的,可以通过该方法显示广告。 该方法返回一个 Promise 对象。当广告组件正常获取素材时,该 Promise 对象会是一个 resolved Promise。当广告组件发生错误时,会是一个 rejected Promise,参数与error事件监听器获得的参数相同。

注意,为避免滥用广告资源,每个用户每天可观看激励式视频广告的次数有限,建议添加广告展示失败的兜底逻辑,可参考videoAd.load中的示例代码。

videoAd.onLoad(listener)

绑定 load 事件的监听器。 广告组件成功拉取广告素材时会触发load事件的监听器。

videoAd.offLoad(listener)

解除绑定 load 事件的监听器。

videoAd.load()

当广告素材加载出现错误时,可以通过 load 方法手动加载。 该方法返回一个 Promise。 如果广告已经自动拉取成功,调用该方法返回一个 resolved Promise;

// 显示广告
videoAd
  .show()
  .then(() => {
    console.log("广告显示成功");
  })
  .catch(err => {
    console.log("广告组件出现问题", err);
    // 可以手动加载一次
    videoAd.load().then(() => {
      console.log("手动加载成功");
      // 加载成功后需要再显示广告
      return videoAd.show();
    });
  });

videoAd.onError(listener)

绑定 error 事件的监听器。 广告组件拉取广告素材时如果发生错误,会触发error事件的监听器。监听器会获得一个包含errCodeerrMsg属性的对象参数。

errCode 详情

videoAd.offError(listener)

解除绑定 error 事件的监听器。

videoAd.onClose(listener)

绑定 close 事件的监听器。 当用户点击了 Video 广告上的关闭按钮时,会触发close事件的监听器。监听器会获得一个包含isEnded属性的对象参数,表征用户是否完整观看了视频。

videoAd.onClose(res => {
  if (res.isEnded) {
    // 给予奖励
  }
});

videoAd.offClose(listener)

解除绑定 close 事件的监听器。


Bug & Tip

  • Tip:由于 tt.createRewardedVideoAd 采用了单例模式实现,因此若在小程序的多个页面中使用了同一个 videoAd.onxxx 方法,则相关的回调函数会在该单例上不断累加。建议开发者适时的使用 videoAd.offxxx 方法,以避免出现多个回调函数被触发的问题。
点击纠错