Tap 客服开发指南
本文介绍如何在游戏中接入 TDS 提供的客服系统。
权限说明
- Unity
- Android
- iOS
- UE4
该模块需要权限如下:
权限 | 使用目的 | 权限申请时机 |
---|---|---|
网络权限 | 访问网络数据 | 用户首次使用该功能时会申请权限 |
获取网络状态 | 用于检测当前网络连接是否有效 | 用户首次使用该功能时会申请权限 |
读取存储权限 | 用于反馈工单时添加本地图片、视频附件 | 上传附件时申请 |
该模块将在应用 AndroidManifest.xml
中添加如下权限:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
android:maxSdkVersion="32" />
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>
SDK 初始化
在 下载页 获得 TapSDK,引入 TapSupport
模块:
- Unity
- Android
- iOS
- UE4
SDK 可以通过 Unity Package Manager 导入或手动导入,二者任选其一。请根据项目需要选择。
方法一 :使用 Unity Package Manager
NPMJS 安装
从 3.25.0 版本开始,TapSDK 支持了 NPMJS 安装,优势是只需要配置版本号,并且支持嵌套依赖。
在项目的 Packages/manifest.json
文件中添加以下依赖:
"dependencies":{
"com.taptap.tds.support":"3.29.7",
}
但需要注意的是,要在 Packages/manifest.json
中 dependencies
同级下声明 scopedRegistries
:
"scopedRegistries": [
{
"name": "NPMJS",
"url": "https://registry.npmjs.org/",
"scopes": ["com.tapsdk", "com.taptap", "com.leancloud"]
}
]
GitHub 安装
在项目的 Packages/manifest.json
文 件中添加以下依赖:
"dependencies":{
"com.taptap.tds.common":"https://github.com/TapTap/TapCommon-Unity.git#3.29.7",
"com.taptap.tds.support":"https://github.com/TapTap/TapSupport-Unity.git#3.29.7",
"com.leancloud.storage":"https://github.com/leancloud/csharp-sdk-upm.git#storage-2.3.0",
}
在 Unity 顶部菜单中选择 Window > Package Manager 可查看已经安装在项目中的包。
方法二:手动导入
-
在 下载页 找到 TapSDK Unity 下载地址,下载
TapSDK-UnityPackage.zip
。 -
在 Unity 项目中依次转到 Assets > Import Packages > Custom Packages,从解压后的
TapSDK-UnityPackage.zip
中,选择希望在游戏中使用的 TapSDK 包导入,其中:
TapTap_Common.unitypackage
TapSDK 基础库,必选。TapTap_Support.unitypackage
TapTap 客服库,必选。
- 从 LeanCloud-SDK 下载页 中下载并解压 LeanCloud-SDK-Storage-Unity.zip,然后将 Plugins 文件夹拖拽至 Unity 即可。
TapSupport SDK 依赖 TapCommon 模块:
repositories{
flatDir {
dirs 'libs'
}
}
dependencies {
...
implementation name:'TapCommon_3.29.7', ext:'aar'
implementation (name:'TapSupport_3.29.7', ext:'aar')
}
确认 AndroidManifest.xml
已添加网络权限:
<uses-permission android:name="android.permission.INTERNET"></uses-permission>
TapSupport SDK 依赖 TapCommon 模块:
TapCommonSDK.framework
// 3.29.4 版本需要添加 LibProtocolBuffers
LibProtocolBuffers.framework
TapSupportSDK.framework
TapSupport SDK 依赖 TapCommon 模块:
PublicDependencyModuleNames.AddRange(
new string[]
{
"TapCommon",
"TapSupport"
// ... add other public dependencies that you statically link with here ...
}
);
在初始化 SDK 之前,有一些准备工作需要完成:
- 请厂商管理员或客服管理员邀请你成为客服管理员。
- 每个厂商会被分配一个专属域名,需要记下待用。你可以在客服工作台的 设置 > 开发者信息 中找到可用的域名。如果你想要使用自己的域名,可以联系厂商管理员在开发者中心游戏客服模块中绑定。
- 在客服工作台,为你的游戏创建一个产品(设置 > 管理 > 产品与分类),记下这个产品的 ID。
然后使用以下代码初始化 TapSupport 模块:
- Unity
- Android
- iOS
- UE4
using TapTap.Support;
TapSupport.Init("https://please-replace-with-your-customized.domain.com", "产品 ID");
import com.tds.tapsupport.TapSupport;
import com.tds.tapsupport.TapSupportCallback;
import com.tds.tapsupport.TapSupportConfig;
TapSupportConfig config = new TapSupportConfig("https://please-replace-with-your-customized.domain.com", "产品 ID", new TapSupportCallback() {
@Override
public void onUnreadStatusChanged(boolean hasUnread) {
// 我们会在 §未读消息通知 讨论 callback 的用法
}
})
TapSupport.setConfig(this, config);
#import <TapSupportSDK/TapSupportSDK.h>
TapSupportConfig *config = [TapSupportConfig new];
config.server = @"https://please-replace-with-your-customized.domain.com";
config.productID = @"产品 ID";
config.callback = self;
[TapSupport shareInstance].config = config;
#include "TapUESupport.h"
FTapSupportConfig Config;
Config.ServerUrl = TEXT("https://please-replace-with-your-customized.domain.com");
Config.ProductID = TEXT("产品 ID");
TapUESupport::Init(Config);