版本：v4

Unity SDK 开发指南

本文介绍如何在游戏中接入 TapTap 内嵌动态功能，使用内嵌动态功能需依赖 TapTap 登录。

集成前准备

参考开发者中心配置创建应用、配置包名与签名证书
参考 Unity 集成指南完成基础接入
内嵌动态依赖于 TapTap 登录模块，开发者接入前应先完成 TapTap 登录的接入

权限说明

Android 权限说明

该模块在 Android 平台需要如下权限：

权限	使用目的	权限申请时机
网络权限	用于访问网络数据	用户首次使用该功能时会申请权限
获取网络状态	用于检测当前网络连接是否有效	用户首次使用该功能时会申请权限
读写存储权限	用于发布或下载动态页面内图片、视频	下载或使用本地图片发布动态时申请

该模块将在 Android 应用中添加如下权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"
  tools:ignore="ScopedStorage" />
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

iOS 权限说明

该模块在 iOS 平台需要如下权限：

权限	使用目的	权限申请时机
相册权限	获取相册中图片或保存网络图片到相册中	用户首次使用该功能时会申请权限
相机权限	用于拍照或录视频	用户首次使用该功能时会申请权限
麦克风权限	用于录视频时获取声音	用户首次使用该功能时会申请权限

在 Assets/Plugins/iOS/Resource 目录下创建 TDS-Info.plist 文件（如果已创建，只需添加内容即可），配置相关权限并替换授权文案：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>NSPhotoLibraryUsageDescription</key>
    <string>说明为何应用需要此项权限</string>
    <key>NSCameraUsageDescription</key>
    <string>说明为何应用需要此项权限</string>
    <key>NSMicrophoneUsageDescription</key>
    <string>说明为何应用需要此项权限</string>
</dict>
</plist>

SDK 获取

远程依赖

NPMJS 方式：在 Packages/manifest.json 中添加：

"dependencies":{
  "com.taptap.sdk.core":"4.11.1",
  "com.taptap.sdk.login":"4.11.1",
  "com.taptap.sdk.moment":"4.11.1"
}

GitHub 方式：在 Packages/manifest.json 中添加：

"dependencies":{
  "com.taptap.sdk.core":"https://github.com/taptap/tapsdk-unity-dist.git?path=/Core#4.11.1",
  "com.taptap.sdk.login":"https://github.com/taptap/tapsdk-unity-dist.git?path=/Login#4.11.1",
  "com.taptap.sdk.moment":"https://github.com/taptap/tapsdk-unity-dist.git?path=/Moment#4.11.1"
}

本地文件导入

在下载页下载并导入以下 unitypackage 文件：

TapSDK_Core.unitypackage (TapTapSDK 核心模块，必选)
TapSDK_Login.unitypackage（TapTapSDK 登录模块，必选）
TapSDK_Moment.unitypackage (TapTapSDK 内嵌动态模块，必选)

设置回调

设置回调以获取动态的状态变化。

using TapSDK.Moment;

TapTapMoment.SetCallback((code, msg) =>
{
   // 根据 code  处理动态事件
});

// 移除 callback
TapTapMoment.SetCallback(null);

回调方法中 code 表示事件类型，现支持的回调类型如下：

回调	回调值	说明
CALLBACK_CODE_PUBLISH_SUCCESS	10000	动态发布成功
CALLBACK_CODE_PUBLISH_FAIL	10100	动态发布失败
CALLBACK_CODE_PUBLISH_CANCEL	10200	关闭动态发布页面
CALLBACK_CODE_GET_NOTICE_SUCCESS	20000	获取新消息成功
CALLBACK_CODE_GET_NOTICE_FAIL	20100	获取新消息失败
CALLBACK_CODE_MOMENT_APPEAR	30000	动态页面打开
CALLBACK_CODE_MOMENT_DISAPPEAR	30100	动态页面关闭
CALLBACK_CODE_CLOSE_CANCEL	50000	取消关闭所有动态界面（弹框点击取消按钮）
CALLBACK_CODE_CLOSE_CONFIRM	50100	确认关闭所有动态界面（弹框点击确认按钮）
CALLBACK_CODE_LOGIN_SUCCESS	60000	动态页面内登录成功
CALLBACK_CODE_SCENE_EVENT	70000	场景化入口回调

获取新消息

定时调用获取消息通知的接口，有新信息时可以在 TapTap 动态入口显示小红点，提醒玩家查看新动态。

using TapSDK.Moment;

TapTapMoment.FetchNotification();

获取消息通知的结果会在本文刚开始设置的回调中返回，code 为 CALLBACK_CODE_GET_NOTICE_SUCCESS（20000）表示获取成功，CALLBACK_CODE_GET_NOTICE_FAIL（20100）表示获取失败。获取成功时，msg 为新消息数量，0 表示没有新消息。

提示

为了方便玩家查看好友动态、游戏公告等，我们建议将 TapTap 动态入口放在显眼的位置，每分钟调用 1 次获取消息通知的接口。

获取消息通知时，如果没有新消息（msg 为 0），那么游戏需要清除界面上的小红点。同样，打开 TapTap 动态页面后，游戏也需要清除界面上的小红点。

显示动态页面

在游戏中显示 TapTap 动态页面，玩家可以查看及发布动态。

using TapSDK.Moment;

TapTapMoment.open();

备注

打开动态页面时，请先屏蔽游戏自身的声音，以免干扰动态内的视频声音。

如需要动态能支持横竖屏随设备自动旋转，需要游戏自身能支持横竖屏。

如前所述，打开动态页面后别忘了清除动态页面入口处的小红点。

按以下步骤配置动态页面的背景图：

在开发者中心进入 游戏服务 > 内嵌动态 > 主题配置。
选择深色或浅色导航主题、设置顶栏色值，并上传背景图片。图片需为 JPG 或 PNG 格式；横版尺寸为 2436 × 1125 px，竖版尺寸为 1125 × 2436 px。
点击 申请修改，提交审核。

背景图需要人工审核后才能生效，请预留充足的时间。

动态页面背景图配置入口和申请修改按钮

场景化入口

开发者可以结合游戏场景绘制入口，玩家打开入口跳转到指定的页面。使用前需要在开发者中心后台完成场景化入口配置。

using TapSDK.Moment;

// sceneId 为在开发者中心后台创建场景化入口后生成的「入口 ID」
TapTapMoment.OpenScene(sceneId);

场景化入口回调格式说明

SDK 回调结构

字段名	值类型	required	说明
sceneId	字符串	是	场景化入口 ID
eventType	字符串	是	枚举的事件类型，如 VIEW，FORWARD，VOTE 等
eventPayload	字符串	是	根据类型自定义的 JSON 字符串
timestamp	整数	是	unix 时间戳，ms

事件类型

eventType	eventPayload (未序列化)	说明
READY	`{}`	场景化页面已打开
REPOST	`{}`	转发，仅帖子本身
VOTE	`{ isCancel: boolean }`	点赞（含是否取消），仅帖子本身
FOLLOW	`{ isCancel: boolean }`	关注（含是否取消），仅帖子本身
COMMENT	`{}`	评论，仅帖子本身

关闭动态页面

玩家可以在动态页面主动退出，但在特定场景下，游戏可能需要主动关闭动态页面。

比如，玩家排位等待结束，准备进入对局时提示玩家关闭动态页面，玩家确认后关闭，此时调用如下接口：

using TapSDK.Moment;

TapTapMoment.CloseWithTitle("提示", "匹配成功，进入游戏");

接口中第一个参数为确认弹窗中的标题，第二个参数为确认弹窗中的内容。

用户的选择会通过回调返回：

CALLBACK_CODE_CLOSE_CANCEL（50000），表示玩家点了「取消」，选择不关闭动态页面。
CALLBACK_CODE_CLOSE_CONFIRM（50100），表示玩家点了「确认」，选择关闭动态页面。

如果需要直接关闭动态窗口，不弹出二次确认框，调用如下接口：

using TapSDK.Moment;

TapTapMoment.Close();

一键发布

信息

这是可选功能，请根据项目需求决定是否在游戏中加入这一功能。

我们推荐游戏让玩家直接在动态页面发布新动态。不过，SDK 也提供了发布图文动态的 API，以支持「一键发动态」等需求。图文动态包括单张或多张图片及相应的文字内容。

using System.Collections.Generic;
using TapSDK.Moment;

PublishMetaData publishMetaData = new PublishMetaData(content: "动态文字内容", imagePaths: new List<string> { "file://..." });
TapTapMoment.Publish(publishMetaData);

信息

玩家在动态页面可以发布图文动态和视频动态。「一键发布」只支持发布图文动态。

国际化

内嵌动态支持设置语言：

TapTapSDK.UpdateLanguage(TapTapLanguageType.Auto);

支持如下语言：

namespace TapSDK.Core
{
    public enum TapTapLanguageType
    {
        Auto = 0,// 自动
        zh_Hans,// 简体中文
        en,// 英文
        zh_Hant,// 繁体中文
        ja,// 日文
        ko,// 韩文
        th,// 泰文
        id,// 印度尼西亚语
        de,// 德语
        es,// 西班牙语
        fr,// 法语
        pt,// 葡萄牙语
        ru,// 俄罗斯语
        tr,// 土耳其语
        vi// 越南语
    }
}

「自动」会尝试根据系统语言设置语言，如果系统语言不在上述支持的语言之中，那么会根据 SDK 初始化时配置的区域设置语言。区域为中国大陆时会设置为简体中文，否则会设置为英文。

集成前准备​

权限说明​

Android 权限说明​

iOS 权限说明​

SDK 获取​

远程依赖​

本地文件导入​

设置回调​

获取新消息​

显示动态页面​

场景化入口​

场景化入口回调格式说明​

关闭动态页面​

一键发布​

国际化​