客户端接入指南


本文档面向 Android 开发者,描述的接入方式适合运营在 4399 平台的普通单机游戏。

SDK 说明

用户信息与隐私策略

SDK 中使用的用户信息及隐私政策参考:《4399通行证用户服务协议》《隐私政策》

功能描述

4399 运营 SDK,为单机类游戏提供防沉迷、数据统计、增量更新、有服务器/无服务器充值等功能

SDK 组成

客户端 SDK

SDK 优先提供在线aar依赖方式,Demo 结构遵循 Android Studio(as) 规范,但仍然保留了 jar+res 的依赖方式。
SDK 支持的编译配置 android:minSdkVersion >= 16

服务端 API

需要充值服务端回调,参考 SDK 服务端接入文档

集成流程

准备

首次接入 SDK,要在 4399 开放平台 注册应用,主要是提交APK、素材,配置游戏币、充值回调地址等信息。
完成后,开发者将得到 SDK 的基础参数:game keyGameKey,游戏在 4399 平台的运营标识

引入依赖

根据游戏需要,以下三种方式可选其一

repositories {
    maven {
        // 4399 SDK 开放仓库:正式
        url 'https://mvn.4399doc.com/repository/maven-releases'
    }
    maven {
        // 4399 SDK 开放仓库:快照
        url 'https://mvn.4399doc.com/repository/maven-snapshots'
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
    
    // 运营 SDK:建议使用最新版本,可通过浏览仓库地址或向运营咨询版本
    implementation "cn.m4399.sdk:operate:3.6.0"
    
    // volley 和 support 是 SDK 使用的外部依赖,若接入方已有,可忽略
    implementation 'com.android.volley:volley:1.2.0'
    //noinspection GradleCompatible
    implementation "com.android.support:support-v4:28.0.0"
}

注意:若使用7.0+版本的 gradle 及 android build 插件,仓库地址应配置在settings.gradle

operate/libs/volley-v1.2.0.jar
operate/libs/support-v13-23.2.1.jar

Gradle 文件中注意添加本地依赖

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar','*.aar'])
}

abi 适配与 so 库

若游戏不需要支持所有 abi ,可以按需选用。
aar依赖方式,按以下方式配置需要的abijar+res依赖方式需要手动删除不需要abi目录

android {
    defaultConfig {
        ndk {
            // 根据游戏需要选择
            abiFilters "armeabi", "armeabi-v7a", "x86", "arm64-v8a"
        }
    }
}

接口调用:初始化(必须)

SDK 初始化后才能正确调用其他接口,建议在游戏Activity的开始处如 onCreate方法中进行。

// 初始化选项,传入游戏配置,更多说明见接入文档
OperateConfig opeConfig = new OperateConfig.Builder(this)
        // 设置游戏运营 key,此参数需要在原创开放平台注册应用后得到
        .setGameKey(GAME_KEY)
        // 设置SDK页面方向,应与游戏方向一致,部分第三方页面需要在AndroidManifest中设置
        .setOrientation(GAME_ORIENTATION)
        // 设置游戏充值是否支持超出金额,可选,true支持,默认false
        .setSupportExcess(GAME_SUPPORT_EXCESS)
        // 设置游戏是否兼在高于Android 9.0版本系统容全面屏,true兼容,默认false
        .compatNotch(GAME_COMPACT_NOTCH)
        .build();

// 初始化SDK
SingleGame.init(this, opeConfig, new OpeInitedListener() {
    @Override
    public void onInitFinished() {
        // 完成防沉迷等初始化流程,可进入游戏
    }
});

初始化的几点说明

页面方向

  <!-- 游戏 Activity 配置建议:
       应该使用 android:configChanges="orientation|screenSize|keyboardHidden"
       不应该使用 android:launchMode="singleTask" 启动模式,可以考虑 singleTop
  -->
方向参数 含义
SCREEN_ORIENTATION_LANDSCAPEint, 0 横屏
SCREEN_ORIENTATION_PORTRAIT, int, 1 竖屏
SCREEN_ORIENTATION_SENSOR_LANDSCAPEint, 6 横屏,可180度旋转
SCREEN_ORIENTATION_SENSOR_PORTRAITint, 7 竖屏
<!-- 
    4399 SDK:SDK 中除了以'cn.m4399.'开头的 Activity 都是第三方页面,
        假设游戏为横屏,需要锁定它们的方向为横屏,可以设置 android:screenOrientation,
        此设置应与初始化接口中设置的值保持对应,且若编译有错误,可以进一步设置‘tools:replace’
 -->
<activity 
        android:name="com.cmic.gen.sdk.view.GenLoginAuthActivity"
        android:configChanges="orientation|keyboardHidden|screenSize"
        android:launchMode="singleTop"
        android:screenOrientation="landscape"
        android:theme="@style/AppTheme.NoActionBar"
        tools:replace="android:theme, android:screenOrientation" />

悬浮窗

悬浮窗会在用户登录后附着在游戏页面上层,点击后打开对页面展示个人信息、设置,和游戏论坛、官网等入口。

极少数游戏登录 Activity 并不是游戏主 Activity ,则悬浮窗可能发生异常,建议游戏做相应调整

样式类型 图示
PopLogoStyle.POPLOGOSTYLE_ONE(默认) image
PopLogoStyle.POPLOGOSTYLE_TWO image
PopLogoStyle.POPLOGOSTYLE_THREE image
PopLogoStyle.POPLOGOSTYLE_FOUR image
样式类型 位置
PopWinPosition.POS_LEFT(默认) 屏幕左侧
PopWinPosition.POS_RIGHT 屏幕右侧
PopWinPosition.POS_TOP 屏幕上侧
PopWinPosition.POS_BOTTOM 屏幕下侧

接口调用:充值

单机游戏需要充值功能时,首先要确认是使用服务端回调模式,还是客户端模式。
若是前者,只要在注册游戏时完成充值配置即可;若游戏没有自己的服务器,而不得不使用客户端回调,首先要注册回调对象。

注意,客户端回调模式不安全,APK 容易被静态破解

// 单机游戏充值时,允许使用客户端回调,如需使用请联系运营确认
// 注意 !!!!!:客户端回调不安全,APK 容易被篡改
// 设置发放物品回调,需要客户端回调才使用
SingleGame.setDeliveringGoodsListener(new SingleGame.OnDeliveringGoodsListener() {
    @Override
    public boolean onDelivering(OrderFinished of) {
        Log.i(TAG, of.money() + " " + of.conclude().first + " " + of.conclude().second);
        // 如果游戏因为某些原因发放失败,应返回false
        return true;
    }
});
/*
 * 充值
 *
 * money, 充值金额,整型,单位元,1 ~ 50000,必须
 * mark, 游戏方订单,必须,
 *      支持大小写字母、数字、'|'(竖线)、'-'(中划线)、'_'(下划线),最长32位,不可为空,不可重复
 * commodity, 商品名,可选,不传时认为商品名是游戏币
 */
String mark = GameSettings.createUniqueMark();
SingleGame.recharge(this,
        // 充值金额,整数,单位元
        // mark: 游戏订单,游戏可以再其中映射用户名、商品信息
        new Order(money, mark)
                // 是否支持超出金额,默认不支持
                .supportExcess(false)
                // 商品名,可选,不传时认为商品名是游戏币
                .commodity(getString(R.string.recharge_commodity_name)),
        new OperateCenter.OnRechargeFinishedListener() {
            @Override
            public void onRechargeFinished(boolean success, int resultCode, String msg) {
                Log.i(TAG, resultCode + " " + msg);
            }
        });

关于Order对象中的supportExcess(boolean)接口

关于超出金额模式(超额)
由于卡类等充值渠道有金额限制,可能出现充值金额无法匹配任何金额的情况;
如果游戏能处理超出传入金额 部分的货币,即将多余部分以游戏发放给用户,则可以设置true
否则,应设置为false或不调用,SDK将直接隐藏无匹配金额的充值渠道。

游戏更新

此功能需要在4399后台提交新版本,并开启相关开关,详情可咨询运营。

更新功能会检查是否有新版本游戏上线,如果有,则显示更新内容、提示用户升级。
按升级内容,可为全量更新和增量更新(只需下载新旧版 APK 文件中的差异部分)。
按接入方式又可分为自动更新(无需操作,默认初始化完成)和自定义界面更新

自定义界面增量更新接入方法详见: 4399运营SDK增量升级说明