抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 系统信息
  • 生命周期
  • tt.restartMiniProgramSync
  • tt.exitMiniProgram
  • tt.getLaunchOptionsSync
  • tt.onShow
  • tt.onHide
  • tt.offShow
  • tt.offHide
  • 触摸事件
  • 应用级事件
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.getLaunchOptionsSync
    收藏
    我的收藏

    基础库 1.12.0 开始支持本方法,低版本需做兼容处理,这是一个同步方法
    返回小游戏启动参数。

    语法

    var options = tt.getLaunchOptionsSync()

    参数说明

    返回值

    Object

    属性名
    类型
    说明
    query
    Object
    启动参数。开发者在部分场景下往query中添加自定义字段时,应避免与某些特殊字段同名,具体可见下表。
    scene
    string
    启动场景值, 所有 scene 值可以在 场景值 中查看。以及 IDE 中:普通编译-> 增加编译模式->进入场景,查看所有场景值
    extra
    Object
    小游戏基本信息,包括宿主 Id,gameId 等参数。
    query 特殊字段:
    以下字段均为特定场景所使用,开发者应避免在query中使用同名字段。
    特殊字段
    含义&使用说明
    ad_params
    平台的广告场景字段。
      如果需要消费该字段,需要对其进行一次 decode 操作。
      由于 ad_params 参数较长,不建议直接把 query 全部透传给服务端接口。
    feed_game_scene
    推荐流直出场景字段。
    feed_game_extra
    推荐流直出场景字段。
    extra 部分返回如下:
    属性名
    类型
    说明
    最低支持版本
    aid
    number
    宿主 id
    2.31.0
    appId
    string
    小游戏 appId。
    2.31.0
    mpVersion
    string
    小游戏的版本信息。
    2.31.0
    launch_from
    string
    启动场景的补充信息,仅当scene=021020时返回,可用于区分微端和桌面快捷方式场景
    miniapk表示微端场景,desktop表示桌面快捷方式进入
    2.56.0

    扫码体验

    代码示例

    var options = tt.getLaunchOptionsSync(); console.log(options);