小部件提供了和小程序一致的 API 环境,支持绝大部分小程序的 API,可以帮助小部件开发者在淘宝中开发一个体验优秀的卡片。(说明:本文档适用于小部件3.0)
小部件的 JS API 使用方式和小程序完全一致。
1.小程序环境不支持开发者以 my.call 方式调用 API;
2.如果部分 my.tb.xxx 开头的 API 无法调用成功,请直接使用 my.xxx 的方式 ;
3.API 细节如果和小程序中出现差异,可以提工单给我们。
本文档仅供查阅小部件支持的 API 列表,API 细节可以点击链接查看。
请按照文档使用,平台如有违规使用 API 的情况,会直接下线对应小部件。
此 API 仅有小部件支持。
名称 |
功能说明 |
获取关联小程序信息 |
|
获取关联的小程序ID |
|
小部件跳转到关联小程序 |
|
小部件内部发生错误时,通知投放场景进行降级 |
|
更新小部件跳转到关联小程序所需传递的数据 |
|
获取当前场景信息 |
|
设置小部件手势模式 |
|
打开淘宝官方页 |
名称 |
功能说明 |
监听小部件切前台事件 |
|
监听小部件切后台事件 |
名称 |
功能说明 |
获取历史步数 |
|
获取当天步数 |
|
确认手机是否支持计步 |
|
判断手机健康权限是否申请 |
|
申请步数权限 |
|
设置步数自动上传状态 |
|
获取步数自动上传状态 |
|
申请厂商权限 |
|
检查厂商健康授权状态 |
|
申请sensors权限 |
|
检查sensor权限状态 |
注意,小部件的分享能力仅在用户产生交互行为后才可以触发。
名称 |
功能说明 |
主动弹起分享浮层 |
名称 |
功能说明 |
唤起会员权益领取浮层 |
|
识别当前用户会员身份判定 |
|
查询会员基本信息 |
名称 |
功能说明 |
获取当前位置信息 |
名称 |
功能说明 |
添加对应日程 |
|
异步查询日程是否存在 |
|
取消添加对应日程 |
注意,小部件的授权能力仅在用户产生交互行为后才可以触发。授权后可获取用户信息;
名称 |
功能说明 |
用户授权功能 |
|
获取授权用户信息 |
名称 |
功能说明 |
打开组合购浮层 |
|
收藏商品 |
|
取消收藏商品 |
|
检查商品是否被收藏 |
|
打开商品详情页 |
|
显示指定商品 SKU 选择器 |
|
隐藏正在展示的商品 SKU 选择 |
|
将指定商品加入用户购入车 |
|
打开购物车 |
名称 |
功能说明 |
宝贝查询 |
|
获取店铺活动信息 |
|
获取猜你喜欢商品列表 |
|
店铺新商品智能推荐 |
|
关注店铺 |
|
查询店铺关注状态 |
|
取消关注店铺 |
|
打开收货地址 |
|
打开BC客服聊天 |
名称 |
功能说明 |
打开购物车 |
名称 |
功能说明 |
跳转下单页 |
名称 |
功能说明 |
获取文件信息 |
|
保存文件到本地 |
|
获取保存的文件信息 |
|
获取保存的所有文件信息 |
|
删除某个保存的文件 |
|
获取全局唯一的文件管理器 |
名称 |
功能说明 |
清除本地数据缓存的异步接口 |
|
清除本地数据缓存的同步接口 |
|
获取缓存数据的异步接口 |
|
获取当前 storage 的相关信息的异步接口 |
|
获取当前 storage 相关信息的同步接口 |
|
获取缓存数据的同步接口 |
|
删除缓存数据的异步接口 |
|
删除缓存数据的同步接口 |
|
将数据存储在本地缓存中指定的 key 中的异步接口 |
|
同步将数据存储在本地缓存中指定的 key 中的同步接口 |
名称 |
功能说明 |
上传本地资源到开发者服务器,注意该接口仅支持上传到官方域名,若需要上传其他环境,需要申请白名单 |
|
下载网络资源到本地,注意该接口仅支持从官方域名下载资源,若需要其他环境,需要申请白名单 |
名称 |
功能说明 |
获取手机系统信息的同步接口 |
|
获取手机系统信息 |
|
获取设备性能等级 |
名称 |
功能说明 |
获取当前网络状态 |
名称 |
功能说明 |
摇一摇功能 |
名称 |
功能说明 |
解除设备方向监听 |
|
监听设备方向 |
名称 |
功能说明 |
获取当前服务器时间的毫秒数 |
名称 |
功能说明 |
获取电量的异步接口 |
|
获取电量的同步接口 |
名称 |
功能说明 |
用于获取当前小程序的运行版本 |