tt.showFavoriteGuide
收藏我的收藏
收藏基础库 1.41.0 开始支持本方法，这是一个异步方法。
在小游戏内调起关注小游戏的引导组件，用于引导用户关注小游戏。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 展现策略仅在线上版、审核版有效，测试版、预览版不受限制。 |
| 相关教程 | 无 |
语法
tt.showFavoriteGuide(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| content | string | 一键添加到我的小程序 | 否 | 当 type == “tip” 时，可以配置文案，最多显示 12 个字符 | 1.41.0 |
| position | string | bottom | 否 | 弹窗类型为 bar 时的位置参数，可以是 bottom（贴近底部）、overtab（悬于页面 tab 区域上方） | 1.41.0 |
| type | string | 是 | 组件类型：bar（底部弹窗）、tip（顶部气泡）、customize（自定义组件） | 1.41.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.41.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.41.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.41.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| isFavorited | boolean | 返回是否收藏的信息，true：用户已收藏 ； false：用户未收藏 | 2.62.0 |
| errMsg | string | "showFavoriteGuide:ok" | 1.41.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "showFavoriteGuide:fail" + 详细错误信息 | 1.41.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 999993 | internal error | F | 小游戏框架内部错误，有需要请创建工单咨询 | 1.41.0 |
| 999987 | feature is not supported in app isLogin/sessionId | D | 1.41.0 | |
| 999993 | Internal error: common env error | F | 小游戏框架内部错误，有需要请创建工单咨询 | 1.41.0 |
| 999987 | favorites function offline | D | 1.41.0 | |
| 104501 | launch from feed not support favorites tip | D | 1.41.0 | |
| 999999 | unknown `type` | D | 1.41.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.showFavoriteGuide({ type: "customize", success(res) { console.log("isFavorited", res.isFavorited); //此处输出 “isFavorited：true” 代表用户已收藏，若为false代表用户未收藏 }, fail(res) { console.log("自定义弹窗展示失败"); }, }); tt.showFavoriteGuide({ type: "bar", content: "一键添加到我的小程序", position: "bottom", success(res) { console.log("引导组件展示成功"); }, fail(res) { console.log("引导组件展示失败"); }, });
展现形式
目前小游戏收藏引导组件支持以下两种类型，开发者可根据自身业务进行选择：
1. 气泡引导（type = tip）
气泡引导是一种轻量引导组件，它的调用既不会阻塞用户后续行为，也不要求用户一定去响应操作，在一定时间内向用户展现信息，便自动消失。
展现策略：
- •3s 后自动消失，组件箭头指向小程序菜单
- •每位用户最多触达【2 次】，最短间隔【3 天】才能第二次展现
- •若检测到用户已收藏该小程序，则不展示任何引导组件
2. 浮窗引导（type = bar）
浮窗引导的展现力度比气泡引导更强，用户在组件上能进行“添加”操作。
展现策略：
- •10s 后自动消失
- •每位用户最多触达【2 次】，最短间隔【一周】才能第二次展现
- •若检测到用户已收藏该小程序，则不展示任何引导组件
3. 自定义引导（type = customize）
可以在游戏内自行绘制收藏引导入口，在用户点击入口后调用该方法，整体与游戏的契合度更强，并且能根据回调给到对应的用户发放激励奖励，牵引用户的长期留存。
展现策略：
- •每位用户引导弹窗最多出现【3 次】
- •若用户触发方法前已收藏过该游戏，引导弹窗照常展示
