LCM Android SDK 接入指南
一、接入前准备
开发环境和前提步骤详见在L服务器上注册APP
二、SDK版本选择
根据需求选择不同的SDK包：
三、Android Studio接入步骤
-
将release目录下的所有文件拷贝到自己工程的根目录下
-
参照demo根目录的
settings.gradle文件，将release目录下的所有module导入，建议不要修改文件名称，可以直接拷贝demo中的settings.gradle中的配置。 -
将demo根目录的
build.gradle中的配置 拷贝到 工程根目录下的build.gradle中。 Android Studio 3.0 以上的编辑器，如果出现无法编译通过的情况，请按照如下修改gradle的版本即可解决问题。（如出现编译问题，建议多clean project）dependencies { classpath 'com.android.tools.build:gradle:2.2.3' } -
将gradle.properties中的配置拷贝到自己工程的gradle.properties中（org.gradle.jvmargs 请使用demo中的配置。）
-
请参照
LCMSDK中的build.gradle文件配置，将android{ }中的配置粘贴到自己创建的module的build.gradle中。 并将目录结构改成和LCMSDK的目录结构一样。 -
请将sample中的
AndroidManifest.xml文件中application节点下注册的activity（除了SampleActivity）全部拷贝到自己的AndroidManifest.xml中，<uses-permission>权限也一样拷贝。 -
在自己的
build.gradle中引入sdk和store的lib工程就可以了。 例如: (大陆D商店版本的导包),其他商店参考Demo的gradle导包即可。dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) compile project(':sdk') compile project(':store_cn') }
四、Eclipse接入步骤
下面说明eclipse如何接入：
-
解压SDK压缩包后，将release目录下的LCMSDKLib目录（例如
LCMSDKLib_RC9.5.3_tw）拷贝到游戏工程所在的workspace下 -
通过“导入已有项目”的方式导入刚刚拷贝的目录下的所有项目（不要勾选"Copy projects into workspace"），导入前要删掉项目
build目录下所有文件 -
让游戏主项目 引用 上一步导入的所有项目（项目引用方法：Properties -> Android -> Library -> Add），此外，还需注意以下几点：
-
纯Google商店包：
store-gp和google-play-services_lib_fcm都需要引用google-play-services_lib_base项目 -
Google嫁接D商店包：
store-gp和google-play-services_lib_fcm都需要引用google-play-services_lib_base项目 -
大部分情况下，
google-play-services_lib_analytics项目不需要用到，可以忽略
-
-
将
LCMSDK项目下的android-support-v4.jar文件复制到workspace根目录下（或其他本地目录），然后新建一个User Library，命名为android-support-v4，点击“add external jars”把刚刚那个jar包add进来 -
删除所有项目下的
android-support-v4.jar文件（注意，后缀名带24.2.1的新版本support包不能删除），然后把删除过android-support-v4.jar的项目（LCMSDK项目除外）都引用前面新建的User Library（Properties -> java build path -> Libraries -> add Library -> User Library） -
将samples目录下的Pickle中的
AndroidManifest.xml文件中application节点下注册的activity（除了SampleActivity）全部拷贝到自己的AndroidManifest.xml中，<uses-permission>权限也一样拷贝。
五、LCMSDK的接入
1. sdk的初始化接入流程
1）init()及权限申请
- init()接口在Activity的OnCreate()方法中进行初始化。
// 1、传入两个基础参数，需要自己申请权限后调用（9.5.3后废弃）
public static void init(Activity activity, EventHandler eventHandler);
// 2、可传入权限集合初始化（9.5.3新增）
public static void init(Activity activity, EventHandler eventHandler,
Map<String, Boolean> permissions) ;
// 3、可传入授权前提示框初始化（9.5.3新增）
public static void init(Activity activity, EventHandler eventHandler,
Dialog permissionDialog);
// 4、可传入权限集合和授权前提示框初始化（9.5.3新增）
public static void init(Activity activity, EventHandler eventHandler,
Map<String, Boolean> permissions, Dialog permissionDialog);
- 授权前弹框（上架google的包需要，非必接，可根据需求接入)
- 新接入方式（9.5.3新增，推荐）
// 这里传入permissionDialog，(google-play-store 上架的游戏/应用 用到)，可不接，传null即可 ，如2。
Dialog permissionDialog = PermissionDefaultDialog.create(this,
"权限提示", "应用将获取存储，电话等权限，以保证应用的正常运行！(语言适配由接入方实现)----测试专用",
"知道了");
LCMSDK.init(this, lcmEventHandler, permissionDialog);
如果还需要额外的权限请参考<权限申请> 并使用init（）接口中的第四个接口接入。
- 权限申请
- 新方式接入（9.5.3新增，推荐） 权限申请可根据游戏需要的权限写入map即可。 有三个权限是必须要的，sdk已经默认添加了，即为下面的三个权限。如果需要额外的权限，可新建 Map，将权限写入map 使用 init() 接口传入即可。 例如：
/*
Map中的key为游戏所需要的权限,value为true,表示该权限是必须权限，不可拒绝
value为false 表示可拒绝权限，拒绝该权限后，不会弹提示框。相反则会重新弹出授权框
*/
Map<String> map = new HashMap<>();
map.put(Manifest.permission.READ_PHONE_STATE, true);
map.put(Manifest.permission.WRITE_EXTERNAL_STORAGE, true);
map.put(Manifest.permission.READ_EXTERNAL_STORAGE, true);
LCMSDK.init(this, lcmEventHandler, map, permissionDialog);
注： 以上3个权限sdk所必须的权限，可以参照此方式。
如果没有额外需要申请的权限，第三个参数传入null即可（注意：不要使用两个参数的方法。）
LCMSDK.init(this, lcmEventHandler, null , permissionDialog);
扩展：即不需要额外权限，也不要授权前提示框的接入方式，3、4参数都传null即可。
（注意：不要使用两个参数的方法。）
LCMSDK.init(this, lcmEventHandler, null , null);
2）EventHandler回调
- 在初始化时需要传入EventHandler回调接口。具体处理下文有介绍，也可以参考Demo。EventHandler是LCMSDK的重要的一个监听器，它实现了游戏与LCMSDK的交互，包括登录，强更，公告等都是通过这个监听器回传给游戏的。
// 创建接口回调对象。调用init接口需要传入。
lcmEventHandler = new LCMSDK.EventHandler() {
@Override
public void onInitComplete(LCMInitializer lcmInitialization) {
// 初始化完成
}
@Override
public void onRemoteMessage(String message, String extras) {
// 推送消息
}
@Override
public void onSessionError(LCMError error) {
// session错误回调
}
@Override
public void onSessionUpdate(String accessToken, User user) {
// session更新
}
@Override
public void onUpdate(LCMUpdater updater) {
// 强更
}
@Override
public void onAnnouncement(LCMAnnouncement announcement) {
// 公告
}
@Override
public void onActivation(LCMActivation activation) { // 激活码
}
@Override
public void onLogoutComplete(String extra) {
// 登出游戏成功
}
@Override
public void onLoginComplete(String accessToken, User user) {
// 登录游戏成功
}
@Override
public void onQuitComplete(String extra) {
// 退出
}
}
- 关于EventHandler接口的定义，可以参考 2.1 Android API
- 对EventHandler的详细说明：请看 集成代码到自己的应用：6.实现最简单的EventHandler对象：
3）sdk生命周期绑定
-
LCMSDK需要与主Activity的生命周期保持一致，需要绑定主Activity的生命周期 相应的绑定如下：
LCMSDK中的方法 (参数) Actiivty的生命周期 init(this,xx...) (此方法请参考上文介绍） onCreate() onResume(this) onResume() onPause(this) onPause() onStop(this) onStop() onReStart(this) onReStart() onDestory(this) onDestory() onActivityResult(this,requestCode, resultCode, data) onActivityResult() onNewIntent(this, intent) onNewIntent() onConfigurationChanged(this, newConfig) onConfigurationChanged() onRequestPermissionsResult(requestCode, permissions, grantResults) onRequestPermissionsResult() quit() onBackPressed()
3）配置闪屏图片（Splash）
- LCMSDK支持splash闪屏，在调用LCM init接口的时候，闪屏会出现，并在onInitComplete回调中消失。
- 不配置闪屏文件表示默认无闪屏。
- 游戏方若需要配置自己splash闪屏图片，则需要替换工程目录res/drawable-hdpi/lcm_splash_l.png和res/drawable-hdpi/lcm_splash_p.png两张图片，其中lcm_splash_l.png对应横屏游戏，lcm_splash_p.png对应竖屏游戏，有其一即可，游戏根据自己的横竖屏设置选择放入对应的闪屏图片。
- 注：闪屏图片是可以在资源文件中替换的，游戏的闪屏图片最好不要带有不可替换的内容，以至于在某些情况下该图片会被替换成其他图片，比如接入大陆渠道时，部分渠道方会要求使用渠道方的闪屏图片，则打包工具会将游戏自己的闪屏图片替换成渠道方的。
2. 配置文件appinfo.conf的配置说明
- 可参考Demo中res/raw目录下的appinfo.conf。
-
{"region":"ap","sandbox":"false","appVersion":"1.0","productId":"pickle","storeType":"LCM_A_TW","md5":"LCM_A_TW"}参数 说明 region 地区：大陆为cn ，海外为ap sandbox 是否是沙箱环境：沙箱服为true，正式服为false appVersion 游戏版本：例如：1.0 productId 为ope后台注册的应用名称 storeType 商店类型：大陆D商店为LCM_A_CN，台湾D商店为LCM_A_TW，GOOGLE和GOOGLE—D商店为GOOGLE，ONESTORE商店为ONESTORE, ONESTORE-D商店为ONESTORE2。可以参考Demo的配置。 md5 签名文件的md5，需在ope后台配置。
接入完成以后，运行验证: 在EventHandler中的onLoginComplete() 回调中获取accessToken即接入成功了（具体可见Demo）。
3. 登录、登出
1） 登录接入
- 完成上述的基本配置以后登录的功能就接好了。
- EventHandler的回调中有onLoginComplete(String accessToken, User user)回调，登录后需要一些处理可以在此方法中处理，比如登录后公告，需要在次回调中调用 LCMSDK.checkAnnouncement()进行处理。（可参考Demo）
2） 登出接入
- 调用接口 LCMSDK.logout() 可实现登出功能
- EventHandler的回调onLogoutComplete(String extra)中可做登出完成的一些处理，如:重新初始化登录界面:LCMSDK.login()。（可参考Demo）
4. 支付
1）支付接入流程
-
支付接入可参考： 支付的接入
-
获取商品列表：
VCBundle.getAsList(SampleActivity.this, new VCBundleCallback() {
@Override
public void onComplete(List<VCBundle> bundles, LCMError error) {
if (error == null) {
// 获取到商品列表，游戏可以自己展示，处理。
vcBundleList = bundles;
// 检查订单，必接
LCMSDK.recover(SampleActivity.this, vcBundleList,
new LCMSDK.OnRepayListener() {
@Override
public void onComplete(String transactionId, JSONObject jo) {}
@Override
public void onError(int errorCode, String errorMsg) {}
});
} else {
//handle error.
}
}
});
- 支付的使用方式
- 新增： VCBundle的接口，使用VCbundle对象调用buy()方法即可，此方式已经将实名制认证封装在里面。使用此方法可以省去实名制认证。
vcBundle.buy(SampleActivity.this, purchaseMemo, new VCBundle.PurchaseCallback() {
@Override
public void onComplete(Wallet wallet, JSONObject payInfo, String memo, LCMError error) {
// 后续处理见Demo
doPurchase(vcBundle, wallet, parent, payInfo, error);
}
});
- 实名制认证
- 实名制认证只有大陆自营商店才有，应国家政策要求，国内必须接入，但不会影响到其他商店的支付接入。
- 请参考： 实名制认证
- Google商店支付
- 请参考：Google商店支付
-
DeNA自营商店大陆商店 请参考：DeNA自营商店
-
DeNA港澳台商店 请参考：DeNA港澳台商店
- MyCard支付： 3.1 MyCard支付
- PayPal支付： 3.2 PayPal支付
- MOL支付： 3.3 MOL支付
-
OneStore商店
- 请参考：OneStore商店
-
支付回调错误码说明
错误码 （errorCode） ErrorType 说明 200 BANK_CREATE_ORDER_ERROR创建订单错误 205 BANK_PURCHASE_FAILURE购买失败 206 BANK_PURCHASE_CANCEL购买取消 216 BANK_PURCHASE_RESULT_UNKNOWN购买结果未知 217 BANK_GET_CURRENT_BALANCE_ERROR获取当前余额失败 218 BANK_GET_BALANCE_INFO_ERROR获取余额信息失败 220 BANK_PURCHASE_NO_GOOGLE_ACCOUNT购买失败 no google account 222 BANK_REPAY_ERROR重新购买失败 299 BANK_NOTIFY_ERROR通知服务端失败 - 更多详见附录.
5. 公告
1）公告接入流程
- 公告是在EventHandler的onAnnouncement(LCMAnnouncement announcement)中做处理的。
- 如果游戏不需要自定义UI可使用：
announcement.applyDefault(new LCMAnnouncement.DefaultAnnouncementCallBack() {
@Override
public void callback() {
// 执行正常进入游戏的逻辑，祥见pickle，SampleActivity.java.
sampleStartToLoginToGame();
}
});
- 如果游戏需要自定义UI，需要接入者手动调用 announcement.continueProcessing(); 只有调用了此方法LCMSDK才会继续登录流程，但是该方法不能滥用，介入者需自行判断使用时机。 例如：在自己写的弹窗的确定按钮点击事件中调用此方法。
6. 推送
1） 推送接入流程
- 推送分为大陆商店的推送（百度推送）和Google的推送（FCM推送）
- 推送在EventHandler的回调方法是onRemoteMessage(String message, String extras) 游戏可根据需求自行处理。
- 百度推送接入: 请参考 百度推送文档
- Google推送接入: 请参考 FCM推送文档
7. 强更
1）强更接入流程
- 强更会在EventHandler中的onUpdate(LCMUpdater updater)回调给游戏
- 可参考Demo中的处理，Demo中使用默认处理
@Override
public void onUpdate(LCMUpdater updater) {
//TODO 强制更新回调这里（推荐自定义UI接入方式）(必接)
/* 游戏收到该回调后可通过显示LCM默认强更UI或者自定义强更页面，
如果需要设置下载路径可通过 ：
updater.setTargetFilePath("/sdcard/dwonload/xxx.apk")
*/
updater.showDefaultUI();
}
- 详细介绍请参考 ： 强制更新
8. onSessionError处理
-
游戏研发需要在回调函数onSessionError判断错误码类型，展示对应的错误信息弹窗。
错误码 （errorCode） LCMError.ErrorType 说明 108 AUTH_SESSION_OCCUPIED异地登录，账号在另一台设备上登录了，挤掉线 116 AUTH_USER_FREEZE_TEMPORARY临时冻结账户 117 AUTH_USER_FREEZE_PERMANENT永久冻结账户 119 AUTH_CREDENTIAL_NO_GOOGLE_ACCOUNT谷歌账号未登录处理(针对海外包，大陆包忽略) 409 BIND_ACCOUNT_ERROR绑定账号错误，该facebook/line账号已经被link过，请换一个facebook/line账号进行link.（针对海外包，大陆包忽略） -
详情请参考Demo。
9. 游戏打点事件（创角事件）
1）游戏打点接入流程
- 详情请参考 ：游戏打点事件
10. 悬浮窗(DeNA自营商店商店接入需要）
1）悬浮窗接入
- 配置悬浮框的默认显示位置
- 0：左上角
- 1：右上角
- 2：左下角
- 3：右下角
- -1:则不显示悬浮框
- 默认显示 0： 左上角
在清单文件中配置
<meta-data android:name="menubar_default_position" android:value="0"/>
2）全面屏、刘海屏适配 配置
- 为了悬浮窗能够适配刘海屏和全面屏，游戏可以配置以下属性到application节点下
<!--适配全面屏 start-->
<meta-data
android:name="android.max_aspect"
android:value="2.4" />
<!--华为刘海区域使用配置-->
<meta-data
android:name="android.notch_support"
android:value="true" />
<!--小米刘海区域使用配置-->
<meta-data
android:name="notch.config"
android:value="portrait|landscape" />
<!--VIVO刘海区域使用配置-->
<meta-data
android:name="android.vendor.full_screen"
android:value="true" />
<!--适配全面屏 end-->
11.其他（非必接）
1）本地推送
- 请参考： 本地推送
2）激活码
- 请参考： 激活码
3）客服系统
- 请参考： 客服系统
4）lid的Link/Load
- 请参考： lid的Link/Load
5) 同设备的lid的重置和切换（reset、switch）
- 请参考： lid的重置和切换
12. 出包
- 请参考：LCM9.5.0及以上出包指南
13. 常见问题-FAQ
- Q：无法正常登陆游戏？ A：检查appinfo.conf配置文件的storeType和md5是否配置正确。
14. 联系方式
- 技术QQ群：878394398
- 邮箱：sdk-app_cn@dena.jp
版本:RC9.5.3 日期：2018.9.19
15. 附录
-
错误码附录
错误码 （errorCode） LCMError.ErrorType 说明 100 AUTH_STORE_CREDENTIAL_ERRORGet store credential error 101 AUTH_STORE_TYPE_ERRORStoreType 错误 102 AUTH_SESSION_ERROR创建session错误 103 AUTH_SOCIAL_ACCOUNT_ERRORGet social account error 104 AUTH_STORE_ACCOUNT_ERROR获取商店账号错误 105 AUTH_GET_LINK_INFO_ERROR获取绑定信息错误 106 AUTH_LINK_ACCOUNT_ERROR绑定账号错误 107 AUTH_LOAD_ACCOUNT_ERROR加载账号错误 108 AUTH_SESSION_OCCUPIED异地登录，账号在另一台设备上登录了，挤掉线 111 AUTH_UNLINK_ACCOUNT_ERRORUnlink account error 112 AUTH_GET_ALL_USER_IDS_ERRORGet all user ids error 113 AUTH_RESET_USER_ERRORReset user error，重置用户错误 114 AUTH_SWITCH_USER_ERRORSwitch user error，切换用户错误 116 AUTH_USER_FREEZE_TEMPORARY临时冻结账户 117 AUTH_USER_FREEZE_PERMANENT永久冻结账户 119 AUTH_CREDENTIAL_NO_GOOGLE_ACCOUNT谷歌账号未登录处理 200 BANK_CREATE_ORDER_ERROR创建订单错误 205 BANK_PURCHASE_FAILURE购买失败 206 BANK_PURCHASE_CANCEL购买取消 216 BANK_PURCHASE_RESULT_UNKNOWN购买结果未知 217 BANK_GET_CURRENT_BALANCE_ERROR获取当前余额失败 218 BANK_GET_BALANCE_INFO_ERROR获取余额信息失败 220 BANK_PURCHASE_NO_GOOGLE_ACCOUNT购买失败 no google account 222 BANK_REPAY_ERROR重新购买失败 299 BANK_NOTIFY_ERROR通知服务端失败 901 PARAMETER_ERROR参数错误 903 LCM_NETWORK_ERROR网络异常 409 BIND_ACCOUNT_ERROR绑定账号错误，该facebook/line账号已经被link过，请换一个facebook/line账号进行link. 411 BIND_ACCOUNT_FREQUENT_ERROR绑定账号太频繁，每个月只能绑定一次