公共SDK客户端接入文档.md
50.5 KB
公共SDK接入文档
接入必读
注意!cp需在获取以下权限收到回调后才能调用公共的其他api接口
android.permission.WRITE_EXTERNAL_STORAGE
android.permission.READ_PHONE_STATE
接入公共SDK测试没问题后游戏打出一个母包，需要上哪个渠道使用打包工具进行打对应渠道包。
1、开发环境搭建
以下是以 Eclipse 为例,在 Eclipse 环境下开发的 SDK 配置(AS接入方式一样)
1.1、将 SDK 压缩包中 libs 目录下的所有 资源 包复制到游戏工程的libs 目录下
1.2、复制SDK压缩包中assets目录下的所有内容到游戏工程的assets目录
- 将游戏中的闪屏图片放到assets中poolsdk_splash目录下（选用，图片文件名任意，最多支持2张闪屏）
- 将assets中的poolsdk.xml文件替换（具体文件请与相关人员申请）
1.3、修改游戏工程的AndroidManifest.xml（可以参照复制Demo中 AndroidManifest.xml文件）
- 添加声明权限：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
2、功能接口 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用)
2.1、继承 PoolSDKApplication(必接)
游戏工程如果没有Application，请在 AndroidManifest.xml 中添加SDK的Application，如下所示:
<application android:name="com.gzpublic.app.sdk.application.PoolSDKApplication">
游戏工程如果有 Application,请继承 SDK 中 PoolSDKApplication:
public class XXXXApplication extends PoolSDKApplication {
@Override
public void onCreate() {
// TODO Auto-generated method stub
super.onCreate();
}
}
2.2、初始化接口(必接)
注意: 初始化接口必须在调用权限回调以后再调用
接口说明:
首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调
监听(在初始化失败情况下不 再调用其它 SDK 接口方法)
注意:要确保在 SDK 初始化成功后才可调用其它接口
2.2.1、方法定义
public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener)
2.2.2、参数说明
| 参数 | 说明 |
|---|---|
| activity | Activity 对应 |
| callBackListener | 初始化完成回调通知,需实现 poolSdkCallBack 方法 |
2.2.3、代码示例:
PoolSdkHelper.init(this, new PoolSDKCallBackListener() {
@Override
public void poolSdkCallBack(int code, String msg) {
// TODO Auto-generated method stub
PoolSdkLog.logInfo("callback: code:" + code + "msg:" + msg);
switch (code) {
case PoolSDKCode.POOLSDK_INIT_SUCCESS:// 初始化成功
PoolSdkLog.logInfo("游戏中POOLSDK_INIT_SUCCESS");
login();
break;
case PoolSDKCode.POOLSDK_INIT_FAIL:
break;
case PoolSDKCode.POOLSDK_QUERY_WITH_PRODUCTS://查询商品信息返回
//msg:为查询的结果值
/**
* {//查询商品信息返回数据
* "android.test.purchased0": {//key为商品ID
* "displayPrice": "￦1167.28",//显示价格
* "price": "￦1,167", //实际价格(去除小数点) 充值传递
* "priceAmountMicros": 1167284249, //数字价格
* "priceCurrencyCode": "KRW", //货币代码
* "sku": "android.test.purchased0",//商品ID
* "title": "名称示例"
* }
* }
*/
break;
}
}
});
2.3、登录接口(必接)
接口说明:游戏登录时调用
2.3.1、方法定义
public static void login(final String paramCustom,final PoolLoginListener poolLoginListener)
2.3.2、参数说明
| 参数 | 说明 |
|---|---|
| paramCustom | 游戏自定义参数,可通过登录成功回调方法onLoginSuccess 中的参数PoolLoginInfo 对象的 getCustom()获取 |
| poolLoginListener | 登录结果回调通知,需实现 onLoginSuccess 方法 |
2.3.3、代码示例
PoolSdkHelper.login("登录自定义字段", new PoolLoginListener() {
@Override
public void onLoginSuccess(PoolLoginInfo poolLoginInfo) {
String userType = poolLoginInfo.getUserType();
String timestamp = poolLoginInfo.getTimestamp();
String serverSign = poolLoginInfo.getServerSign();
String openId = poolLoginInfo.getOpenID();
//把以上信息发送给游戏服务端做登录校验，需要其他信息请从poolLoginInfo对象中获取
System.out.println("登录成功 userType = " + userType
+ "; timestamp = " + timestamp + "; serverSign = "
+ serverSign + "; openId = " + openId);
}
@Override
public void onLoginFailed(String errorMsg) {
System.out.println("登录失败 = " + errorMsg);
}
});
2.4、提交角色数据接口(必接)
接口说明:游戏提交角色数据接口,该接口需要在以下3中情况下调用:
进入游戏主场景、创建角色、角色更新
(如果游戏创建角色时没有角色名，需要在用户创建角色名时调用多一次进入游戏统计，否则用户名无法正常统计，投放测试无法通过)
2.4.1、方法定义
public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRoleListener poolRoleListener)
2.4.2、参数说明
| 参数 | 说明 |
|---|---|
| poolRoleInfo | 角色数据实体类 |
| poolRoleListener | 角色数据提交结果回调通知,需实现 |
PoolRoleInfo 实体类字段说明（以下参数都为必传参数，如游戏没有的传 "无" 或者 "0"）
| 字段名 | 说明 |
|---|---|
| callType | 调用类型Type_EnterGame 登录游戏主 场景;Type_CreatRole 为创建角 色;Type_RoleUpgrade 为角色更新 |
| roleId | 角色 Id（请用数字） |
| roleName | 角色名称 |
| roleLevel | 角色等级 （请用数字） |
| roleSex | 角色性别(1 男 0 女,如果角 色不分性别请填写 0) |
| serverId | 服务器 id （请用数字） |
| serverName | 服务器名称 |
| custom | 自定义字段 |
| roleCTime | 角色创建时的时间戳(以秒为单位) （请用数字） |
| partyName | 公会名称 （没有的传 "无"） |
| roleType | 角色类型 （没有的传 "无"） |
| roleChangeTime | 角色等级变化时的时间戳(以秒为单位) （请用数字） |
| vipLevel | VIP等级 （请用数字，如无请传"0"） |
| diamond | 余额 （请用数字，如无请传"0"） |
| moneyType | 商品单位 （如 "钻石"、"金币"、"水晶"等） |
2.4.3、代码示例
/********************************************
* 以下所有字段都是必填项
*/
PoolRoleInfo poolRoleInfo = new PoolRoleInfo();
poolRoleInfo.setRoleID("123456");
poolRoleInfo.setRoleLevel("10");
poolRoleInfo.setRoleSex("0");
poolRoleInfo.setRoleName("我是角色名");
poolRoleInfo.setServerID("1");
poolRoleInfo.setServerName("我是服务器名");
poolRoleInfo.setCustom("角色创建时间");
poolRoleInfo.setRoleCTime(System.currentTimeMillis()/1000);//角色创建时（秒）
poolRoleInfo.setPartyName("公会名称");
poolRoleInfo.setRoleType("狂战");//角色类型
poolRoleInfo.setRoleChangeTime(System.currentTimeMillis()/1000);//角色更新时间
poolRoleInfo.setVipLevel("10");//vip等级
poolRoleInfo.setDiamond("1000");//余额
poolRoleInfo.setMoneyType("金币");//商品单位
poolRoleInfo.setCallType(PoolRoleInfo.Type_EnterGame);//进入游戏（第一次创建角色后需再调用一次进入游戏）
// poolRoleInfo.setCallType(PoolRoleInfo.Type_CreateRole);//创建角色(如果游戏创建角色时没有角色名，需要在用户创建角色名时调用多一次进入游戏统计，否则用户名无法正常统计，投放测试无法通过)
// poolRoleInfo.setCallType(PoolRoleInfo.Type_RoleUpgrade);//角色升级
PoolSdkHelper.submitRoleData(poolRoleInfo, new PoolRoleListener() {
@Override
public void onRoleDataSuccess(String paramCustom) {
System.out.println("提交角色数据成功 = " + paramCustom);
}
});
2.5、支付接口(必接)
2.5.1、方法定义
public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
2.5.2、参数说明
| 参数 | 说明 |
|---|---|
| poolRoleInfo | 角色数据实体类 |
| poolRoleListener | 角色数据提交结果回调通知,需实现 |
支付信息实体类(PoolPayInfo)字段说明
| 参数 | 说明 |
|---|---|
| amount | 金额(单位元,必须大于 0,需传入整型数据传小数时兑换比例和金额相乘为整数) |
| productId | 商品 ID(如果没有可以传空字符 串) |
| productName | 商品描述 |
| roleid | 角色 id |
| rolelevel | 角色等级 |
| roleName | 角色名称 |
| serverId | 服务器 id |
| serverName | 服务器名称 |
| exchange | 游戏币与人民币(元)的兑换比例 单机游戏时直接传对应购买的道具数量或游戏币数量
|
| custom | 自定义透传参数,通过回调函数原样返回 |
2.5.3、代码示例
/********************************************
* 以下所有字段都是必填项
*/
// 设置充值金额，单位“元”
poolPayInfo.setAmount("1");
// 服务器id
poolPayInfo.setServerID("8");
// 服务器名
poolPayInfo.setServerName("我是服务器名");
// 角色id
poolPayInfo.setRoleID("123456");
// 角色名
poolPayInfo.setRoleName("我是角色名");
// 角色等级
poolPayInfo.setRoleLevel("10");
// 商品ID
poolPayInfo.setProductID("1");
// 商品名称
poolPayInfo.setProductName("金币");
// 商品描述
poolPayInfo.setProductDesc("购买金币");
// 兑换比例
poolPayInfo.setExchange("10");
// 自定义参数
poolPayInfo.setCustom("我是自定义参数");
// 充值回调以服务端回调为准
PoolSdkHelper.pay(poolPayInfo, new PoolPayListener() {
@Override
public void onPaySuccess(String paramCustom) {
System.out.println("支付成功 = " + paramCustom);
}
@Override
public void onPayFailed(String paramCustom, String errorMsg) {
System.out.println("支付失败 = " + paramCustom + "; errorMsg = "
+ errorMsg);
}
});
2.6、检测 SDK 是否含有用户中心接口(必接)
说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心接口;
如果返回 false,则不做处理
2.6.1、方法定义
public static boolean hasChannelCenter()
2.7、用户中心接口(必接)
说明:打开渠道用户中心界面
2.7.1、方法定义
public static void openChannelCenter()
2.7.2、代码示例
/**
* 用户中心
*
* 游戏方先调用PoolSdkHelper.hasChannelCenter()获取是否有用户中心，
* 如果有的话，游戏中需要添加按钮，点击按钮调用PoolSdkHelper.openChannelCenter();
* 如果没有，则不需要显示按钮，也不用调用下面的接口
*/
private void channelCenter() {
PoolSdkHelper.openChannelCenter();
}
2.8、注销登录监听接口
说明:可在游戏启动时设置注销监听事件,渠道注销成功后 SDK 会回调 onLogoutSuccess 方法通知游戏,游戏可在此处理切换账号逻辑
2.8.1、方法定义
public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener)
2.8.2、参数说明
| 参数 | 说明 |
|---|---|
| poolLogoutListener | 账户注销成功回调监听,需实现 onLogoutSuccess 方法 |
2.8.3、代码示例
PoolSdkHelper.setLogoutCallback(new PoolLogoutListener() {
@Override
public void onLogoutSuccess() {
// TODO: 此处处理SDK注销成功后的逻辑
login();
PoolSdkLog.logInfo("游戏中logoutSuccess");
}
});
2.9、切换账号接口
说明： 该接口包含有注销和切换账号两种方式， 游戏需要根据同时根据两种接口的逻辑进行处理和调用
1、当渠道走的是注销逻辑则成功后会回调到注销监听中，游戏可在对应回调中进行注销逻辑处理
2、当渠道走的是切换账号逻辑时，在切换账号成功后会回调到登录成功的监听结果中
2.9.1、方法定义
public static boolean hasLogout();
public static void logout(final Activity paramActivity) ;
public static boolean hasSwitchAccount();
public static void switchAccount(final Activity paramActivity)；
2.9.2、 代码示例
/**
* 处理是否显示切换账号入口
*/
if(PoolSdkHelper.hasLogout() || PoolSdkHelper.hasSwitchAccount()){
//满足此条件时游戏显示切换账号功能入口
}else{//不存在切换账号接口，游戏可自行处理对应逻辑
}
/**
* 切换账号功能实现
*/
if(PoolSdkHelper.hasLogout()){
//结果在注销监听回调中处理(参考文档2.8、注销登录监听接口)
PoolSdkHelper.logout(paramActivity);
}else if(PoolSdkHelper.hasSwitchAccount()){
//切换账号结果在登陆回调中处理
PoolSdkHelper.switchAccount(paramActivity);
}
2.10、退出游戏接口(必接)
说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界
面,为 true表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处
理退出逻辑且在确认 游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例)
2.10.1、方法定义
public static void showExitDialog(final PoolExitDialogListener exitDialogListener)
2.10.2、参数说明
| 参数 | 说明 |
|---|---|
| exitDialogListener | 退出结果回调监听,需实现 onDialogResult 方法 |
2.9.3、代码示例
@Override
public boolean dispatchKeyEvent(KeyEvent pKeyEvent) {
if (pKeyEvent.getKeyCode() == KeyEvent.KEYCODE_BACK
&& pKeyEvent.getAction() == KeyEvent.ACTION_DOWN) {
if (PoolSdkHelper.hasExitDialog()) {
PoolSdkHelper.showExitDialog(new PoolExitDialogListener() {
@Override
public void onDialogResult(int code, String msg) {
// TODO Auto-generated method stub
switch (code) {
case PoolSDKCode.EXIT_SUCCESS:// 退出成功游戏处理自己退出逻辑
finish();
// System.exit(0);
break;
case PoolSDKCode.EXIT_CANCEL:// 取消退出
break;
default:
break;
}
}
});
} else {
// TODO: 调用游戏的退出界面
showGameExitTips();
}
return false;
}
return super.dispatchKeyEvent(pKeyEvent);
}
2.11、Android 生命周期接口(必接) ###
注意:权限返回接口为必接接口，接入代码 PoolSdkHelper.onRequestPermissionsResult(requestCode, permissions, grantResults);
说明:在游戏 Activity 的 onStart、onPause、onResume、 onStop、onDestroy、onRestart、onNewIntent、 onActivityResult、onConfigurationChanged、onSaveInstanceState、onRestoreInstanceState、onWindowFocusChanged、onWindowAttributesChanged、onRequestPermissionsResult中分别调用对应的接口
2.10.1 代码示例
@Override
public void onStart() {
super.onStart();
PoolSdkHelper.onStart();
}
@Override
public void onStop() {
super.onStop();
PoolSdkHelper.onStop();
}
@Override
public void onDestroy() {
super.onDestroy();
PoolSdkHelper.onDestroy();
}
@Override
public void onResume() {
super.onResume();
PoolSdkHelper.onResume();
}
@Override
public void onPause() {
super.onPause();
PoolSdkHelper.onPause();
}
@Override
public void onRestart() {
super.onRestart();
PoolSdkHelper.onRestart();
}
@Override
public void onNewIntent(Intent intent) {
super.onNewIntent(intent);
PoolSdkHelper.onNewIntent(intent);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
PoolSdkHelper.onActivityResult(requestCode, resultCode, data);
}
@Override
public void onConfigurationChanged(Configuration newConfig) {
// TODO Auto-generated method stub
super.onConfigurationChanged(newConfig);
PoolSdkHelper.onConfigurationChanged(newConfig);
}
@Override
protected void onSaveInstanceState(Bundle outState) {
// TODO Auto-generated method stub
super.onSaveInstanceState(outState);
PoolSdkHelper.onSaveInstanceState(outState);
}
@Override
protected void onRestoreInstanceState(Bundle savedInstanceState) {
// TODO Auto-generated method stub
super.onRestoreInstanceState(savedInstanceState);
PoolSdkHelper.onRestoreInstanceState(savedInstanceState);
}
@Override
public void onWindowFocusChanged(boolean hasFocus) {
// TODO Auto-generated method stub
super.onWindowFocusChanged(hasFocus);
PoolSdkHelper.onWindowFocusChanged(hasFocus);
}
@Override
public void onWindowAttributesChanged(LayoutParams params) {
// TODO Auto-generated method stub
super.onWindowAttributesChanged(params);
PoolSdkHelper.onWindowAttributesChanged(params);
}
@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
// TODO Auto-generated method stub
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
PoolSdkHelper.onRequestPermissionsResult(requestCode, permissions, grantResults);
}
2.12、扩展接口(可选)
说明:该接口为扩展的万能接口,留作备用,目前游戏方可以不接入
2.11.1、方法定义
public static void expansionInterface(final String paramCustom,final PoolExpansionListener poolExpansionListener)
2.11.2、参数说明
| 参数 | 说明 |
|---|---|
| paramCustom | 自定义参数 |
| poolExpansionListener | 方法回调参数,实现onSuccess方法 |
2.13、获取渠道包标识(可选)
接口名称:PoolSdkHelper.getGameChannelId()
接口说明:获取在企业平台配置的渠道标识,返回类型为 String
接口名称:PoolSdkHelper. getChannelParameter1 ()
接口说明:获取在企业平台配置的渠道参数 1,返回类型为 String
接口名称:PoolSdkHelper. getChannelParameter2 ()
接口说明:获取在企业平台配置的渠道参数 2,返回类型为 String
2.14、获取渠道自定义参数(可选)
接口名称:PoolSdkHelper.getCustomValue()
接口说明:获取在企业平台配置的渠道自定义参数,返回类型为 String
2.15、打开论坛、社区接口
接口名称:PoolSkHelper.openForum()
接口说明:打开渠道的论坛界面
2.16、聊天统计 ###
说明：在用户发送聊天信息时调用该接口
public static void reportChat(final String content,String type，final String accountId,final String accountName, final int level, final String serverId,final String serverName)
参数说明：
| 参数 | 说明 |
|---|---|
| content | 聊天内容 |
| type | 聊天类型（世界，私聊等） |
| accountId | 角色ID |
| accountName | 角色名称 |
| level | 角色等级 |
| serverId | 服务器ID |
| serverName | 服务器名称 |
2.17、实名认证（防沉迷）接口
说明：游戏方需要渠道SDK实名认证信息时调用（请在登陆成功后再调用）
- 显示实名页面功能
/** 是否存在接口
* @param functionName (是否有实名页面界面接口传"hasRealNameVerifyView")
* @return true:为存在 false:不存在 */
public static boolean hasFunction(String functionName){
}
//回调结果到初始化监听接口中
public void poolSdkCallBack(int code, String msg) {
if(code== PoolSDKCode.POOLSDK_EXTENDS_CODE1)//实名认证成功才有回调
{
//msg为生日 格式(与查询的结果一样)：19900101
}
}
/** *
* 显示实名页面
* @param funcName 方法名 (显示实名认证页面接口"showRealNameVerifyView")
* @param param 传空Map
* @return
*/
public static String callFunc(String funcName, Map<Object, Object> param){}
- 查询实名状态结果
public String verifyRealName(Activity paramActivity)
默认返回 "" （空字符串）为渠道SDK没有实名认证接口，游戏方需要自己实现该功能
返回 "0" （字符串）为渠道有实名未认证，但该玩家未认证
如果有实名认证接口，渠道有返回生日则返回生日（如"19900101"）
没有请运营跟渠道确认，到底返回成年日期还是未成年日期
2.18、事件上报接口
/**
* @param context 传getApplicationContext()
* @param eventType 事件类型（PoolEventType类中获取对应事件类型）
* @param eventValue 参数值(充值时传PoolEventParameterName属性变量键值对)
*/
public static void trackEvent(Context context, String eventType, Map<String, Object> eventValue);
游戏许上报的事件类型有：
PoolEventType类中对应的类型：
POOL_RES_LOADED 资源加载完毕
POOL_TUTORIAL_COMPLETION 新手流程结束
POOL_FIRST_DAY_CHECKPOINT_TO_VALUE 副本关卡(创角首日达到的某个关卡)(具体关卡cp跟渠道沟通)
POOL_ENTER_PARTY 加入公会/联盟等
POOL_FIRST_DAY_UPDATE_TO_LEVEL1 首日更新到某个等级(具体等级cp跟渠道沟通)
POOL_UPDATE_TO_LEVEL 更新到某个等级
POOL_FIRST_RECHARGE 首冲
POOL_PAY_SUCCESS 充值成功
POOL_FIRST_DAY_RECHARGE_TO_VALUE 首日充值达到某个值时(具体数值cp跟渠道沟通)
POOL_BUY_MOUTH_CARD 购买月卡
POOL_BIG_RECHARGE 累积充值达到某个数额(具体数值cp跟渠道沟通)
POOL_RETAINED_2_DAY 领取七天礼包的第二天奖励时
POOL_RETAINED_3_DAY 领取七天礼包的第三天奖励时
POOL_RETAINED_7_DAY 领取七天礼包的第七天奖励时
POOL_FIRST_PURCHASE_FUND 首次成长基金充值
POOL_VIP_LEVEL_TO_TARGET_LEVEL vip达到某个等级
代码示例：
充值成功类型例子：
Map<String,Object> valueMap = new HashMap<>();
valueMap.put(PoolEventParameterName.POOL_ORDER_ID,System.currentTimeMillis()+"");//订单号
valueMap.put(PoolEventParameterName.POOL_CURRENCY,"USD");//货币类型 USD:美元 CNY：人民币
valueMap.put(PoolEventParameterName.POOL_PRICE,6);//充值金额
PoolSdkHelper.trackEvent(getApplicationContext(),PoolEventType.POOL_PAY_SUCCESS,valueMap);
其他类型例子：
PoolSdkHelper.trackEvent(getApplicationContext(), PoolEventType.POOL_RES_LOADED,null);
2.19、商品查询接口(查询结果返回在初始化回调中，具体可查看初始化接口或者Demo)
/**
* 拓展方法
*
* @param funcName 方法名(查询商品接口传"queryWithProducts")
* @param param 传递参数(此处Map传键为商品ID值为空)
* @return
*/
public static String callFunc(String funcName, Map<Object, Object> param) {
代码示例：
Map productMap = new HashMap<Object, Object>();
productMap.put("商品ID", "");
productMap.put("商品ID", "");
PoolSdkHelper.callFunc("queryWithProducts", productMap);
2.20、客服中心接口
-
判断是否有客服接口
/** * 是否存在接口 * @param functionName (客服中心传"hasAssistantCenter") * @return true:为存在 false:不存在 */ public static boolean hasFunction(String functionName){ }- 客服接口
/** *
* @param funcName 方法名 (客服中心传"openAssistantCenter")
* @param param 传空Map
* @return
*/
public static String callFunc(String funcName, Map<Object, Object> param){}
- 例子:
if(PoolSdkHelper.hasFunction("hasAssistantCenter"))
{//存在客服接口
Map<Object,Object> map = new HashMap<>(); PoolSdkHelper.callFunc("openAssistantCenter",map);
}
3、自测用例
3.1、接入环境下调用登录sdk会有默认测试账号进行登录，游戏会直接收到登录回调数据
- 成功收到登录回调，与服务端校验成功进入游戏
3.2、游戏点击充值在接入环境下sdk会直接进行充值数据校验，点击充值后游戏可查看服务端是否收到充值结果通知
- 后台配置正确的游戏充值回调地址可以进行充值测试是否到账
4、母包
4.1、接入公共 SDK 编译生成的 apk 即为打包工具使用的空白母包
5、单机无服务端时充值处理
5.1、设置充值监听，登录接口前调用
PoolSdkHelper.setPayListener(mPoolPayListener );
5.2、游戏发货成功时调用接口
PoolSdkHelper.paymentSuccess(AppActivity.this, orderIds.toString());
代码示例：
if(paramCustom == null || paramCustom.length() <= 0)
{
PoolSdkLog.logError("paysuccess data error :" + paramCustom);
return;
}
try {
PoolSdkLog.logInfo("paySuccess:" + paramCustom);
JSONArray jsonArray = new JSONArray(paramCustom);
StringBuilder orderIds = new StringBuilder();
int length = jsonArray.length();
for (int i = 0; i < length; i++) {
JSONObject jb = jsonArray.getJSONObject(i);
String orderId = jb.getString("orderId");
orderIds.append(orderId);
if(i != length -1) {//最后一项不加分割符
orderIds.append(",");
}
}
PoolSdkHelper.paymentSuccess(AppActivity.this, orderIds.toString());
} catch (JSONException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
6.游戏使用多dex打包需要注意的点
1、如果游戏接入公共SDK后使用了多dex打包，请确保公共SDK保持在第一个classes.dex文件 在defaultConfig中配置multiDexKeepProguard file('maindexlist.pro')
-keep class com.gzyouai.fengniao.sdk.*
-keep class com.gzyouai.fengniao.sdk.framework.*
-keep class com.gzyouai.fengniao.sdk.wxapi.*
-keep class com.gzyouai.publicsdk.application.*
2、如果母包需要每次出包Manifest中的配置改成相应的包名字段（例如推送和Provider） 则将包名写成 originPackageTag 打包工具会自动替换成目标包名
android:authorities="com.xxx.provider"
<!-- 写为下面这样既可 -->
android:authorities="originPackageTag.provider"
7. 完整的接入demo
package com.youai.foolsdk.demo;
import android.Manifest;
import android.app.Activity;
import android.app.AlertDialog;
import android.app.Application;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.res.Configuration;
import android.os.Build;
import android.os.Bundle;
import android.os.Handler;
import android.util.Log;
import android.view.KeyEvent;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.WindowManager.LayoutParams;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import com.gzpublic.app.sdk.framework.PoolEventParameterName;
import com.gzpublic.app.sdk.framework.PoolEventType;
import com.gzpublic.app.sdk.framework.PoolExitDialogListener;
import com.gzpublic.app.sdk.framework.PoolExitListener;
import com.gzpublic.app.sdk.framework.PoolExpansionListener;
import com.gzpublic.app.sdk.framework.PoolLoginInfo;
import com.gzpublic.app.sdk.framework.PoolLoginListener;
import com.gzpublic.app.sdk.framework.PoolLogoutListener;
import com.gzpublic.app.sdk.framework.PoolPayInfo;
import com.gzpublic.app.sdk.framework.PoolPayListener;
import com.gzpublic.app.sdk.framework.PoolPayOrderConfirmHandler;
import com.gzpublic.app.sdk.framework.PoolReport;
import com.gzpublic.app.sdk.framework.PoolRoleInfo;
import com.gzpublic.app.sdk.framework.PoolRoleListener;
import com.gzpublic.app.sdk.framework.PoolSDKCallBackListener;
import com.gzpublic.app.sdk.framework.PoolSDKCode;
import com.gzpublic.app.sdk.framework.PoolSdkConfig;
import com.gzpublic.app.sdk.framework.PoolSdkHelper;
import com.gzpublic.app.sdk.framework.PoolSdkLog;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
public class AppActivity extends Activity implements OnClickListener {
//新的view
private Button btLogin;
private Button btEnterGame;
private Button btPay;
private Button btLogout;
private Button btSubRoleInfo;
private Button btOpenChannel;
private Button btSwitchAcc;
private Button btOpenBbs;
private Button btQueryProducts;
private Button pb_bt_verifyname;
private Bundle saveBundle;
//提示LOG
private TextView txMsg,txSdkMsg;
private Activity mContext;
private PoolPayListener mPoolPayListener = new PoolPayListener() {
@Override
public void onPaySuccess(String paramCustom) {//支付回调以服务端通知为准
// TODO Auto-generated method stub
//[{"orderId":"20180116114151740535D825","state":0,"productId":"1","productName":"金币","amout":0}]
if(paramCustom == null || paramCustom.length() <= 0)
{
PoolSdkLog.logError("paysuccess data error :" + paramCustom);
return;
}
try {
PoolSdkLog.logInfo("paySuccess:" + paramCustom);
JSONArray jsonArray = new JSONArray(paramCustom);
StringBuilder orderIds = new StringBuilder();
int length = jsonArray.length();
for (int i = 0; i < length; i++) {
JSONObject jb = jsonArray.getJSONObject(i);
String orderId = jb.getString("orderId");
orderIds.append(orderId);
if(i != length -1) {//最后一项不加分割符
orderIds.append(",");
}
}
PoolSdkHelper.paymentSuccess(AppActivity.this, orderIds.toString());
} catch (JSONException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
upTx("支付成功回调：" + paramCustom);
}
@Override
public void onPayFailed(String paramCustom, String errorMsg) {
// TODO Auto-generated method stub
System.out.println("支付失败回调：" + paramCustom + "; errorMsg："
+ errorMsg);
upTx("支付失败回调：" + paramCustom + "; errorMsg："
+ errorMsg);
}
};
@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
PoolSdkHelper.onRequestPermissionsResult(requestCode, permissions, grantResults);
init(saveBundle);
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
saveBundle = savedInstanceState;
int layoutId = getResources().getIdentifier(
"public_sdk_self_test", "layout", getPackageName());
setContentView(layoutId);
mContext = this;
initView();
PoolSdkLog.setIsShowLog(true);
PoolSdkConfig.readPoolSdkConfigData(this);
if(getApplicationInfo().targetSdkVersion >= 23 && Build.VERSION.SDK_INT >= 23){
requestPermissions(new String[]{Manifest.permission.READ_PHONE_STATE,Manifest.permission.WRITE_EXTERNAL_STORAGE},1);
}else {//不需要权限直接调用init
this.init(savedInstanceState);
}
txSdkMsg.setText("sdksimplename:"+ PoolSdkConfig.getConfigByKey("sdksimplename")
+"\nsdkversioncode:"+PoolSdkConfig.getConfigByKey("sdkversioncode")
+"\ngamesimplename:"+PoolSdkConfig.getConfigByKey("gamesimplename")
+"\nlogincheckurl:"+PoolSdkConfig.getConfigByKey("logincheckurl")
);
}
private void init( Bundle savedInstanceState){
PoolSdkHelper.init(this, new PoolSDKCallBackListener() {
@Override
public void poolSdkCallBack(int code, String msg) {
PoolSdkLog.logInfo("poolSdkCallBack：code：" + code + "，msg：" + msg);
upTx("poolSdkCallBack：code：" + code + "，msg：" + msg);
switch (code) {
case PoolSDKCode.POOLSDK_INIT_SUCCESS:// 初始化成功
PoolSdkLog.logInfo("游戏中收到初始化成功回调");
new Handler().postDelayed(new Runnable() {
@Override
public void run() {
login();
}
}, 1000);
break;
case PoolSDKCode.POOLSDK_INIT_FAIL:
break;
case PoolSDKCode.POOLSDK_QUERY_WITH_PRODUCTS:
//msg:为查询的结果值
/**
* {//查询商品信息返回数据
* "android.test.purchased0": {//key为商品ID
* "displayPrice": "￦1167.28",//显示价格
* "price": "￦1,167", //实际价格(去除小数点) 充值传递
* "priceAmountMicros": 1167284249, //数字价格
* "priceCurrencyCode": "KRW", //货币代码
* "sku": "android.test.purchased0",//商品ID
* "title": "名称示例"
* }
* }
*/
break;
case PoolSDKCode.POOLSDK_EXTENDS_CODE1://实名认证成功才有回调
//msg为生日
break;
default:
break;
}
}
},savedInstanceState);// init(this);// this为游戏的activity对象
PoolSdkHelper.setPayListener(mPoolPayListener);
PoolSdkHelper.setLogoutCallback(new PoolLogoutListener() {
@Override
public void onLogoutSuccess() {
// TODO: 此处处理SDK登出的逻辑
PoolSdkLog.logInfo("游戏中收到logoutSuccess回调");
login();
}
});
PoolSdkHelper.trackEvent(getApplicationContext(), PoolEventType.POOL_RES_LOADED, null);
}
@Override
public void onStart() {
super.onStart();
PoolSdkHelper.onStart();
}
@Override
public void onStop() {
super.onStop();
PoolSdkHelper.onStop();
}
@Override
public void onDestroy() {
super.onDestroy();
PoolSdkHelper.onDestroy();
}
@Override
public void onResume() {
super.onResume();
PoolSdkHelper.onResume();
}
@Override
public void onPause() {
super.onPause();
PoolSdkHelper.onPause();
}
@Override
public void onRestart() {
super.onRestart();
PoolSdkHelper.onRestart();
}
@Override
public void onNewIntent(Intent intent) {
super.onNewIntent(intent);
PoolSdkHelper.onNewIntent(intent);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
PoolSdkHelper.onActivityResult(requestCode, resultCode, data);
}
@Override
public void onConfigurationChanged(Configuration newConfig) {
super.onConfigurationChanged(newConfig);
PoolSdkHelper.onConfigurationChanged(newConfig);
}
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
PoolSdkHelper.onSaveInstanceState(outState);
}
@Override
protected void onRestoreInstanceState(Bundle savedInstanceState) {
super.onRestoreInstanceState(savedInstanceState);
PoolSdkHelper.onRestoreInstanceState(savedInstanceState);
}
@Override
public void onWindowFocusChanged(boolean hasFocus) {
super.onWindowFocusChanged(hasFocus);
PoolSdkHelper.onWindowFocusChanged(hasFocus);
}
@Override
public void onWindowAttributesChanged(LayoutParams params) {
super.onWindowAttributesChanged(params);
PoolSdkHelper.onWindowAttributesChanged(params);
}
@Override
public boolean dispatchKeyEvent(KeyEvent pKeyEvent) {
if (pKeyEvent.getKeyCode() == KeyEvent.KEYCODE_BACK
&& pKeyEvent.getAction() == KeyEvent.ACTION_DOWN) {
if (PoolSdkHelper.hasExitDialog()) {
PoolSdkHelper.showExitDialog(new PoolExitDialogListener() {
@Override
public void onDialogResult(int code, String msg) {
switch (code) {
case PoolSDKCode.EXIT_SUCCESS:
// 退出成功游戏处理自己退出逻辑
PoolSdkLog.logInfo("游戏调用自己退出逻辑");
finish();
System.exit(0);
break;
case PoolSDKCode.EXIT_CANCEL:
// 取消退出
PoolSdkLog.logInfo("收到取消退出回调");
break;
default:
break;
}
}
});
} else {
// TODO: 调用游戏的退出界面
showGameExitTips();
}
return false;
}
return super.dispatchKeyEvent(pKeyEvent);
}
private void showGameExitTips() {
AlertDialog.Builder dialog = new AlertDialog.Builder(this);
int ic_dialog_alert_id = getRedIdByName("ic_dialog_alert", "drawable");
dialog.setIcon(ic_dialog_alert_id);
dialog.setTitle("提示");
dialog.setMessage("是否退出游戏?");
dialog.setPositiveButton("确定", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
PoolSdkHelper.exitGame(new PoolExitListener() {
@Override
public void onExitGame() {
finish();
}
});
}
});
dialog.setNegativeButton("取消", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
dialog.dismiss();
}
});
dialog.show();
}
private int getRedIdByName(String resName, String resType) {
return getResources().getIdentifier(resName, resType, getPackageName());
}
private void initView(){
btLogin = (Button) findViewById(getRedIdByName("pb_bt_login", "id"));
btEnterGame = (Button) findViewById(getRedIdByName("pb_bt_entergame", "id"));
btPay = (Button) findViewById(getRedIdByName("pb_bt_pay", "id"));
btLogout = (Button) findViewById(getRedIdByName("pb_bt_logout", "id"));
btSubRoleInfo = (Button) findViewById(getRedIdByName("pb_bt_subrole", "id"));
btOpenChannel = (Button) findViewById(getRedIdByName("pb_bt_openchannel", "id"));
btSwitchAcc = (Button) findViewById(getRedIdByName("pb_bt_switchacc", "id"));
btOpenBbs = (Button) findViewById(getRedIdByName("pb_bt_openbbs", "id"));
btQueryProducts = findViewById(getRedIdByName("pool_query_products_id","id"));
pb_bt_verifyname = (Button) findViewById(getRedIdByName("pb_bt_verifyname", "id"));
txMsg = (TextView) findViewById(getRedIdByName("tx_msg", "id"));
txSdkMsg = (TextView) findViewById(getRedIdByName("tx_sdk_msg", "id"));
btLogin.setOnClickListener(this);
btEnterGame.setOnClickListener(this);
btPay.setOnClickListener(this);
btLogout.setOnClickListener(this);
btSubRoleInfo.setOnClickListener(this);
btOpenChannel.setOnClickListener(this);
btSwitchAcc.setOnClickListener(this);
btOpenBbs.setOnClickListener(this);
btQueryProducts.setOnClickListener(this);
pb_bt_verifyname.setOnClickListener(this);
}
public void yaOnClick(View view) {
}
@Override
public void onClick(View view) {
//新view
if (view == btLogin) {
login();
}else if (view == btEnterGame) {
submitRoleData(10,PoolRoleInfo.Type_EnterGame);
//PoolReport.reportEnterGame("chufan","角色名", 12, "201","服务器名");
}else if (view == btPay) {
pay();
}else if (view == btLogout) {
logout();
}else if (view == btSubRoleInfo) {
submitRoleData(11,PoolRoleInfo.Type_RoleUpgrade);
}else if (view == btOpenChannel) {
channelCenter();
}else if (view == btSwitchAcc) {
switchAccount();
}else if (view == btOpenBbs) {
trackEvent();
}else if(view == btQueryProducts){
queryProducts();
}else if (view == pb_bt_verifyname){
Toast.makeText(this,PoolSdkHelper.verifyRealName(this),Toast.LENGTH_SHORT).show();
}
}
private void trackEvent(){
Map<String,Object> valueMap = new HashMap<>();
valueMap.put(PoolEventParameterName.POOL_ORDER_ID,System.currentTimeMillis()+"");//订单号
valueMap.put(PoolEventParameterName.POOL_CURRENCY,"USD");//货币类型 USD:美元 CNY：人民币
valueMap.put(PoolEventParameterName.POOL_PRICE,6);//充值金额
PoolSdkHelper.trackEvent(getApplicationContext(), PoolEventType.POOL_RES_LOADED,valueMap);
}
private void logout(){
// if(PoolSdkHelper.hasLogout()){
// PoolSdkHelper.logout(this);//结果回调通知到PoolLogoutListener
// }
}
private void upTx(final String msg){
mContext.runOnUiThread(new Runnable() {
@Override
public void run() {
txMsg.setText(msg);
}
});
// new Handler().post(new Runnable() {
//
// @Override
// public void run() {
// txMsg.setText(msg);
// }
// });
}
private void login() {
PoolSdkLog.logError("调用login");
PoolSdkHelper.login("登录自定义字段", new PoolLoginListener() {
@Override
public void onLoginSuccess(PoolLoginInfo poolLoginInfo) {
final String userType = poolLoginInfo.getUserType();
final String timestamp = poolLoginInfo.getTimestamp();
final String serverSign = poolLoginInfo.getServerSign();
final String openId = poolLoginInfo.getOpenID();
// TODO: 把以上信息发送给游戏服务端做登录校验，需要其他信息请从poolLoginInfo对象中获取
System.out.println("登录成功回调：userType = " + userType
+ "; timestamp = " + timestamp + "; serverSign = "
+ serverSign + "; openId = " + openId);
upTx("登录成功回调：userType = " + userType
+ "; timestamp = " + timestamp + "; serverSign = "
+ serverSign + "; openId = " + openId);
}
@Override
public void onLoginFailed(final String errorMsg) {
System.out.println("登录失败回调 ：" + errorMsg);
upTx("登录失败回调 ：" + errorMsg);
}
});
PoolPayOrderConfirmHandler.getInstance(this, 2000, 1000).startOrderConfirmOp(mPoolPayListener);
}
private void pay() {
final PoolPayInfo poolPayInfo = new PoolPayInfo();
/********************************************
* 以下所有字段都是必填项
*/
// 设置充值金额，单位“元”
poolPayInfo.setAmount("100");
// 服务器id
poolPayInfo.setServerID("1209");
// 服务器名
poolPayInfo.setServerName("我是服务器名");
// 角色id
poolPayInfo.setRoleID("123456");
// 角色名
poolPayInfo.setRoleName("我是角色名");
// 角色等级
poolPayInfo.setRoleLevel("10");
// 商品ID
poolPayInfo.setProductID("1");
// 商品名称
poolPayInfo.setProductName("金币");
// 商品描述
poolPayInfo.setProductDesc("购买金币");
// 兑换比例
poolPayInfo.setExchange("10");
// 自定义参数
poolPayInfo.setCustom("我是自定义参数");
// TODO Auto-generated method stub
PoolSdkHelper.pay(poolPayInfo, mPoolPayListener);
}
/**
* 提交角色数据 该接口需要在3个地方调用
*
* 1、登录游戏主场景 2、创建角色 3、角色升级
*/
private void submitRoleData(int level,String callType) {
/********************************************
* 以下所有字段都是必填项
*/
final PoolRoleInfo poolRoleInfo = new PoolRoleInfo();
poolRoleInfo.setRoleID("123456");
poolRoleInfo.setRoleLevel(level+"");
poolRoleInfo.setRoleSex("0");
poolRoleInfo.setRoleName("我是角色名");
poolRoleInfo.setServerID("1209");
poolRoleInfo.setServerName("我是服务器名");
poolRoleInfo.setCustom("角色创建时间");
poolRoleInfo.setRoleCTime((long)1509331962);//角色创建时间（秒）
poolRoleInfo.setPartyName("公会名称");
poolRoleInfo.setRoleType("狂战");//角色类型
poolRoleInfo.setRoleChangeTime(System.currentTimeMillis()/1000);//角色更新时间
poolRoleInfo.setVipLevel("10");//vip等级
poolRoleInfo.setDiamond("1000");//余额
poolRoleInfo.setMoneyType("金币");//商品单位
poolRoleInfo.setCallType(callType);
// poolRoleInfo.setCallType(PoolRoleInfo.Type_CreateRole);
// poolRoleInfo.setCallType(PoolRoleInfo.Type_RoleUpgrade);
PoolSdkHelper.submitRoleData(poolRoleInfo, new PoolRoleListener() {
@Override
public void onRoleDataSuccess(String paramCustom) {
System.out.println("提交角色数据成功：" + poolRoleInfo.verboseInfo());
upTx("提交角色数据成功：" + poolRoleInfo.verboseInfo());
}
});
}
/**
* 用户中心
*
* 游戏方先调用PoolSdkHelper.hasChannelCenter()获取是否有用户中心，
* 如果有的话，游戏中需要添加按钮，点击按钮调用PoolSdkHelper.openChannelCenter();
* 如果没有，则不需要显示按钮，也不用调用下面的接口
*/
private void channelCenter() {
PoolSdkHelper.openChannelCenter();
}
/**
* 切换帐号
*/
private void switchAccount() {
if(PoolSdkHelper.hasLogout()){
PoolSdkHelper.logout(this);//注销成功后结果回调通知到PoolLogoutListener中
}else if(PoolSdkHelper.hasSwitchAccount()){
PoolSdkHelper.switchAccount(this);//切换成功后回回调结果到登录成功通知中(与登录通知数据一样)
}else{//渠道不存在注销和切换账号接口，游戏可自定处理逻辑
}
}
/**
* 扩展接口
*/
private void expansionInterface() {
PoolSdkHelper.expansionInterface("自定义参数", new PoolExpansionListener() {
@Override
public void onSuccess(String paramCustom) {
}
});
}
/**
* 商品查询接口
*/
private void queryProducts(){
PoolSdkLog.logError(PoolSdkHelper.hasFunction("hasQueryWithProducts") + "SSS");
Map productMap = new HashMap<Object,Object>();
productMap.put("productId1","");
productMap.put("productId2","");
PoolSdkHelper.callFunc("queryWithProducts",productMap);
}
}