REP 开发指南
集成前准备
- 参考 开发者中心配置 创建应用、配置包名与签名证书
- 参考集成指南(Unity、Android、iOS)完成对应平台或引擎的基础接入
- 已从 TapTap REP 平台 获取需要打开的页面链接
权限说明
- Android
该模块依赖权限如下:
| 权限 | 使用目的 | 权限申请时机 |
|---|---|---|
| 网络权限 | 用于打开网页版页面 | 用户每次使用该功能时会申请权限 |
| 设备指定应用信息 | 获取已安装的 TapTap 客户端信息 | 用户每次使用该功能时会申请权限 |
该模块将在应用中添加如下权限:
<uses-permission android:name="android.permission.INTERNET" />
<queries>
<package android:name="com.taptap" />
</queries>
SDK 获取
- Unity
- Android
- iOS
远程依赖
NPMJS 方式:在 Packages/manifest.json 中添加:
"dependencies":{
"com.taptap.sdk.core":"4.9.3",
"com.taptap.sdk.rep":"4.9.3"
}
GitHub 方式:在 Packages/manifest.json 中添加:
"dependencies":{
"com.taptap.sdk.core":"https://github.com/taptap/tapsdk-unity-dist.git?path=/Core#4.9.3",
"com.taptap.sdk.rep":"https://github.com/taptap/tapsdk-unity-dist.git?path=/Rep#4.9.3"
}
本地文件导入
在 下载页 下载并导入以下 unitypackage 文件:
TapSDK_Core.unitypackage(TapTapSDK 核心模块,必选)TapSDK_Rep.unitypackage(TapTapSDK REP 模块,必选)
在 app module 的 build.gradle 中添加对应依赖:
dependencies {
implementation 'com.taptap.sdk:tap-core:4.9.3'
implementation 'com.taptap.sdk:tap-rep:4.9.3'
}
远程依赖
- 在工程 Podfile 文件中对应模块下添加依赖:
pod 'TapTapSDK/Rep', '~> 4.9.3'
- 执行
pod install下载对应依赖文件
本地文件依赖
TapTap REP 依赖于初始化模块,使用本地文件方式添加依赖时,需先参考集成指南 添加对应本地文件依赖项。
- 在 下载页 下载如下文件:
TapTapRepSDK.xcframeworkREP 依赖库
- 在工程中添加
framework静态库,注意添加时选择 Embed 方式为 Do Not Embed
提示
由于 SDK 需判断当前设备是否安装 TapTap 客户端,开发者需在 Xcode 工程的 info.plist 文件 LSApplicationQueriesSchemes 字段中添加 taptap 参数
打开链接
- Unity
- Android Java
- Android Kotlin
- iOS Swift
- iOS Objective-C
using TapSDK.Rep;
// 打开指定 URL
string url = ""; // 替换为实际的 URL
TapTapRep.Open(url, (errorCode, errorMessage) =>
{
if (errorCode == 0)
{
// 打开成功
Debug.Log("打开成功");
}
else
{
// 打开失败
Debug.LogError($"打开失败: {errorCode}, {errorMessage}");
}
});
import com.taptap.sdk.rep.TapTapRep;
// 打开指定 URL
String url = ""; // 替换为实际的 URL
TapTapRep.open(url, (errorCode, errorMessage) -> {
if (errorCode == 0) {
// 打开成功
Log.d("TapRep", "打开成功");
} else {
// 打开失败
Log.e("TapRep", "打开失败: " + errorCode + ", " + errorMessage);
}
});
import com.taptap.sdk.rep.TapTapRep
// 打开指定 URL
val url = "" // 替换为实际的 URL
TapTapRep.open(url) { errorCode, errorMessage ->
if (errorCode == 0) {
// 打开成功
Log.d("TapRep", "打开成功")
} else {
// 打开失败
Log.e("TapRep", "打开失败: $errorCode, $errorMessage")
}
}
import TapTapRepSDK
// 打开指定 URL
let url = "" // 替换为实际的 URL
TapTapRep.open(openUrl: url) { errorCode, errorMessage in
if errorCode == 0 {
// 打开成功
print("打开成功")
} else {
// 打开失败
print("打开失败: \(errorCode), \(errorMessage ?? "")")
}
}
#import "TapTapRepSDK/TapTapRepSDK-Swift.h"
// 打开指定 URL
NSString *url = @""; // 替换为实际的 URL
[TapTapRep openWithOpenUrl:url completion:^(NSInteger errorCode, NSString * _Nullable errorMessage) {
if (errorCode == 0) {
// 打开成功
NSLog(@"打开成功");
} else {
// 打开失败
NSLog(@"打开失败: %ld, %@", (long)errorCode, errorMessage);
}
}];
参数说明
| 参数 | 说明 |
|---|---|
| openUrl/url | 要打开的 URL 地址,必须是完整的链接(包含 http:// 或 https://)。建议使用 TapTap REP 平台 生成的链接 |
| callback/completion | 回调函数,返回打开结果。errorCode 为 0 表示成功,其他值表示失败;errorMessage 为错误信息 |
错误码说明
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 100002 | 参数错误(URL 为空或格式不正确) |
| 100003 | 客户端配置错误(SDK 未初始化) |
| 100004 | 未知错误 |
测试
为了保证上线后游戏能够正常使用 TapTap REP 功能,请务必按照以下说明完成自测。
测试步骤
-
准备测试 URL
- 访问 TapTap REP 平台 获取测试链接
- 或使用游戏在 TapTap 上的详情页链接进行测试
-
已安装 TapTap 客户端的情况
- 调用
open方法后,应能正确唤起 TapTap 应用 - 检查打开的页面内容是否正确
- 调用
-
未安装 TapTap 客户端的情况
- 调用
open方法后,应能在浏览器中打开对应页面 - 检查网页版页面内容是否正确显示
- 调用
-
错误处理
- 测试传入空 URL 或错误格式 URL 时的错误处理
- 测试 SDK 未初始化时调用的错误提示