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

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

    开发者可以在小游戏中使用 Banner 广告获得收入。Banner 广告是由客户端原生渲染,覆盖在开发者指定的区域上。

    前提条件

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

    1. 在「商业化」> 「流量主」申请开通能力
    2. 在「流量主」> 「广告管理」中创建Banner广告位,获取广告位id
    业务背景
    使用限制
    注意事项
    • 每个广告实例只会与一条固定的广告素材绑定。开发者如果想要展示另一条广告,需要创建一个新的 bannerAd 实例。
    • adIntervals 自动刷新并不会保证必须刷新,也不会无限刷新。
    • 竖屏情况下,Banner 广告 接受的最小宽度是 300(设备像素),最大宽度是 Math.floor(屏幕宽度)。
    • 横屏情况下,Banner 广告 接受的最小宽度是 128(设备像素),最大宽度是 208(设备像素)。开发者可以在这之间自由指定广告宽度。广告组件会自动等比例缩放素材。
    相关教程

    语法

    tt.createBannerAd(params)

    参数说明

    params 类型说明

    object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    adIntervalsnumber
    广告自动刷新的间隔时间,单位为秒,参数值必须大于等于 30(该参数不传入时 Banner 广告不会自动刷新)
    1.32.0
    styleobject
    广告位区域,包括left、top、width字段
    1.3.0
    adUnitIdstring
    广告位id
    1.3.0

    style 类型说明

    object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    widthnumber128
    广告位区域宽度
    1.3.0
    leftnumber
    广告位区域左上角横坐标
    1.3.0
    topnumber
    广告位区域左上角纵坐标
    1.3.0

    返回值

    类型说明最低支持版本
    object

    BannerAd实例对象

    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
    1006The scene does not support advertising
    1.3.0
    1003can not create game banner
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    1001The adUnitId is empty
    1.3.0
    1003Please apply for an adUnitId
    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
    20000internal error
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    1003Host app does not support
    广告配置tmg = false;
    1.3.0
    1003The adUnitId is invalid
    1.3.0
    1003unknown ad type
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    21000host app not supported
    广告配置tmg = false;通过callback返回
    1.3.0
    1002The adUnitId is invalid
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    1003The adUnitId is empty
    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
    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
    1000network unavailable
    1.3.0

    代码示例

    const bannerAd = tt.createBannerAd({ adUnitId: "xxxx", })