ShareParam
收藏
我的收藏

开发者最终传递给发布器的数据，可以根据约定传入部分自定义数据。属性如下：

属性	类型	默认值	是否必填	说明
channel	string		否	转发内容类型
templateId	string		否	•分享素材模板 id，指定通过平台审核的 templateId 来选择分享内容，需在平台设置且通过审核。参考拍摄视频并发布至抖音 •如有个性化分享诉求，请在对应场景的调用点传入对应的templateId
desc	string		否	分享文案，不传则默认使用后台配置内容或游戏简介
title	string		否	转发标题，不传则默认使用后台配置或当前小游戏的名称
imageUrl	string		否	•转发显示图片的链接，支持本地沙盒目录（`ttfile://`）或相对代码包根目录的图片路径，不支持网络图片路径。 •显示图片长宽比推荐 5:4，不传或使用网络图片路径则默认使用小游戏icon •当`channel = video \| picture`时，该字段不生效 •抖音、抖音极速版、抖音火山版 30.9.0 版本起该参数失效。平台将使用「开发者后台-运营能力-必接能力-分享配置」的配置图片自动替代，若无，将使用平台兜底图片自动替代
query	string		否	查询字符串，必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后，可通过 tt.getLaunchOptionsSync 或 tt.onShow 获取启动参数中的 query用来实现信息透传
extra	object		否	附加信息（仅`channel == video \| picture`或为空字符串/不传时生效）
success	Function		否	分享成功后执行的回调函数
fail	Function		否	分享失败或者用户取消发布器后执行的回调函数
complete	Function		否	分享完成（无论成功与否）后执行的回调函数

channel

值	说明	支持环境
-	默认分享方式, channel 为空字符串或者不传	通用
invite	拉起邀请面板分享游戏给好友	仅抖音 20.6 及以上版本
video	发布视频内容	通用
token	口令分享，生成一串特定的字符串文本	仅头条
article	发布图文内容	仅头条
picture	发布图文内容，内容由接口参数直接传入	仅抖音、抖音极速版、抖音火山版 25.9 及以上版本

extra

channel = video 时，可以通过 extra 设置以下附加信息：

属性	类型	默认值	说明
withVideoId	boolean		是否支持跳转到播放页，以及支持获取视频信息等接口（为 true 时会在 success 回调中带上 videoId）
videoPath	string		视频地址，分享一个本地视频。如果 videoPath 不传入会拉起摄像头拍摄界面
videoTopics	array		视频话题(仅抖音支持) ，目前由 hashtag_list 代替即将废弃，为保证兼容性，建议同时设置hashtag_list
createChallenge	boolean	false	是否分享为挑战视频 ( 仅头条支持 )
video_title	string	""	生成输入的默认文案
hashtag_list	array		视频话题，字符串中间包含空格会取第一个空格前内容作为话题(仅抖音支持)
videoTag	string		分享视频的标签
defaultBgm	string		抖音 pgc 音乐的短链(仅抖音支持，需要基础库版本大于 1.90) 。形如https://v.douyin.com/JmcxWo8/，参考抖音小游戏录屏带配乐能力
cutTemplateId	string		抖音上可用的剪映模板 ID，参考录屏添加剪映视频模板能力
abortWhenCutTemplateUnavailable	booelan	false	剪映模板不可用或者剪映模板 ID 无效的时候是否直接回调失败

channel = picture 时，可以通过 extra 设置以下附加信息：

属性	类型	默认值	必填	说明
picturePath	string[]		否	发布的图片地址，仅支持本地图片路径（即游戏包内路径和`ttfile://`路径） channel=picture时，本参数必传。
contentTitle	string		否	作品标题
contentDescription	string		否	作品描述信息
hashtag_list	array		否	视频话题，字符串中间包含空格会取第一个空格前内容作为话题

channel 为空字符串或不传 时，可以通过 extra 设置以下附加信息：

属性	类型	默认值	必填	说明
useTeamInvitationStyle	boolean	false	否	标识该消息为动态消息
activityId	string		否	动态消息的唯一标识，通过createActivityId获取，`useTeamInvitationStyle`为`true`时必填
templateInfo	array		否	动态消息的模板信息，Array<TemplateInfo>类型，`useTeamInvitationStyle`为`true`时必填
versionType	string	current	否	指定通过动态消息进入的小游戏版本：线上版`current`、测试版`latest`

TemplateInfo类型说明

object 类型，属性如下：

属性	类型	默认值	必填	说明
name	string		是	参数名
value	string		是	参数值

分享内容优先级

支持两种形式来指定转发的内容（图片、标题、文案），最终按照优先级规则进行选择，详情参考内容转发

代码指定分享内容（title、desc、imageUrl）

指定审核通过的模板素材 templateId 场景优先级端内分享代码指定分享内容 > 指定模板 > 平台默认端外分享指定模板 > 平台默认

Bug & Tip

•

Tip：端外分享不支持通过代码设置自定义分享内容。

•

Tip：如果需要获取视频信息或者跳转视频播放页，以及获取抖音视频排行榜时，需要填写 withVideoId 为 true。

•

Tip：头条拍视频不支持设置 title 。