梦工厂 SDK 安卓网游对接文档 V1.0 版本号时间变更内容 初始化版本

Transcription

1 梦工厂 SDK 安卓网游对接文档 V1.0 版本号时间变更内容 初始化版本

2 目录 接入说明 谁来阅读此文档 注意事项 名词定义 导入和配置 sdk 导入配置 sdk 总体说明 获取参数 获取对接 demo 导入配置 sdk 资源 配置清单文件 ( 具体请参考 demo) 适配 android 6.0 以上系统 适配 android 7.0 新的签名机制 混淆配置说明 获得 sdk 全局管理类对象 SDK 全局管理类 初始化 sdk 添加登陆回调监听 添加登陆回调监听 调起登陆 调起 sdk 支付页面 : 浮点 显示浮点 隐藏浮点 登出回调监听 添加登出回调监听 退出账号 切换账号 注销 sdk 提交角色信息... 21

3 1 接入说明 1.1 谁来阅读此文档 接入 CP/ 发行的产品, 技术人员, 平台技术人员 1.2 注意事项 接口参数大小写敏感 request 和 response 的编码格式为 UTF 名词定义 名词 CP APP 说明 游戏合作商 接入平台的游戏 APP_ID 接入时由平台分配的游戏 ID Gameid client_id client_key APP_KEY 平台方 XX 游戏 id 同 APP_ID 客户端 ID 客户端 KEY 接入时由平台分配的游戏密钥 平台运营商简称 2 导入和配置 sdk 2.1 导入配置 sdk 特别注意 1. 适配 android 6.0 及以上系统的权限和文件访问问题 : 见文中提到的第 5 点 2. 适配 android 7.0 改了签名模式导致的分包安装提示证书错误问题 : 见文中提到的第 6 点

4 2.2 总体说明 此对接文档只适合于 sdk v7 版本 所有 sdk 的功能, 都在 MgcSdkManager 类中, 可通过初始化接口获得该类对象, 后面所有的功能都通过调用这个类中的方法完成 文档里面所有的 sdkmanager 均指 sdk 初始化获得 MgcSdkManager 对象 2.3 获取参数 从平台处, 获取以下参数, 用于对接, 填入清单文件对应的 meta 信息里 参数名 说明 app_id 游戏 ID app_key 游戏加密密钥 client_id SDK ID 标识此次对接 demo 的 sdk client_key SDKkey 此次对接 demo 的渠道 key 2.4 获取对接 demo 从平台处获取对接 demo, 包括 android studio 版本, 选择合适的版本接入 2.5. 导入配置 sdk 资源 android studio 项目 : 1. 导入 MgcSdkLib 到自己的项目中, 打开自己的项目, 菜单 File-New-Import Moudle, 如下图所示 :

5 2. 选择对接获得的 MgcSdkLib 导入, 如下图所示 :

6 3. 将导入的 MgcSdkLib 和自己项目进行依赖关联, 如下图所示 :

7 4. 适配 android6.0 和配置混淆相关, 如下图所示 : 2.6. 配置清单文件 ( 具体请参考 demo) 1. 参考 demo 中的清单文件配置, 主要分为权限配置 sdk 所需的组件配置, 还有支付所需的组件配置,meta 信息配置 2. 将 MgcSdkLib 中的 assets 目录中的文件复制到游戏主项目的 assets 目录下 3. 将梦工厂提供的游戏必要参数填入清单文件中对应的 meta 信息配置的值中即可 4. 竖屏游戏请参考 demo 中的 sdkdemo\src\portrait_sdk 文件下清单文件, 横屏游戏参考 sdkdemo\src\landscape_sdk 文件下清单文件 2.7 适配 android 6.0 以上系统 需要将应用运行的目标版本 targetsdkversion 改到 22(23 以下都可以 ) android studio 版本 : 在应用 moudle 下的 build.gradle 文件中修改 defaultconfig 下的 targetsdkversion 版本为 22, 具体看参考 demo 中的配置

8 2.8 适配 android 7.0 新的签名机制 android studio 请在打包的时候, 设置签名中添加 v2signingenabled false: 1. signingconfigs { 2. debug { 3. v2signingenabled false 4. } 5. release { 6. v2signingenabled false 7. } 8. } 2.9 混淆配置说明 sdk 代码已经经过混淆, 请不要再次混淆 sdk 代码, 请将 MgcSdkLib 目录下的 proguard-project.txt 中的混淆配置复制到自己项目的混淆配置文件中即可 3 获得 sdk 全局管理类对象 3.1 SDK 全局管理类 1. public static synchronized MgcSdkManager getinstance() 说明 :sdk 初始化操作方法, 最先调用, 需要在主线程调用, 最好游戏主界面 activity 中调用 此方法的可多次调用用于获得 sdk 全局管理器 参数 : context 上下文对象, 一般是游戏主界面 activity 返回 :sdk 全局管理器 调用示例 : 在游戏主界面 activity 的 oncreate 方法中调用 1. MgcSdkManager sdkmanager;

9 3. protected void oncreate(bundle savedinstancestate) { 4. super.oncreate(savedinstancestate); 5. setcontentview(r.layout.activity_main); 6. //Sdk 获得管理类对象 7. sdkmanager = MgcSdkManager.getInstance(); 8. } 3.2 初始化 sdk 1. public void initsdk(context context,oninitsdklistener oninitsdklistener) 参数 : context 上下文对象, 一般是游戏主界面 activity oninitsdklistener: 初始化回调接口 调用示例 : 建议游戏主界面 activity 的 oncreate 方法中调用, 后续所有功能 都需要初始化成功才能调用 1. //sdk 初始化 2. sdkmanager.initsdk(this,new OnInitSdkListener() { 4. public void initsuccess(string code, String msg) { 5. Log.e(TAG,"initSdk="+msg); 6. } 8. public void initerror(string code, String msg) { 9. T.s(MainActivity.this,msg); 10. } 11. }); 4 添加登陆回调监听 4.1 添加登陆回调监听 1. public void addloginlistener(onloginlistener onloginlistener)

10 说明 : 在登陆前必须注册登陆回调监听, 用于接收登陆结果 ( 用户在个人中 心切换账号登陆, 也会进行回调 ) 参数 : 参数 说明 onloginlistener 登陆的回调接口 参数类说明 :OnLoginListener 需要实现两个方法 : 登陆成功 : 1. void loginsuccess(logincallback logincallback); 登陆失败 2. void loginerror(loginerrormsg errormsg); LoginCallBack 中包含 : 名字 说明 mem_id 登陆成功返回的用户 id user_token 登陆成功后返回的 token LoginErrorMsg 中包含 : 名字 说明 code 登陆失败返回的错误码 (-2 为用户取消了登陆 ) msg 登陆失败返回的错误信息

11 4.2 调起登陆 1. public void showlogin(boolean isshowquiklogin) 说明 : 调起登陆界面, 登陆结果会回调给前面添加的登陆回调, 调用前必须 先添加登陆回调监听 ( 见 1 添加登陆回调监听 ) 参数 : 参数 说明 isshowquiklogin 是否显示快速登陆,true: 显示,false: 不显示 ( 之前有登陆过, 设置此参数为 true 则会进行快速登陆 ) 调用示例 : 1. // 添加 sdk 登陆监听, 包含正常登陆, 切换账号登陆, 登陆过期后重新登陆 2. sdkmanager.addloginlistener(new OnLoginListener() { 4. public void loginsuccess(logincallback logincback) { 5. Log.e(TAG," 登陆 memid="+ 6. logincback.mem_id+" token="+logincback.user_token); 7. T.s(MainActivity.this," 登陆成功 "); 8. // 一般登陆成功后需要显示浮点 9. sdkmanager.showfloatview(); 10. } 12. public void loginerror(loginerrormsg loginerrormsg) { 13. } 14. }); 15. sdkmanager.showlogin(true);

12 5. 调起 sdk 支付页面 : 1. public void showpay(custompayparam payparam, OnPaymentListener paymentlistener) 说明 : 调用此方法进入支付页面, 在传递的回调接口中接收支付结果 参数 : 参数 说明 payparam 支付的参数 paymentlistener 支付的结果回调接口 参数具体说明 : CustomPayParam 类说明 : 字段名必选类型说明 cp_order_id 是 STRING 游戏传入的外部订单号 服务器会根据这个订单号生成对应的平台订单号, 请保证每笔订单传入的订单号的唯一性 product_price 是 STRING 商品价格 ( 元 ); 建议传入整数, 可以保 留两位小数 product_count 是 INT 商品数量 ( 除非游戏需要支持一次购 买多份商品 ), 默认为 1 product_id 是 STRING 商品 id, 没有此值需传入大于 0 的整 数型字符串, 例如 : 1 ; product_name 是 STRING 商品名称 : 数量 + 空格 + 道具名称, eg:10 元宝

13 字段名必选类型说明 product_desc 是 STRING 商品描述 ( 不传则使用 product_name) 默认为 product_name; 数量 + 空格 + 道具名称,eg:10 元宝 exchange_rate 是 STRING 虚拟币兑换比例 ( 例如 100, 表示 1 元购买 100 虚拟币 ) 默认为 0 currency_name 是 STRING 虚拟币名称 ( 如金币 元宝 ) 默认 为 ext 是 STRING CP 自定义扩展字段透传信息默认 为 roleinfo 是 RoleInfo 类角色信息类 roleinfo.role_type 是 INT 数据类型, 默认 1,(1 为进入游戏,2 为创建角色,3 为角色升级 5 其他 ) roleinfo.server_id 是 STRING 游戏服务器 id roleinfo.server_n ame 是 STRING 游戏服务器名称 roleinfo.role_id 是 STRING 玩家角色 id roleinfo.role_nam e 是 STRING 玩家角色名称 roleinfo.party_na me 是 STRING 工会 帮派名称, 如果没有, 请填 空字符串

14 字段名必选类型说明 roleinfo.role_level 是 int 玩家角色等级, 如果没有, 请填 0 roleinfo.role_vip 是 int 玩家 vip 等级, 如果没有, 请填 0 roleinfo.role_bale nce 是 float 玩家游戏中游戏币余额, 如果没有 账户余额, 请填 0 roleinfo.rolelevel_ ctime 否 STRING 玩家创建角色的时间时间戳 ( 单位 秒 ), 默认 0 roleinfo.rolelevel_ mtime 否 STRING 玩家角色等级变化时间时间戳 ( 单位 秒 ), 默认 0 OnPaymentListener 类说明 支付成功回调方法 : 1. public void paymentsuccess(paymentcallbackinfo callbackinfo) 支付失败回调方法 : 1. public void paymenterror(paymenterrormsg errormsg) 兑换成功回调方法 : 1. public void exchargesuccess(paymentcallbackinfo callbackinfo) PaymentCallbackInfo 类说明 字段名 说明 money 支付成功的金额

15 字段名 说明 msg 支付成功提示 PaymentErrorMsg 类说明 字段名 说明 money 待支付的金额 msg 支付失败提示信息 code 支付失败的错误码 (-1: 支付失败,-2 用户取消支付 ) orderid 订单号 cporderid cp 订单号 调用示例 : 1. // 初始化测试的支付参数 2. private void inittestparam(custompayparam payparam,string money) { 3. payparam.setcp_order_id(" "); 4. payparam.setproduct_price(float.parsefloat(money)); 5. payparam.setproduct_count(1); 6. payparam.setproduct_id("1"); 7. payparam.setproduct_name(" 元宝 "); 8. payparam.setproduct_desc(" 很好 ");

16 9. payparam.setexchange_rate(1); 10. payparam.setcurrency_name(" 金币 "); 11. payparam.setext(" 穿透 "); 12. } 13. // 初始化测试的支付角色信息 14. private RoleInfo inittestroleinfo() { 15. RoleInfo roleinfo=new RoleInfo(); 16. roleinfo.setrolelevel_ctime(""+system.currenttimemillis()/1000); 17. roleinfo.setrolelevel_mtime(""+system.currenttimemillis()/1000); 18. roleinfo.setparty_name("partyname"); 19. roleinfo.setrole_balence(1.00f); 20. roleinfo.setrole_id("role_id"); 21. roleinfo.setrole_level(0); 22. roleinfo.setrole_name("rolename"); 23. roleinfo.setrole_vip(0); 24. roleinfo.setserver_id("server_id"); 25. roleinfo.setserver_name("servername"); 26. return roleinfo; 27. } 28. CustomPayParam custompayparam = new CustomPayParam(); 29. inittestparam(custompayparam,money); 30. custompayparam.setroleinfo(inittestroleinfo()); 31. // 调起支付 32. sdkmanager.showpay(custompayparam, new OnPaymentListener() { 34. public void exchargesuccess(paymentcallbackinfo callbackinfo) { 35. // 用户兑换成功后, 游戏方可进行道具发放流程 36. Toast.makeText(getApplication(), " 兑换成功 :" callbackinfo.money + " 消息提示 :" + callbackinfo.msg,

17 38. Toast.LENGTH_LONG).show(); 39. } public void paymentsuccess(paymentcallbackinfo callbackinfo) { 43. double money = callbackinfo.money; 44. String msg = callbackinfo.msg; // 弹出支付成功信息, 一般不用 47. Toast.makeText(getApplication(), " 充值金额数 :" callbackinfo.money + " 消息提示 :" + callbackinfo.msg, 49. Toast.LENGTH_LONG).show(); 50. } public void paymenterror(paymenterrormsg errormsg) { 54. // TODO Auto-generated method stub 55. int code = errormsg.code; 56. double money = errormsg.money; 57. String msg = errormsg.msg; 58. // 弹出支付失败信息, 一般不用 59. Toast.makeText(getApplication(), " 充值失败 :code:" errormsg.code + " ErrorMsg:" + errormsg.msg " 预充值的金额 :" + errormsg.money, 62. Toast.LENGTH_LONG).show(); 63. } 64. });

18 6 浮点 6.1 显示浮点 1. public void showfloatview() 说明 : 调用此方法可显示浮点, 一般在登陆成功后调用, 在 Activity 的 onresume 方法中里面调用, 在 Activity 的 onstop 方法中调用隐藏浮点功能 6.2 隐藏浮点 1. public void removefloatview() 说明 : 调用此方法可隐藏浮点, 一般在 Activity 的 onstop 方法中调用隐藏浮点功能 7 登出回调监听 7.1 添加登出回调监听 1. public void addlogoutlistener(onlogoutlistener onlogoutlistener) 说明 : 在退出登陆前必须注册退出登陆回调监听, 用于接收退出登陆, 或者 切换账号, 或者登陆过期的退出登陆结果 参数 : 参数 说明 OnLogoutListener 退出登陆回调接口 参数类说明 :OnLogoutListener 需要实现两个方法 : 退出登陆成功 : 1. public void logoutsuccess(int type, String code, String msg);

19 退出登陆失败 : 2. public void logouterror(int type, String code, String msg); 其中 type=onlogoutlistener.type_normal_login 是为普通退出登陆后的回调 type=onlogoutlistener.type_switch_account 是为切换账号退出登陆的回调 type=onlogoutlistener.type_token_invalid 是为 token 过期退出登陆的回调 调用示例 : 3. sdkmanager.addlogoutlistener(new OnLogoutListener() { 5. public void logoutsuccess(int type, String code, String msg) { 6. Log.e(TAG," 登出成功, 类型 type="+type+" code="+code+" msg="+msg); 7. if(type==onlogoutlistener.type_normal_logout){// 正常退出成功 8. Toast.makeText(MainActivity.this," 退出成功 ",Toast.LENGTH_SHORT).show(); 9. } 10. if(type==onlogoutlistener.type_switch_account){// 切换账号退出成功 11. // 游戏此时可跳转到登陆页面, 让用户进行切换账号 12. // Toast.makeText(MainActivity.this," 退出登陆 ",Toast.LENGTH_SHORT).show(); } 15. if(type==onlogoutlistener.type_token_invalid){// 登陆过期退出成功 16. // 游戏此时可跳转到登陆页面, 让用户进行重新登陆 17. sdkmanager.showlogin(true); 18. } 19. } 20.

20 22. public void logouterror(int type, String code, String msg) { 23. Log.e(TAG," 登出失败, 类型 type="+type+" code="+code+" msg="+msg); 24. if(type==onlogoutlistener.type_normal_logout){// 正常退出失败 } 27. if(type==onlogoutlistener.type_switch_account){// 切换账号退出失败 } 30. if(type==onlogoutlistener.type_token_invalid){// 登陆过期退出失败 } 33. } 34. }); 7.2 退出账号 1. public void logout() 说明 : 在需要退出登陆时可调用此方法, 注意此方法为退出, 并不会调出登 陆界面 调用示例 : 1. sdkmanager.logout(); 8 切换账号 1. public void switchaccount() 说明 : 在需要切换账号时可调用此方法, 注意此方法会调用退出登陆, 会在 前面注册的退出登陆监听中回调通知, 监听中的 type=onlogoutlistener.type_switch_account 调用示例 :

21 1. sdkmanager.switchaccount(); 9 注销 sdk 1. public void recycle() 说明 : 在游戏退出时调用, 用于消耗 sdk 资源, 和退出登陆 一般在游戏退 出的 Activity 中的 ondestroy 方法中调用此方法 调用示例 : 2. protected void ondestroy() { 3. super.ondestroy(); 4. sdkmanager.recycle(); 5. } 10 提交角色信息 1. public void setroleinfo(roleinfo roleinfo, final SubmitRoleInfoCallBack submitroleinfocallback) 说明 : 1 游戏方在用户角色信息改变时需提交用户角色信息 2 游戏方在用户登录区服创建角色后需提交用户角色信息 参数 : 参数名 说明 roleinfo 角色信息类 submitroleinfocallback 提交角色信息的回调接口

22 具体参数类说明 : RoleInfo 角色信息类 : 字段名是否必传类型说明 role_type 是 INT 数据类型,1 为进入游戏,2 为创建 角色,3 为角色升级,4 为退出 5 其 他 server_id 是 STRING 游戏服务器 id server_name 是 STRING 游戏服务器名称 role_id 是 STRING 玩家角色 id role_name 是 STRING 玩家角色名称 party_name 是 STRING 工会 帮派名称, 如果没有, 请填 空字符串 role_level 是 int 玩家角色等级, 如果没有, 请填 0 role_vip 是 int 玩家 vip 等级, 如果没有, 请填 0 role_balence 是 float 玩家游戏中游戏币余额, 如果没有 账户余额, 请填 0 rolelevel_ctime 否 STRING 玩家创建角色的时间时间戳 ( 单位 秒 ) rolelevel_mtime 否 STRING 玩家角色等级变化时间时间戳 ( 单位

23 字段名是否必传类型说明 秒 ) submitroleinfocallback 回调类 : 包含两个回调方法 : 1. 成功的回调 : 1. void submitsuccess(); 2. 失败的回调 (msg 为错误信息 ): 1. void submitfail(string msg); 调用示例 1. // 设置角色信息 2. private RoleInfo inittestroleinfo() { 3. RoleInfo roleinfo=new RoleInfo(); 4. roleinfo.setrolelevel_ctime(""+system.currenttimemillis()/1000); 5. roleinfo.setrolelevel_mtime(""+system.currenttimemillis()/1000); 6. roleinfo.setparty_name("partyname"); 7. roleinfo.setrole_balence(1.00f); 8. roleinfo.setrole_id("role_id"); 9. roleinfo.setrole_level(0); 10. roleinfo.setrole_name("rolename"); 11. roleinfo.setrole_vip(0); 12. roleinfo.setserver_id("server_id"); 13. roleinfo.setserver_name("servername"); 14. return roleinfo; 15. } 16. RoleInfo roleinfo=inittestroleinfo(); 17. roleinfo.setrole_type(1); 18. // 提交角色信息

24 19. sdkmanager.setroleinfo(roleinfo, new SubmitRoleInfoCallBack() { 21. public void submitsuccess() { 22. T.s(MainActivity.this," 提交成功 "); 23. } public void submitfail(string msg) { 27. T.s(MainActivity.this,msg); 28. } 29. });