体验抖音小游戏

游戏引擎

Unity 引擎适配

WebGL 方案与优化

BGDT 手册

接入

C# API

API 概览

开放能力

基础

设备

文件

媒体

网络

游戏分享

分享模块

数据缓存

系统

界面

支付

宿主事件

抖音云模块

邀请模块

PlayerPrefs

调试工具

初始化

渲染

Cocos/Laya/Egret引擎适配

基础功能

开放能力

性能优化

分享模块
收藏
我的收藏

开发者可以在小游戏中分享内容到抖音等平台。

注意：

该模块对应分享

TT.ShareAppMessage

6.0.0 开始支持本方法

通用分享能力。

前提条件	无
业务背景	无
使用限制	无
注意事项	•参数 shareJson 是一个 json 对象 •生成的分享链接有效期为 45 天，过期后链接失效 •报错返回 "get shareInfo return null" 时为获取分享信息失败，可能为获取分享信息时网络请求超时，或者是当前 appID 的分享状态异常，比如被封禁导致，可以检查站内信或通过运营群进行反馈（接入指南 -联系我们）
相关教程	无

语法

public static void ShareAppMessage(JsonData shareJson,
    TTShare.OnShareSuccessCallback successCallback = null,
    TTShare.OnShareFailedCallback failedCallback = null,
    TTShare.OnShareCancelledCallback cancelledCallback = null)

参数说明

属性名	类型	默认值	必填	说明
shareJson	JsonData	--	是	内容填充参考 tt.shareAppMessage_小游戏_抖音开放平台
successCallback	Dictionary<String, Object>	null	否	分享成功回调
failedCallback	string errMsg	null	否	分享失败回调参数 string： errMsg 错误描述
cancelledCallback	void	null	否	取消分享回调

代码示例

public void TestShare()
{
    // 通用分享
    JsonData shareJson = new JsonData();
    shareJson["channel"] = "video";
    shareJson["title"] = "Some Title";
    shareJson["extra"] = new JsonData();
    shareJson["extra"]["videoPath"] = "/xxx/xxx.mp4";//录屏分享的话，路径是 OnRecordComplete 拿到的路径
    JsonData videoTopics = new JsonData();
    videoTopics.SetJsonType(JsonType.Array);
    videoTopics.Add("Some Topic1");
    videoTopics.Add("Some Topic2");
    shareJson["extra"]["videoTopics"] = videoTopics;
    shareJson["extra"]["hashtag_list"] = videoTopics;
    
    Debug.Log($"ShareAppMessageBtnClicked jsonData: {jsonData.ToJson()}");
    TT.ShareAppMessage(jsonData,(data) =>
        {
            Debug.Log($"ShareAppMessage success: {data.ToJson()}");
        },
        (errMsg) =>
        {
            Debug.Log($"ShareAppMessage failed: {errMsg}");
        },
        () =>
        {
            Debug.Log($"ShareAppMessage cancel");
        });
}

TT.OnShareAppMessage

6.0.0 开始支持本方法

监听用户点击右上角菜单中“转发”、“拍抖音”按钮时触发事件。

前提条件	无
业务背景	无
使用限制	无
注意事项	•该方法可以监听用户通过右上角菜单中触发的分享操作，在不同宿主端具体的操作会有所差别，在抖音中包括分享和拍抖音，在头条包括分享和发头条，以此类推。 •该方法的实际调用链路为： a.开发者注册此事件 a.用户点击小游戏菜单中的分享或者拍抖音等按钮 a.自动调用开发者通过 TT.OnShareAppMessage 定义的函数，并传入带有 channel 参数的对象，执行得到该函数的返回对象 a.接着调用 TT.ShareAppMessage ，将上一步返回的对象传入其中，拉起分享 •当开发者发现虽然已成功配置分享内容，但是调试时内容无法生效时，有可能是分享内容触发了内容安全检测失败，导致分享失败。发生这种情况时，开发者可以尝试对分享内容进行内容安全检测，具体操作手段见内容安全检测
相关教程	无

语法

public static void OnShareAppMessage(TTShare.OnshareAppMessageCallback callback = null)

参数说明

参数说明类 ShareOption。

属性名	类型	默认值	必填	说明
webViewUrl	string	--	是	分享内容 url
channel	string	--	是	分享渠道

返回说明

返回说明类 ShareParam。

属性名	类型	默认值	必填	说明
shareJson	JsonData	--	是	分享内容
successCallback	OnShareSuccessCallback	--	是	分享成功返回
failedCallback	OnShareFailedCallback	--	是	分享失败返回
cancelledCallback	OnShareCancelledCallback	--	是	分享取消返回

代码示例

public void TestShare()
{
    // 通用分享
    TT.OnShareAppMessage((res) =>
    {
        var channel = res.channel;
        if (channel == "video")
        {
            JsonData json = new JsonData();
            json["title"] = "分享标题";
            json["channel"] = "video";
            JsonData topic = new JsonData();
            topic.Add("test1 videoTopics");
            topic.Add("test2 videoTopics");
            JsonData extra = new JsonData();
            extra["videoTopics"] = topic;
            json["extra"] = extra;

            AndroidUIManager.ShowToast(json.ToJson());
            return new TTShare.ShareParam(
                json,
                (data) => { Debug.Log("分享成功"); },
                (msg) => { Debug.Log("分享失败" + msg); },
                () => { Debug.Log("取消分享"); }
            );
        }
    });
}

TT.OffShareAppMessage

6.0.0 开始支持本方法

取消监听用户点击右上角菜单中“转发”、“拍抖音”按钮时出发事件。

前提条件	无
业务背景	无
使用限制	无
注意事项	无
相关教程	无

语法

public static void OnShareAppMessage(TTShare.OnshareAppMessageCallback callback = null)

代码示例

public void TestShare()
{
    // 注销 OnShareAppMessage 回调
    TT.OffShareAppMessage((res) => null);
}

TT.ShareMessageToFriend

6.0.0 开始支持本方法

给指定好友分享游戏信息。

前提条件	无
业务背景	无
使用限制	目前仅支持抖音、抖音极速版 APP
注意事项	•注意游戏场景，不要过度频繁引导分享：定向分享需要与游戏场景强相关，建议结合游戏内的好友系统、互动系统，会起到事半功倍的效果 •配合“邀请有奖”或“礼物赠送”等功能模式，可以更大程度激发用户的分享意愿（具体实现：通过定向分享能力，入参中传入分享者的 openid（query 字段），并结合 TT.GetLaunchOptionsSync 或 TT.OnShow 获取启动参数中的 query 来判断是否通过分享链接启动的，并给分享人发放对应的奖励）
相关教程	无

语法

public static void ShareMessageToFriend(JsonData options,
    TTShare.OnShareSuccessCallback successCallback = null,
    TTShare.OnShareFailedCallback failedCallback = null,
    TTShare.OnShareCancelledCallback cancelledCallback = null)

参数说明

属性名	类型	默认值	必填	说明
options	JsonData	--	是	内容填充参考 tt.shareMessageToFriend__抖音开放平台
successCallback	Dictionary<String, Object>	null	否	分享成功回调
failedCallback	string errMsg	null	否	分享失败回调参数 string： errMsg 错误描述
cancelledCallback	void	null	否	取消分享回调

代码示例

public void TestShare()
{
    var jsonData = new JsonData
    {
        ["openId"] = openIdField.text ?? "",
        ["templateId"] = templateIdField.text ?? "",
        ["query"] = queryField.text ?? ""
    };
    Debug.Log($"ShareMessageToFriendBtnClicked jsonData: {jsonData.ToJson()}");
    
    TT.ShareMessageToFriend(jsonData,
        (data) =>
        {
            Debug.Log($"ShareMessageToFriend success: {data.ToJson()}");
        },
        (errMsg) =>
        {
            Debug.Log($"ShareMessageToFriend failed: {errMsg}");
        },
        () =>
        {
            Debug.Log($"ShareMessageToFriend cancel");
        }); 
}

TT.ShowShareMenu

6.0.0 开始支持本方法

显示当前小游戏页面的转发按钮。转发按钮位于小游戏页面右上角的“更多”中。

前提条件	无
业务背景	无
使用限制	无
注意事项	无论调用本 API 前当前页面是否显示转发按钮，调用本 API 均会执行成功回调
相关教程	无

语法

public static void ShowShareMenu(
    TTShare.OnShowShareMenuSuccessCallback successCallback = null,
    TTShare.OnShowShareMenuFailCallback failCallback = null,
    TTShare.OnShowShareMenuCompleteCallback completeCallback = null)

参数说明

属性名	类型	默认值	必填	说明
successCallback	Dictionary<String, Object>	null	否	成功回调
failedCallback	string errMsg	null	否	失败回调参数 string： errMsg 错误描述
completeCallback	void	null	否	完成回调

代码示例

public void TestShare()
{
    TT.ShowShareMenu();
}

TT.HideShareMenu

6.0.0 开始支持本方法

隐藏转发按钮。

前提条件	无
业务背景	无
使用限制	无
注意事项	无论调用本 API 前当前页面是否显示转发按钮，调用本 API 均会执行成功回调
相关教程	无

语法

public static void HideShareMenu(
    TTShare.OnHideShareMenuSuccessCallback successCallback = null,
    TTShare.OnHideShareMenuFailCallback failedCallback = null,
    TTShare.OnHideShareMenuCompleteCallback completeCallback = null)

参数说明

属性名	类型	默认值	必填	说明
successCallback	void	null	否	成功回调
failedCallback	void	null	否	失败回调
completeCallback	void	null	否	完成回调

代码示例

public void TestShare()
{
    TT.ShowShareMenu();
}

分享模块收藏我的收藏

TT.ShareAppMessage

语法

参数说明

代码示例

TT.OnShareAppMessage

语法

参数说明

返回说明

代码示例

TT.OffShareAppMessage

语法

代码示例

TT.ShareMessageToFriend

语法

参数说明

代码示例

TT.ShowShareMenu

语法

参数说明

代码示例

TT.HideShareMenu

语法

参数说明

代码示例

分享模块
收藏
我的收藏