Blame view

IntegrationGuide.md 8.3 KB
d3c7882c1   赵康   first commit:4.+
1
  # Gump SDK 4 for Android接入文档
656f5f9fd   赵康   merge payment v3 ...
2
3
  V4.1.3       
  2017年1月12日
d3c7882c1   赵康   first commit:4.+
4

4112d606c   赵康   optimize document
5
  ## 版本概述
d3c7882c1   赵康   first commit:4.+
6
7
8
9
10
11
  
  此版本为使用AndroidStudio开发的第一个版本,一改eclipse的工程依赖方式,使用aar的方式提供sdk接入包,除功能外,相对上一版本没有继承关系,请按此文档描述接入.
  
  此SDK适用android2.3以上系统.
  
  ## 第一章  接入指南
4112d606c   赵康   optimize document
12
  ### 1.依赖导入
d3c7882c1   赵康   first commit:4.+
13
14
15
16
17
18
19
20
21
  将aar添加到libs目录下,然后配置gradle    
  以下为必须项    
  
      repositories{
          flatDir{
              dirs 'libs'
          }
      }
      dependencies {
d6b9069ea   赵康   update to 4.1.0:F...
22
          compile(name:'GameSDK-releaseXXX',ext:'aar')
d3c7882c1   赵康   first commit:4.+
23
24
      }
      
d3c7882c1   赵康   first commit:4.+
25
26
27
28
       
  可选接入vk登录时,需要导入vkLibrary工程,并配置模块依赖,如下  
  
      compile project(':vksdk_library')
4112d606c   赵康   optimize document
29
  ### 2.修改AndroidManifest.xml文件
d3c7882c1   赵康   first commit:4.+
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  首先添加必要的权限,如下所示:  
  
      <uses-permission android:name="android.permission.INTERNET" />
      <uses-permission android:name="android.permission.READ_PHONE_STATE" />
      <uses-permission android:name="android.permission.BLUETOOTH" />
      <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
      <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
      <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
      <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
      <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
      <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
      <uses-permission android:name="android.permission.SEND_SMS"/>
      <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
      <uses-permission android:name="com.android.vending.BILLING" />
      
  其次注册相应的Activity,具体如下:  
  
      <activity
          android:name="com.gumptech.sdk.ContainerActivity"
          android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
          android:windowSoftInputMode="stateAlwaysHidden|adjustPan"
          android:launchMode="singleTask"
          android:theme="@style/Theme.TransparentWin" >
      </activity>
      <activity
          android:name="com.gumptech.sdk.PaymentActivity"
          android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
          android:launchMode="singleTask"
          android:theme="@android:style/Theme.Translucent.NoTitleBar" >
          <intent-filter>
              <category android:name="android.intent.category.DEFAULT" />
              <action android:name="android.intent.action.VIEW" />
              <category android:name="android.intent.category.BROWSABLE" />
              <data
                  android:host="com.gump.sdk"
                  android:scheme="gump+游戏的appId" />
          </intent-filter>
      </activity>
      <activity
          android:name="com.gumptech.sdk.ExchangeWindow"
          android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
          android:theme="@style/Theme.WinForExchange" >
      </activity>
      
      <service android:name="com.gumptech.sdk.PushService" />
d6b9069ea   赵康   update to 4.1.0:F...
75
76
      
      <!-- vk登录使用,若不接入vk,不需配置 -->
d3c7882c1   赵康   first commit:4.+
77
78
79
80
81
82
      <activity android:name="com.vk.sdk.VKOpenAuthActivity" />
      <activity
          android:name="com.vk.sdk.VKServiceActivity"
          android:label="ServiceActivity"
          android:theme="@style/VK.Transparent" />
      
4112d606c   赵康   optimize document
83
  ### 3.向Gump平台索要游戏ID(AppID),完成代码接入     
d3c7882c1   赵康   first commit:4.+
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
  正式开始接入逻辑代码前,先介绍下一些附加设置,以方便代码接入  
  
  *是否打印debug日志    
  
      GumpSDK.getSettings().enableDebugLogging(true);
  
  *Gump Logo隐藏   
      
      GumpSDK.getSettings().setLogoShow(false);   
  
  *横竖屏控制,默认为横屏,参数为false即为竖屏   
      
      GumpSDK.getSettings().setScreenLandscape(true);   
      
  *设置是否启用Facebook登录和VK登录
  
      GumpSDK.getSettings().setFBEnable(true);
      GumpSDK.getSettings().setVKEnable(true);
d3c7882c1   赵康   first commit:4.+
102

656f5f9fd   赵康   merge payment v3 ...
103
104
105
  *若要使用V4版支付请设置
  
      GumpSDK.getSettings().setPaymentVersion(PaymentVersion.V4);
4112d606c   赵康   optimize document
106
  #### 1.调用GumpSDK前需要执行初始化。     
d3c7882c1   赵康   first commit:4.+
107
108
109
110
111
112
113
114
115
  
  若不需要分渠道      
  
      GumpSDK.init(Context,Appid, Appkey,InitializeCallback);   
  如果需要定义渠道,必须使用如下方法       
  
      GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);   
  
  InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
4112d606c   赵康   optimize document
116
  #### 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数       
d3c7882c1   赵康   first commit:4.+
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  
      GumpSDK.start(Activity);  
  在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:    
  
      GumpSDK.setUserStateListener(new LoginStateListener() {
              @Override
              public void onLoginSuccess(GumpUser gumpUser) {
                  //登录成功,用户信息包含在GumpUser对象里
              }
  
              @Override
              public void onLoginFailed(int code, String msg) {
                  //登录出错,根据错误码和信息判断错误类型
                  Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show();
              }
  
              @Override
              public void onLoginCanceled() {
                  //用户取消登录
                  Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show();
              }
  
              @Override
              public void onLogout() {
                  //用户登出
                  
              }
          });
      
  如上成功登录后收到的GumpUser对象包含以下信息  
  
      gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!  
      gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取  
      gumpUser.getSessionKey();//登录的sesionKey  
4112d606c   赵康   optimize document
151
  #### 3.支付功能  
d3c7882c1   赵康   first commit:4.+
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数     
  
      Bundle payInfo = new Bundle();
      payInfo.putString("nick", "thi");
      payInfo.putString("product", "元宝");
      payInfo.putFloat("amount", 40.0f);
      payInfo.putString("extraInfo", "This is demo!");
      payInfo.putString("serverId", "B4003");
      payInfo.putString("roleId", "10010");
      payInfo.putString("sessionKey","sessionkey");
      GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
  调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey  
      
      
607ad49c5   赵康   分离iap支付
166
167
168
169
170
171
172
173
174
175
176
  2)IAP支付,roleId为可选参数,其他参数必传   
      
      Bundle payInfo = new Bundle();
      payInfo.putString("product", "gp_skuId");
      payInfo.putFloat("amount", 0.1f);
      payInfo.putString("extraInfo", "This is demo!");
      payInfo.putString("serverId", "100");
      payInfo.putString("roleId","100123");
      GumpSDK.iap(MainActivity.this, payInfo, PurchaseCallback);
                  
  3)PurchaseCallback为支付状态回调接口,此接口含有3个方法  
d3c7882c1   赵康   first commit:4.+
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
  
      @Override
      public void onPurchaseCompleted(PurchaseResult result) {
          Log.i(TAG,"purchase completed");
      }
  
      @Override
      public void onPurchaseError(int code, String msg) {
          Log.i(TAG,"purchase error");
      }
  
      @Override
      public void onPurchaseCanceled() {
          Log.i(TAG,"purchase canceled");
      }
      
4112d606c   赵康   optimize document
193
  #### 4.注销登录      
d3c7882c1   赵康   first commit:4.+
194
195
  
      GumpSDK.logout(Activity);
d6b9069ea   赵康   update to 4.1.0:F...
196
  当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!为了便于用户切换登录账户,请在游戏内提供用户注销的触发按钮
d3c7882c1   赵康   first commit:4.+
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  ## 第二章 常见问题      
  ### 问题1: 如何避免混淆对SDK的影响?       
  解答:有些开发者对接入了SDK的程序进行混淆时,有可能会覆盖某些java
  类,导致SDK无法正常工作,解决方法如下:      
  Ø  请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上       
  
      -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
      -keep public class * extends android.app.Service
      -keep public class com.google.vending.licensing.ILicensingService
      -keep public class com.android.vending.licensing.ILicensingService
      -keep class com.gumptech.sdk.view.* {*;}
      -keep class com.gumptech.sdk.web.* {*;}
      -keep class com.gumptech.sdk.bridge.impl.*{*;}
      
      
  使得混淆的时候不会影响SDK的命名空间。