普通小游戏开发
开放能力(必读)
社交转发裂变
数据分析
视频拍摄器
API
多端支持

ShareParam

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

属性

类型

默认值

是否必填

说明

channel

string


转发内容类型

templateId

string


分享素材模板 id,指定通过平台审核的 templateId 来选择分享内容,需在平台设置且通过审核。参考小程序相关说明

desc

string


分享文案,不传则默认使用后台配置内容或游戏简介。

title

string


转发标题,不传则默认使用后台配置或当前小游戏的名称。

imageUrl

string


转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径,显示图片长宽比推荐 5:4,不传则默认使用小游戏icon

query

string


查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 tt.getLaunchOptionsSynctt.onShow 获取启动参数中的 query用来实现信息透传

extra

object


附加信息(仅channel == video时生效)

success

Function


分享成功后执行的回调函数

fail

Function


分享失败或者用户取消发布器后执行的回调函数

complete

Function


分享完成(无论成功与否)后执行的回调函数

channel

说明

-

默认分享方式, channel 为空字符串或者不传

invite

拉起邀请面板分享游戏给好友,仅抖音20.6及以上版本支持

video

发布视频内容

token

口令分享,生成一串特定的字符串文本,仅头条 APP 支持

article

发布图文内容,仅头条 APP 支持

extra

当发布视频内容时(channel 为 video,或者用户通过菜单中的选项选择了视频分享),可以通过 extra 设置附加信息:

属性

类型

默认值

说明

withVideoId

boolean


是否支持跳转到播放页, 以及支持获取视频信息等接口 (为 true 时会在 success 回调中带上 videoId)

videoPath

string


视频地址 ,分享一个本地视频

videoTopics

array


视频话题(仅抖音支持) ,目前由 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 无效的时候是否直接回调失败。

分享内容优先级

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

  1. 代码指定分享内容(title、desc、imageUrl)
  2. 指定审核通过的模板素材 templateId 场景优先级端内分享代码指定分享内容 > 指定模板 > 平台默认端外分享指定模板 > 平台默认

Bug & Tip

  • Tip:端外分享不支持通过代码设置自定义分享内容。
  • Tip:当发布视频内容时,不支持通过 imageUrl 参数设置分享图片。
  • Tip:头条拍视频不支持设置 title 。
  • Tip:只有分享视频内容时,才可以通过 extra 设置附加信息。
  • Tip:videoTopics 即将废弃,应使用 hashtag_list 代替;或者同时设置以保证兼容性。
  • Tip:分享时,在 channel 是 "video"的情况下,如果 videoPath 是不存在会拉起摄像头拍摄界面
  • Tip:如果需要获取视频信息或者跳转视频播放页,以及获取抖音视频排行榜时,需要填写 withVideoId 为 true。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助