文档中心 > 店铺动态卡片-开发指引

小部件提供了和小程序一致的 API 环境,支持绝大部分小程序的 API,可以帮助小部件开发者在淘宝中开发一个体验优秀的卡片。(说明:本文档适用于小部件3.0


一、使用方式


小部件的 JS API 使用方式和小程序完全一致。


二、注意事项


1.小程序环境不支持开发者以 my.call 方式调用 API;

2.如果部分 my.tb.xxx 开头的 API 无法调用成功,请直接使用 my.xxx 的方式 ;

3.API 细节如果和小程序中出现差异,可以提工单给我们。


本文档仅供查阅小部件支持的 API 列表,API 细节可以点击链接查看。

请按照文档使用,平台如有违规使用 API 的情况,会直接下线对应小部件。


三、特有API


此 API 仅有小部件支持。


名称

功能说明

my.getRelationAppInfo

获取关联小程序信息

my.getRelationAppId

获取关联的小程序ID

my.navigateToRelationMiniProgram

小部件跳转到关联小程序

my.widgetDowngrade

小部件内部发生错误时,通知投放场景进行降级

my.updateNavigateParams

更新小部件跳转到关联小程序所需传递的数据

my.getSceneInfo

获取当前场景信息

my.setGestureMode

设置小部件手势模式

my.navigateToTaobaoPage

打开淘宝官方页


四、生命周期


名称

功能说明

my.onAppShow

监听小部件切前台事件

my.onAppHide

监听小部件切后台事件


五、运动计步


名称

功能说明

my.tb.getStepsHistory

获取历史步数

my.tb.getDailySteps

获取当天步数

my.tb.supportStepCount

确认手机是否支持计步

my.tb.stepsAuthorizeStatus

判断手机健康权限是否申请

my.tb.requestStepsAuthorization

申请步数权限

my.tb.setStepCountStatus

设置步数自动上传状态

my.tb.getStepsStatus

获取步数自动上传状态

my.tb.requestManufacturerPermission

申请厂商权限

my.tb.checkManufacturerPermission

检查厂商健康授权状态

my.tb.requestSensorPermission

申请sensors权限

my.tb.checkSensorPermission

检查sensor权限状态


六、分享


注意,小部件的分享能力仅在用户产生交互行为后才可以触发。


名称

功能说明

my.showSharePanel

主动弹起分享浮层


七、会员


名称

功能说明

my.tb.detailMember

唤起会员权益领取浮层

my.tb.memberJudge

识别当前用户会员身份判定

my.tb.memberBaseinfo

查询会员基本信息


八、位置


名称

功能说明

my.getLocation

获取当前位置信息


九、日历


名称

功能说明

my.tb.addCalendarPlan

添加对应日程

my.tb.checkCalendarPlanIsExist

异步查询日程是否存在

my.tb.cancelCalendarPlan

取消添加对应日程


十、用户授权


注意,小部件的授权能力仅在用户产生交互行为后才可以触发。授权后可获取用户信息;


名称

功能说明

my.authorize

用户授权功能

my.getAuthUserInfo

获取授权用户信息


十一、商品&SKU


名称

功能说明

my.tb.openScuCombination

打开组合购浮层

my.tb.collectGoods

收藏商品

my.tb.unCollectGoods

取消收藏商品

my.tb.checkGoodsCollectedStatus

检查商品是否被收藏

my.tb.openDetail

打开商品详情页

my.tb.showSku

显示指定商品 SKU 选择器

my.tb.hideSku

隐藏正在展示的商品 SKU 选择

my.addToCart

将指定商品加入用户购入车

my.tb.openCart

打开购物车


十二、店铺


名称

功能说明

my.tb.shopGetItem

宝贝查询

my.tb.shopGetActivity

获取店铺活动信息

my.tb.shopGetRecommond

获取猜你喜欢商品列表

my.tb.shopGetItemRecommend

店铺新商品智能推荐

my.tb.favorShop

关注店铺

my.tb.checkShopFavoredStatus

查询店铺关注状态

my.tb.unFavorShop

取消关注店铺

my.tb.chooseAddress

打开收货地址

my.tb.openMessage

打开BC客服聊天


十三、购物车


名称

功能说明

my.tb.openCart

打开购物车


十四、订单


名称

功能说明

my.tb.confirmCustomOrder

跳转下单页


十五、文件


名称

功能说明

my.getFileInfo

获取文件信息

my.saveFile

保存文件到本地

my.getSavedFileInfo

获取保存的文件信息

my.getSavedFileList

获取保存的所有文件信息

my.removeSavedFile

删除某个保存的文件

my.getFileSystemManager

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


十六、缓存


名称

功能说明

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.uploadFile

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

my.downloadFile

下载网络资源到本地,注意该接口仅支持从官方域名下载资源,若需要其他环境,需要申请白名单


十八、设备

1.系统信息


名称

功能说明

my.getSystemInfoSync

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

my.getSystemInfo

获取手机系统信息

my.tb.getHADeviceInfo

获取设备性能等级


2.网络状态


名称

功能说明

my.getNetworkType

获取当前网络状态


3.摇一摇


名称

功能说明

my.watchShake

摇一摇功能


4.设备方向


名称

功能说明

my.offDeviceMotionChange

解除设备方向监听

my.onDeviceMotionChange

监听设备方向


5.获取服务器时间


名称

功能说明

my.getServerTime

获取当前服务器时间的毫秒数


6.获取设备电量


名称

功能说明

my.getBatteryInfo

获取电量的异步接口

my.getBatteryInfoSync

获取电量的同步接口


7.小程序当前运行版本类型


名称

功能说明

my.getRunScene

用于获取当前小程序的运行版本


FAQ

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