小游戏 API 总览

更新时间:2025/03/25 访问次数:13575

基础

系统

名称

功能说明

my.getSystemInfoSync

获取手机系统信息(同步接口)

my.getSystemInfo

获取手机系统信息(异步接口)

my.getWindowInfo

获取窗口信息(异步接口)

my.getWindowInfoSync

获取窗口信息(同步接口)

my.getSystemSetting

获取系统设置信息(异步接口)

my.getSystemSettingSync

获取系统设置信息(同步接口)

my.getDeviceInfo

获取设备信息(异步接口)

my.getDeviceInfoSync

获取设备信息(同步接口)

my.getAppBaseInfo

获取宿主 APP (如:淘宝)信息(异步接口)

my.getAppBaseInfoSync

获取宿主 APP (如:淘宝)信息(同步接口)

my.onWindowResize / my.offWindowResize

监听窗口尺寸变化

性能

名称

功能说明

my.setPreferredFramesPerSecond

设置渲染帧率(默认为 60 帧)

my.triggerGC

加快触发 GC

生命周期

名称

功能说明

my.onShow / my.offShow

监听切换到前台事件

my.onHide / my.offHide

监听切换到后台事件

互动插件

名称

功能说明

shareApp

拉起淘宝分享组件

reportExposure reportClick

关键行为上报

getChannelTag

获取用户访问渠道

getSystemInfo

获取手淘版本

getUserGroupTypes

获得人群类型与用户是否安全判断

navigateLimitUrl

跳转到白名单地址

addParamsToUrl

将自定义参数添加到游戏链接

reportScene

游戏场景上报

跳转

名称

功能说明

my.exit

退出当前小游戏

触摸/手势

名称

功能说明

my.onTouchStart / my.offTouchStart

监听触摸事件

my.onTouchMove / my.offTouchMove

my.onTouchEnd / my.offTouchEnd

my.onTouchCancel / my.offTouchCancel

数据缓存

名称

功能说明

my.clearStorage

清除本地数据缓存的异步接口

my.clearStorageSync

清除本地数据缓存的同步接口

my.getStorage

获取缓存数据的异步接口

my.getStorageInfo

获取当前 storage 的相关信息的异步接口

my.getStorageInfoSync

获取当前 storage 相关信息的同步接口

my.getStorageSync

获取缓存数据的同步接口

my.removeStorage

删除缓存数据的异步接口

my.removeStorageSync

删除缓存数据的同步接口

my.setStorage

将数据存储在本地缓存中指定的 key 中的异步接口

my.setStorageSync

同步将数据存储在本地缓存中指定的 key 中的同步接口

渲染

名称

功能说明

my.createCanvasContext

创建 canvas 绘图上下文(第一次调用createCanvas 创建在屏 canvas,第二次调用会创建离屏 canvas

图片

名称

功能说明

CanvasContext.createImage

加载图片,参考小程序 Canvas 文档 中“加载图片”

my.getImageInfo

获取图片信息

my.saveImage

保存图片到本地

音频

名称

功能说明

my.createInnerAudioContext

淘宝开放平台音频能力使用规范(一定要看)文档

文件

名称

功能说明

my.getFileInfo

获取文件信息

my.saveFile

保存文件到本地

my.getSavedFileInfo

获取保存的文件信息

my.getSavedFileList

获取保存的所有文件信息

my.removeSavedFile

删除某个保存的文件

my.getFileSystemManager

获取全局唯一的文件管理器

FileSystemManager.getFileInfoSync

获取文件信息

FileSystemManager.getFileInfo

获取文件信息

FileSystemManager.unzip

解压文件

FileSystemManager.copyFile

复制文件

FileSystemManager.copyFileSync

复制文件 同步接口

FileSystemManager.mkdir

创建目录

FileSystemManager.mkdirSync

创建目录 同步接口

FileSystemManager.readdir

异步读取文件目录内的文件列表

FileSystemManager.readdirSync

同步读取小程序文件夹

FileSystemManager.readFile

读取本地文件内容

FileSystemManager.readFileSync

同步读取本地文件内容

FileSystemManager.unlink

删除文件

FileSystemManager.unlinkSync

删除文件 同步接口

FileSystemManager.writeFile

写文件

FileSystemManager.writeFileSync

写文件 同步接口

设备

名称

功能说明

my.vibrate

调用振动功能

my.vibrateShort

较短时间的振动 (40ms)

my.vibrateLong

较长时间的振动 (400ms)

my.getScreenBrightness

获取屏幕亮度

my.setScreenBrightness

设置屏幕亮度

my.setKeepScreenOn

设置屏幕常亮

my.setClipboard

设置剪贴板数据

my.getClipboard

获取剪贴板数据

my.onAccelerometerChange

监听加速度数据

my.offAccelerometerChange

停止监听加速度数据

网络

名称

功能说明

my.downloadFile

下载文件

my.getNetworkType

获取当前网络状态

my.onNetworkStatusChange

开始网络状态变化的监听

my.offNetworkStatusChange

取消网络状态变化的监听

my.uploadFile

上传本地资源到开发者服务器,注意该接口仅支持上传到官方域名,若需要上传其他环境,需要申请白名单

Websocket

名称

功能说明

my.connectSocket

创建一个 Websocket 连接

授权

名称

功能说明

my.getSetting

获取用户的当前的权限设置

my.openSetting

打开小程序权限设置界面,返回用户权限设置的结果

my.showAuthGuide

显示系统权限引导界面

my.authorize

获取用户授权

my.getAuthUserInfo

获取授权用户信息

数据分析

名称

功能说明

my.reportAnalytics

自定义分析数据的上报接口

交互

名称

功能说明

my.prompt

弹出一个对话框,让用户在对话框内输入文本

toastShow

显示 Toast/消息提示

my.alert

警告框

my.tb.enableSwipeBack

是否允许容器右划退出

虚拟充值

名称

功能说明

my.tb.virtualTrade

虚拟商品充值

taobao.game.charge.zc.query

订单查询接口

taobao.game.charge.zc.order

订单充值接口

taobao.game.charge.zc.cancel

订单取消接口

常见问题

Q:调用my.tb.request报错,怎么处理?

A:小游戏不支持my.tb.request接口,请使用空应用的cloud.application.httpRequest进行http请求。

其他问题

开放平台相关问题或任何产品体验问题,可先找 @由幽 @婉清。

IDE&构建&编译:@珏羽。

API&客户端&渲染&调试能力:@向屿。

开发者控制台&能力申请&权限问题:@晗若。

FAQ

关于此文档暂时还没有FAQ
返回
顶部