Android SDK 开发指南

集成前准备

1. 参考 开发者中心配置 创建应用、配置包名与签名证书
2. 参考 Android 集成指南 完成基础接入

权限说明

该模块需要如下权限：

权限	使用目的	权限申请时机
网络权限	用于正常网络访问	用户首次使用该功能时会申请权限
安装 APK 权限	用于安装 Tap 客户端	用户首次使用该功能时会申请权限

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

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<queries>
    <package android:name="com.taptap" />
    <package android:name="com.taptap.global" />
</queries>

SDK 获取

在 app module 的 build.gradle 中添加对应依赖：

dependencies {
  implementation 'com.taptap.sdk:tap-core:4.11.1'
  implementation 'com.taptap.sdk:tap-update:4.11.1'
}

选择更新方式

更新唤起提供以下两种方式，游戏选择其中一种接入即可：

对比项	开发者中心配置更新	游戏自行判断更新
适用场景	没有自有版本管理系统，特别是单机游戏	自有版本管理系统，期望更灵活触发、展示更新的网游
新版本判断方	TapTap 根据开发者中心的版本配置判断	游戏服务端或客户端自行判断
调用接口	checkForceUpdate()	updateGame()
调用时机	游戏启动后检查是否存在强制更新	游戏判断需要更新后主动调用
开发者中心要求	上传并审核新 APK，设置 APK 更新模式	配置与游戏安装包一致的 APK 包名

Android 开发者注意

由于更新唤起 UI 依赖于开发者设置的 Activity 实例，所以为了避免因 Activity 发生重建导致更新唤起功能不可用，开发者应确保在屏幕旋转、配置修改时当前 Activity 不会发生重建，具体设置方式参考 限制 activity 重新创建。

开发者中心配置更新

适用于：无自有版本管理系统的游戏，特别是单机游戏。

代码接入

Android Java

import com.taptap.sdk.update.TapTapUpdate;

TapTapUpdate.checkForceUpdate();

Android Kotlin

import com.taptap.sdk.update.TapTapUpdate

TapTapUpdate.checkForceUpdate()

测试方式

1. 在 TapTap 开发者中心 商店 > 版本管理 上线包含 APK 的商店资料版本（需审核通过）。若 APK 暂不对外，可将发布状态设为「敬请期待」或「预约」，在 商店 > 游戏测试 开启封闭式测试、添加测试人员。
2. 构建包名与开发者中心当前 APK 一致、版本号（Version Code）低于当前版本的测试包。
3. 用该测试包触发更新，确认是否唤起 TapTap 商店详情页。

注意

为确保「强制更新」功能正常生效，请在上传新版本时将「APK 更新模式」设置为「强制更新」；若选择「普通更新」，将不会唤起 TapTap 商店页。

游戏自行判断更新

适用于：自有版本管理系统，期望更灵活触发、展示更新的网游。

代码接入

Android Java

import com.taptap.sdk.update.TapTapUpdate;
import com.taptap.sdk.update.TapTapUpdateCallback;

// 自行维护版本校验逻辑，新版本发布时调用
TapTapUpdate.updateGame(activity, new TapTapUpdateCallback() {
    @Override
    public void onCancel() {
        // 更新取消
    }
});

Android Kotlin

import com.taptap.sdk.update.TapTapUpdate
import com.taptap.sdk.update.TapTapUpdateCallback

// 自行维护版本校验逻辑，新版本发布时调用
TapTapUpdate.updateGame(
    activity = this,
    callback = object : TapTapUpdateCallback {

        override fun onCancel() {

            Toast.makeText(this@DemoUpdateActivity, "取消更新", Toast.LENGTH_SHORT)
                .show()
        }
    }
)

信息

未安装 TapTap 客户端时，SDK 会询问用户是否使用 TapTap 更新，点击「取消」才会触发取消回调。

测试方式

1. 确保已在游戏资料中配置 APK 包名。
2. 构建相同包名的测试包。
3. 游戏自行触发更新，确认是否唤起 TapTap 商店详情页。

提示

如果游戏需要接入海外版本或不通过集成 SDK 实现，请参考 文档