SDK对接文档

主题

WARNING

💡 Unity Tiktok小游戏

准备工作： ​

  1. 下载并安装Tiktok插件

导入上方SDK


更新ZMYSDK包管理器到最新

切换TikTok小游戏，并导入小游戏插件




导入配置 ​

WARNING

💡 需要切 WebGL 平台

导入游戏配置 ​




Debug 模式的开启或关闭

发最后一个正式包时，一定要取消 DebugMode

Tiktok平台必须接入功能 ​

WARNING

💡 除了必接功能以外，其他的广告，埋点接入，请参考接口说明

  • 需求细节、交互、以及调试方法参考官方文档: TikTok小游戏一站式接入指南2.0

  • 官方文档为js API，对接Unity TikTok（TikTokFunction）插件后，调用C# 包装后的接口；

  • 复访能力API 必须是tiktok 41.0.0 及以上才能使用，所以调用相关api必须要先使用CanIUseXXXX接口判断，否则会报错；TikTokFunction包装有进行兜底，unity游戏可以直接调用不报错，但是CanIUseXXXX接口可以作为是否开启此复访能力界面交互的依据；比如如果CanXXXX返回false ，添加桌面不可用，不显示交互按钮。

复访能力-添加到桌面 ​

Csharp
//判断添加到桌面接口是否可用； 官方接口TTMinis.game.canIUse("addShortcut")
TIKTOKMsg.Instance.CanIUseAddShortcut()；

//添加到桌面；官方接口 TTMinis.addShortcut
TIKTOKMsg.Instance.AddShortcut(() =>
{
    LogUI.Log("add shortcut success");
}, () =>
{
    LogUI.Log("add shortcut failed");
});

//判断“判读用户是否可以领取添加到桌面奖励”接口是否可用； 官方接口TTMinis.game.canIUse("getShortcutMissionReward")
TIKTOKMsg.Instance.CanIUseGetShortcutMissionReward()；

// 判读用户是否可以领取添加到桌面奖励；官方接口TTMinis.getShortcutMissionReward
TIKTOKMsg.Instance.GetShortcutMissionReward((value) =>
{
    LogUI.Log("GetShortcutMissionReward success : " + value);//value： bool类型
}, () =>
{
    LogUI.Log("GetShortcutMissionReward failed");
});

复访能力-从侧边栏启动 ​

Csharp
//判断跳转到侧边栏界面是否可用； 官方接口TTMinis.game.canIUse("startEntranceMission")
TIKTOKMsg.Instance.CanStartEntranceMission()；

//跳转 Tiktok 个人主页侧边栏，引导复访；官方接口 TTMinis.startEntranceMission
TIKTOKMsg.Instance.StartEntranceMission(() =>
{
    LogUI.Log("StartEntrance success");
}, () =>
{
    LogUI.Log("StartEntrance failed");
});

//判断“判断用户是否可以领取完成复访教育任务奖励”接口是否可用； 官方接口TTMinis.game.canIUse("getEntranceMissionReward")
TIKTOKMsg.Instance.CanGetEntranceMissionReward()；

// 判断用户是否可以领取完成复访教育任务奖励；官方接口TTMinis.getEntranceMissionReward
TIKTOKMsg.Instance.GetEntranceMissionReward((value) =>
{
    LogUI.Log("GetEntranceMissionReward success : " + value);
}, () =>
{
    LogUI.Log("GetEntranceMissionReward failed");
});

功能组件 ​

Tiktok WEBGL 下面的输入 InputField 会失效 ​

可以动态添加组件 XYX.InputFieldAdapter(inputField.gameObject);

构建与调试 ​

构建 ​

Unity 菜单栏选择：TikTokGame => Build Minigame


调试 ​

需要对账号先授权，这里请找我方运营同学授权

官方文档

1. 安装前置依赖 ​

命令行工具

shell

npm install @ttmg/cli -g --registry=https://registry.npmjs.org/

ttmg -v

下载客户端

  • iOS：App Store 下载最新的 TikTok 应用

  • Android：Google Play 下载最新的 TikTok 应用

2. 完成账号登录 ​

登录客户端

使用账号密码登录 TikTok

TT Account oncall自助排查

命令行登录 ​

使用平台注册的账号和密码完成本地 CLI 的登录，非必须，但涉及到代码上传、查看项目详情以及 unity wasm 分包等能力时需要登录后才可进行。为确保后续功能的顺利运行，建议您优先完成账号登录，再进行后续的调试操作。

ttmg login

本地扫码调试


发布 ​

官方文档

上传 .zip 文件。未压缩文件大小不得超过 200 MB。文件上传后，将进行安全扫描。请确保文件符合要求后再上传。



合法域名处理 ​

什么是合法域名 ​

在小程序后台的开发设置中， 有一处配置。合法域名的地方。

其中将域名分为几个大类，我们重点关注 request，socket，download。

request 就是常规的 http 请求，get,post。

socket 请求 webgl 使用 wss 域名

download 就是我们的 cdn 地址。这里有一点需要注意，cdn 地址除了配置到 download 中，还需要配置到 request 中

为什么要配置这个 ​

小游戏严格限制了请求的地址信息，只有配置上的地址 才能成功的进行访问。所有的配置的域名都是要求经过备案的，否则无法配置。

哪些需要配置 ​

联系对应得运营，在后台进行添加：

所有的 域名 不带端口的 配置到域名级，带端口的请求需要带上端口，举个例子

C#
原始  https://log.328vip.com/stat/index/initV2
配置  https://log.328vip.com

带端口的
原始  https://pay.wedobest.com.cn:8449/xxx/bbb/ccc
配置  https://pay.wedobest.com.cn:8449

Tiktok QA ​

点我快速对接
›