createRewardedVideoAd 1.3.0+

开发者可以在小游戏中使用Video广告获得收入。Video广告是由客户端原生渲染,覆盖在整个小游戏Canvas区域之上。Video广告展示的时候用户不能操作小游戏。 Video广告目前支持竖屏展示。如果是横屏游戏在展示时会先切到竖屏。开发者工具上暂不支持调试该 API,请直接在真机上进行调试。

输入

名称 数据类型 属性 默认值 描述
adUnitId string required 广告位id

输出

videoAd实例。

提示

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

videoAd的方法列表

videoAd.show()

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

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事件的监听器。