抖音开放平台Logo
开发者文档
控制台

内容转发分享

收藏
我的收藏
小游戏支持转发链接、图文、游戏视频和分享口令等不同形式的内容,主流的分享类型可点击分享说明查看。​

一、获取分享素材 ID​

开发者可以提前通过开发者后台配置分享图片、标题、文案,并由平台进行审核。审核通过的素材会生成对应的 templateId,给到开发者调用。​
审核通过的分享内容,在线上的转发行为依然会受平台监管,请开发者遵守运营规范相关要求。
获取路径:开发者平台 -> 选择对应小游戏 -> 运营 ->运营能力 -> 分享设置 -> 新建分享 ->获取分享ID​

二、分享内容定义​

分享内容
字段
名称
使用建议
内容定义
最低版本
分享标题
title
分享标题
不超过 14 个中文字符
一句话介绍小游戏
分享图片
imageUrl
分享图片
图片规格:适应各场景
突出小游戏特点的图片,能够配合文案。
分享文案
desc
分享文案
不超过 28 个中文字符
结合游戏特征、分享场景,以玩家口吻邀请好友加入游戏。
1.30.0.1

三、各宿主建议长度​

字段
头条
抖音
title
14 个汉字以内
8 个汉字以内
desc
28 个汉字以内
14 个汉字以内

四、分享内容指定方式​

平台支持不同形式来指定转发的内容(图片、标题、文案),最终按照优先级规则进行选择​
    1.代码指定分享内容(title、desc、imageUrl)​
    2.代码指定审核通过的模板素材 templateId​

五、分享内容优先级​

场景
优先级
端内分享
代码指定 > 模板指定 > 平台默认
端外分享
模板指定 > 平台默认

六、使用场景介绍​

社交好友邀请(channel == invite)​

支持抖音/抖lite当传入的 channel 为 invite 时,触发后会拉起好友邀请面板,经验证,整体的分享成功率在 75%左右,具体数值视开发者如何将其与游戏相结合,但整体效果优于传统的常规分享, 具体开发方式请点击转发分享 API。​
好友邀请组件核心功能如下:
社交关系分组清晰:「双关好友、我的粉丝、我的关注」,双关好友排序靠前,分享成功率更高,清晰的社交关系分组更有利于用户进行社交分享。​
在线状态实时展示:使用「小绿点」标记在线状态,对于社交类游戏而言,方便用户快速识别在线用户,邀请一起玩游戏;对于「分享有奖」之类的游戏内社交裂变功能,在线状态也更容易让用户筛选目标分享用户。​
多人分享:玩家可以在面板上点击多个按钮进行多次分享,效率更高,更有利于游戏的分享裂变,同时也支持分享到群聊和搜索定向分享。​
消息触达:被分享的用户会收到 IM 私信卡片,如果是在线用户,会在屏幕上方出现「强提醒的 push」。​
回调信息:游戏内可以基于分享回调(success / cancel),给用户发放激励(如邀请好友有奖)。​

常规分享​

默认分享方式,channel 为空字符串或者不传,即通过抖音的好友分享面板,分享成功后在 IM 聊天界面出现游戏卡片, 具体开发方式请点击转发分享 API。​

定向分享​

平台提供了通用分享面板,通过拉取面板让用户选择要分享给哪些好友,但它的场景适用于全局分享,但对于用户游戏内向指定好友发起分享,不完全适用,如下方展示:​
场景
具体实现
A 的得分超过了B,直接向 B 炫耀成绩超越​
通过定向分享能力完成​
A 向 B 分享 索要皮肤道具,B进入游戏给 A 赠送 皮肤道具​
通过定向分享能力完成​
A 向 C 分享 邀请加入游戏。C 进入游戏后,A 金币+1,C 金币+1​
通过定向分享能力,传入分享者的openid(query字段),并结合 tt.getLaunchOptionsSynctt.onShow 获取启动参数中的 query​
平台开发了一个通用组件,通过几行代码,即可实现游戏内的定向分享到用户的私信中,快速助力开发者丰富游戏功能,实现流量裂变​

录屏视频分享(channel == video)​

录屏分享,通过发布器将视频分享到社区,带上视频锚点,用户消费后可以点击启动,开发者使用录屏分享时,如果未使用剪映模版和录屏配音(defaultBgm 字段) 能力时,将触发一键分享逻辑,将会弹出一键分享弹框, 具体开发方式请点击转发分享 API。​

七、游戏内接入转发能力​

通过 tt.shareAppMessage 转发图文、视频和口令等不同形式的内容,具体用法参考 API 文档。​
使用审核通过的分享素材,指定 templateID。​
代码示例
// 以默认链接分享方式为例 tt.shareAppMessage({ templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID query: "", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败"); }, });

八、代码指定分享内容​

代码示例
说明
代码指定分享内容也可以同时指定素材 templateID, 平台会按照优先级规则选定分享内容。​
// 以默认链接分享方式为例 tt.shareAppMessage({ templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID query: "", title: "画家活下去", desc: "在这里爱上画画", imageUrl: "", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败"); }, });

九、链接分享​

代码示例
// 以默认链接分享形式为例 tt.shareAppMessage({ templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID query: "", title: "画家活下去", desc: "在这里爱上画画", imageUrl: "", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败"); }, });

十、图文分享​

注意
抖音不支持图文分享。
代码示例
// 以图文分享为例 tt.shareAppMessage({ channel: "article", templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID query: "", title: "画家活下去", desc: "在这里爱上画画", imageUrl: "", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败"); }, });

十一、游戏录屏分享​

代码示例
// 视频分享 tt.shareAppMessage({ channel: "video", query: "", templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID title: "画家活下去", desc: "在这里爱上画画", extra: { videoPath: "ttfile://temp/test.mp4", // 可用录屏得到的本地文件路径 videoTopics: ["画家活下去"], }, success() { console.log("分享视频成功"); }, fail(e) { console.log("分享视频失败"); }, });

十二、口令分享​

代码示例
tt.shareAppMessage({ channel: "token", // 口令分享 templateId: "1fidnqkeari9dnd18o", // 替换成通过审核的分享ID title: "画家活下去", desc: "在这里爱上画画", query: "", success() { console.log("分享成功"); }, fail(e) { console.log("分享失败"); }, });