普通小游戏开发
开放能力(必读)
社交转发裂变
数据分析
视频拍摄器
API
多端支持
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.showFavoriteGuide

基础库 1.41.0 开始支持本方法。

在小游戏内调起关注小程序的引导组件,用于引导用户关注小游戏。

语法

tt.showFavoriteGuide(options)

输入

继承标准对象输入,扩展属性描述:

参数说明

options 为 object 类型,属性如下:

属性名

类型

默认值

必填

说明

最低支持版本

type

string

/

组件类型:bar(底部弹窗)、tip(顶部气泡)、customize(自定义组建)

1.41.0

content

string

一键添加到我的小程序

当type==“tip”时,可以配置文案,最多显示 12 个字符

1.41.0

position

string

bottom

弹窗类型为 bar 时的位置参数,可以是 bottom(贴近底部)、overtab(悬于页面 tab 区域上方)

1.41.0

success

Function


接口调用成功后的回调函数,若type==“customize”时,success 回调会返回是否收藏的信息,在 isFavorited 中

1.41.0

fail

Function


接口调用失败后的回调函数

1.41.0

complete

Function


接口调用结束后的回调函数(调用成功、失败都会执行)

1.41.0

回调成功

object 类型,属性如下

属性名

类型

说明

最低支持版本

errMsg

string

"showFavoriteGuide:ok"

1.41.0

isFavorited

bool

当 type == 'customize' 时,success 回调会返回是否收藏的信息,true:用户已收藏 ;  false:用户未收藏

2.62.0

回调失败

object 类型,属性如下

属性名

类型

说明

最低支持版本

errMsg

string

"showFavoriteGuide:fail " + 详细错误信息

1.41.0

展现形式

目前小游戏收藏引导组件支持以下两种类型,开发者可根据自身业务进行选择:

1. 气泡引导(type = tip)

气泡引导是一种轻量引导组件,它的调用既不会阻塞用户后续行为,也不要求用户一定去响应操作,在一定时间内向用户展现信息,便自动消失。

展现策略:

  • 3s 后自动消失,组件箭头指向小程序菜单
  • 每位用户最多触达【2 次】,最短间隔【3 天】才能第二次展现
  • 若检测到用户已收藏该小程序,则不展示任何引导组件

2. 浮窗引导(type = bar)

浮窗引导的展现力度比气泡引导更强,用户在组件上能进行“添加”操作。

展现策略:

  • 10s 后自动消失
  • 每位用户最多触达【2 次】,最短间隔【一周】才能第二次展现
  • 若检测到用户已收藏该小程序,则不展示任何引导组件

3. 自定义引导(type = customize)

可以在游戏内自行绘制收藏引导入口,在用户点击入口后调用该方法,整体与游戏的契合度更强,并且能根据回调给到对应的用户发放激励奖励,牵引用户的长期留存

自定义收藏
**展现策略:**
  • 每位用户引导弹窗最多出现【3 次】
  • 若用户触发方法前已收藏过该游戏,引导弹窗照常展示

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.showFavoriteGuide({
  type: "customize",
  success(res) {
    console.log("isFavorited",res.isFavorited);  //此处输出 “ifFavorited:true” 代表用户已收藏,若为false代表用户未收藏
  },
  fail(res) {
    console.log("自定义弹窗展示失败");
  },
});
tt.showFavoriteGuide({
  type: "bar",
  position: "bottom",
  success(res) {
    console.log("收藏底bar引导组件展示成功");
  },
  fail(res) {
    console.log("收藏底bar引导组件展示失败");
  },
});

Bug & Tip

  • Tip:展现策略仅在线上版、审核版有效,测试版、预览版不受限制。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助