抖音开放平台Logo
开发者文档
小游戏
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • tt.createRewardedVideoAd
  • tt.createBannerAd
  • tt.createInterstitialAd
  • BannerAd
  • RewardedVideoAd
  • InterstitialAd
  • 界面
  • 支付
  • Worker

    • tt.createRewardedVideoAd
    收藏
    我的收藏

    基础库 1.3.0 开始支持本方法，这是一个同步方法。

    开发者可以在小游戏中使用 Video 广告获得收入。Video 广告是由客户端原生渲染，覆盖在整个小游戏 Canvas 区域之上。观看广告时会暂停所有 JS 逻辑。Video 广告展示的时候用户不能操作小游戏。

    前提条件

    接入本能力需要先开通【流量主】能力，请前往小游戏开发者后台

    1. 在「商业化」> 「流量主」申请开通能力
    2. 在「流量主」> 「广告管理」中创建激励视频广告位，获取广告位 id
    业务背景无
    使用限制无
    注意事项
    • 建议开发者在广告开发时始终注册 onError 方法的监听，保证对所有广告异常情况的处理。
    • 广告是全屏展示，由于不同系统的识别有所区别，在 iOS 端，广告的播放和关闭会触发 onShow 和 onHide 事件，安卓则不会。但无论是否触发，在激励广告播放期间，游戏逻辑和渲染都会被暂停，用户不能操作小游戏。
    • Video 广告目前支持竖屏展示。如果是横屏游戏在展示时会先切到竖屏
    相关教程无

    语法

    tt.createRewardedVideoAd(params)

    参数说明

    params 类型说明

    object 类型，属性如下：

    属性名类型默认值必填说明最低支持版本
    multitonbooleanfalse否

    是否开启再得广告模式（只支持安卓系统的抖音和抖音极速版）

    功能说明：激励再得能力

    		2.74.0
    multitonRewardMsgArray<string>否

    再得广告的奖励文案，玩家每看完一个广告都会展示，如【再看1个获得xx】

    xx 即 multitonRewardMsg 中的文案，按顺序依次展示，单个文案最大长度为 7

    multiton 为 true 时必填

    		2.74.0
    multitonRewardTimesnumber否

    额外观看广告的次数，合法的数据范围为 1-4，multiton 为 true 时必填

    		2.74.0
    progressTipbooleanfalse否

    是否开启进度提醒，开启时广告文案为【再看N个获得xx】，关闭时为【 再看1个获得xx】。

    N 表示玩家当前还需额外观看广告的次数。

    		2.74.0
    adUnitIdstring是

    广告位 id，后续可以在平台基于广告位 id 看数

    		1.3.0

    返回值

    类型说明最低支持版本
    object

    RewardedVideoAd 实例

    		1.3.0

    错误码

    errNoerrMsg说明最低支持版本
    10301feature is not supported in app
    		1.3.0
    21300context exception
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003current activity is null, can not create game banner
    		1.3.0
    1003Please apply for an adUnitId
    		1.3.0
    1003can not create game banner
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1006The scene does not support advertising
    		1.3.0
    1001The adUnitId is empty
    		1.3.0
    1008The adUnitId is closed
    		1.3.0
    1007The adUnitId is prohibit
    		1.3.0
    1002The adUnitId is invalid
    		1.3.0
    20001invalid param
    参数错误
    		1.3.0
    20001multitonRewardTimes must be non-null when multiton is true
    		1.3.0
    20001multitonRewardMsg must have content when multiton is true
    		1.3.0
    20001multitonRewardTimes should greater than 1
    		1.3.0
    20001multitonRewardTimes should less than 4
    		1.3.0
    20001multitonRewardMsg is too long
    		1.3.0
    20000internal error
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003Host app does not support
    		1.3.0
    21000Host app not supported
    		1.3.0
    1003The adUnitId is empty
    onVideoAdStateChange
    		1.3.0
    1003The adUnitId is invalid
    onVideoAdStateChange
    		1.3.0
    1003unknown ad type
    onVideoAdStateChange
    		1.3.0
    1002The adUnitId is invalid
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    21000unitid is illegal
    		1.3.0
    21000unitid is illegal
    		1.3.0
    21000unitid is illegal
    		1.3.0
    21000unitid is illegal
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    21000unitid is illegal
    		1.3.0
    1000request ad failed @1
    		1.3.0
    1000request ad failed @2
    		1.3.0
    1000request ad failed @3
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1000request ad failed @4
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1000request ad failed @7
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @5
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @6
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @8
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @9
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @10
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1003request ad failed @50001/30001/20000
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1001request ad failed @20001
    小游戏框架内部错误，有需要请创建工单咨询
    		1.3.0
    1004request ad failed @50002
    		1.3.0

    代码示例

    激励再得能力介绍

    该能力从基础库开始 2.74.0 开始支持，即抖音、抖 lite 版本为 23.4 时支持，预计 12 月生效

    能力介绍：详情

    const videoAd = tt.createRewardedVideoAd({
  adUnitId: "xxxxxxxxxxx",
  multiton: true,
  multitonRewardMsg: ['更多奖励1', '更多奖励2', '更多奖励3'],
  multitonRewardTimes: 3,
  progressTip: false,
});
videoAd.show().then(() => {
  console.log("视频广告展示");
});

    录屏分享激励能力

    该能力从基础库开始 2.20 开始
    当激励视频广告返回 1004 等错误，用户无法观看广告时，会自动拉起分享系统。具体逻辑为，本地存在录屏文件时，自动拉起录屏分享，不存在录屏时，拉起默认分享面板（分享给好友）。并在用户分享完成后，通过激励视频广告的 onClose 回调 count == 1 ，对于开发者来说，处理逻辑和之前一样。
    需要注意：
      •该能力默认为开。
      •对于开发者无需修改，兼容现有广告逻辑，分享成功会回调 onClose 中 count == 1。
      •对于用户来说，表现为点击广告后无广告内容，因此弹出录屏分享或好友分享替代，开发者若有必要可以给予用户一定说明。