开发
API

ShareParam

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

属性类型默认值是否必填说明最低支持版本
channelstring转发内容类型1.0.0
templateIdstring分享素材模板 id,指定通过平台审核的 templateId 来选择分享内容,需在平台设置且通过审核1.0.0
descstring分享文案,不传则默认使用后台配置内容或平台默认。1.0.0
titlestring转发标题,不传则默认使用后台配置或当前小游戏的名称。1.0.0
imageUrlstring转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径,显示图片长宽比推荐 5:41.0.0
querystring查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 tt.getLaunchOptionsSynctt.onShow 获取启动参数中的 query。1.0.0
extraobject附加信息1.0.0
successFunction分享成功后执行的回调函数1.0.0
failFunction分享失败或者用户取消发布器后执行的回调函数1.0.0
completeFunction分享完成(无论成功与否)后执行的回调函数1.0.0

channel

说明
-默认分享方式, channel 为空字符串或者不传(undefined)
article发布图文内容,仅头条 APP 支持
video发布视频内容
token口令分享,生成一串特定的字符串文本,仅头条 APP 支持

注意,如果 ShareOption 中的 channel 不为空,则设置 ShareParam 的 channel 无效。

extra

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

属性类型默认值说明
withVideoIdboolean是否支持跳转到播放页, 以及支持获取视频信息等接口 (为 true 时会在 success 回调中带上 videoId)
videoPathstring视频地址 ,分享一个本地视频
videoTopicsarray视频话题(仅抖音支持) ,目前由 hashtag_list 代替,为保证兼容性,建议同时填写两个。
createChallengebooleanfalse是否分享为挑战视频 ( 仅头条支持 )
video_titlestring""生成输入的默认文案
hashtag_listarrayfalse视频话题(仅抖音支持)
videoTagstring分享视频的标签,可以结合获取抖音视频排行榜使用

分享内容优先级

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

  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。
点击纠错
评价此篇文档