开发
API
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.createRewardedVideoAd

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

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

开发者可以在小程序中使用激励视频广告获得收入。具体接入方式可参考抖音端激励视频广告接入说明

语法

tt.createRewardedVideoAd(options)

参数说明

options

类型默认值必填说明最低支持版本
object广告配置参数1.57.0

具体属性如下:

属性名类型默认值必填描述最低支持版本
adUnitIdstring广告位 id1.57.0

返回值

返回值为 RewarededVideoAd 类型,属性如下:

属性名类型默认值描述最低支持版本
showfunction广告创建后默认是隐藏的,可以通过该方法显示广告1.57.0
onLoadfunction绑定广告 load 事件的监听器1.57.0
offLoadfunction解除绑定 load 事件的监听器1.57.0
loadfunction当广告素材加载出现错误时,可以通过 load 方法手动加载1.57.0
onErrorfunction绑定 error 事件的监听器,具体错误码可参考错误码说明1.57.0
offErrorfunction解除绑定 error 事件的监听器1.57.0
onClosefunction绑定 close 事件的监听器1.57.0
offClosefunction解除绑定 close 事件的监听器1.57.0

代码示例

Page({
  onLoad() {
    // 创建实例
    this.ad = tt.createRewardedVideoAd({
      adUnitId: "xxx",
    });

    // 监听错误
    this.ad.onError((err) => {
      tt.hideLoading();
      switch (err.errCode) {
        case 1004:
          // 无合适的广告
          break;
        default:
        // 更多请参考错误码文档
      }
    });

    // 监听视频播放完成
    this.ad.onClose((data) => {
      tt.hideLoading();
      if (data.isEnded) {
        console.log("观看了", data.count, "个视频");
      } else {
        console.log("未观看完视频");
      }
    });

    // 预加载资源
    this.ad.load();
  },

  // 处理用户点击
  handleClick() {
    tt.showLoading();
    this.ad.show();
  },
});

Bug & Tip

  • Tip:激励视频广告是由客户端原生渲染,覆盖在整个小程序页面区域之上,目前支持竖屏展示。
  • Tip:全局只有一个 RewarededVideoAd 实例,重复创建不会覆盖。
  • Tip:激励视频广告展示的时候用户不能操作小程序。
  • Tip:开发者工具上暂不支持调试该 API,请在真机上进行调试。
  • Tip:广告不是每一次都会出现,广告是否会成功调起与用户匹配度、填充率等多种因素有关,没有出现可能是由于该用户不适合浏览广告,可通过 onError 进行监听。具体错误码可参考错误码说明
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助