1 、简介

1.1 用户模块

提供 UI界面 和 接口调用 两种方式，满足用户不同需求。

1.1.1 登录弹窗

内置登录UI弹窗，内含所有已经集成的登录方式，无需编写界面，一键集成登录功能

1.1.2 匿名登录

WINGSDK匿名登录无需账户密码，根据设备信息新建用户或登录已存在的用户，可以快速登录游戏。

1.1.3 第三方平台登录

第三方平台登录接口可以通过第三方平台账户登录，返回WINGSDK账号信息，使用没有绑定任何WINGSDK账号的第三方平台账号登录，会自动新建一个WINGSDK账号，并且与该平台账号绑定。支持Facebook登录、Google登录、VK登录。

1.1.4 内置账户管理界面

内置账户管理UI界面，无需编写界面和逻辑，即可对账户进行管理，平台账户绑定情况一目了然，绑定、解绑平台账户，新建账号，切换账号，轻松搞定。

1.1.5 账号绑定与解绑

• 账号绑定接口，可以将WINGSDK账号跟第三方平台的账号绑定，绑定成功后可以使用绑定的平台账号登录，在同一应用中一个平台账号只能绑定一个WINGSDK账号。

• 账号解绑接口，可以将第三方平台账号与其绑定的WINGSDK账号解绑，解绑成功后，平台账号可以与WINGSDK账号再次绑定。

• 绑定账号查询接口，能够查询此时登录的账号（WINGSDK）已经绑定的第三方平台账号列表。

1.1.6 账号切换

一键切换账号，迅速切换WINGSDK账号或者第三方账号。

1.2 支付模块

支付模块提供支付充值接口，集成简单，无需理会复杂的支付流程，轻松完成商品的购买（充值）。

1.3 数据收集模块

数据收集模块提供了数据收集的接口，多渠道灵活调用。数据收集包含了丰富的应用内的事件类型，还支持用户自定义事件类型。

1.6 推送

WINGSDK推送功能，可以向客户端推送消息，通过简单几步配置即可使用。

1.8. 智能客服 AIHelp

WINGSDK智能客服功能，集成机器人、人工客服，FAQ等功能。

1.9.隐私政策

为了遵守欧盟以及Google等第三方的一些关于用户隐私的法律法规，WINGSDK实现了一套简单的用户隐私政策流程。分为两种类型，一种是自动的，针对的是对接了登录窗口方式的CP，这种情况CP无需接入任何新的接口；一种手动的，针对的是对接了接口登录的CP，这种情况CP需要对接新的接口，具体接口参考隐私政策接口章节。

1.10. 用户中心

WINGSDK用户中心功能，可以向玩家展示充值中心账号、初始密码、信息内容。

2 、快速集成

2.1 环境配置要求

• Android API 21及以上版本

• jdk1.8及以上版本。

• compileSdkVersion 34及以上版本

2.2 集成SDK到项目

WINGSDK基于gradle提供了多种集成方式：Gradle自动集成、手动集成、Eclipse项目集成、命令行集成，可以根据需要选择其中任意一种方式。

集成参考demo: demo代码下载地址

第三方SDK依赖关系如下表

2.2.1 Gradle自动集成

新项目配置：在项目目录下的settings.gradle文件添加以下配置：

旧项目配置：在项目目录下的build.gradle文件添加以下配置：

注意：
1）部分项目中可能只有一个build.gradle文件;
2）以上的url为WingSdk仓库地址：http://repo.wingsdk.cn:8081/repository/winga-group/

在程序module下面的build.gradle文件的dependencies内增加依赖配置；

注意：
1）部分项目中可能只有一个build.gradle文件；
2）以上的“必选”项目必须引入，“可选”项目可根据需求引入。
3) 其中x.x.x为各个模块的具体版本号，随SDK版本升级会发生改变，各个版本对应的渠道包版本请参考：https://admin.wingsdk.com/developers/pack_config.do 在这个地址页面，也可以通过选择版本和所需要的渠道，一键生成依赖脚本配置。

2.3 SDK配置及初始化

2.3.1 SDK配置

2.3.1.1 AndroidManifest.xml配置：

在AndroidManifest.xml中application标签下添加以下设置。不同的应用配置的参数值不相同，需要申请相应资源。

注意：以上配置中android:name必须保持一致，android:value根据CP应用申请的资源而定。

2.3.1.2 Activity结果传递配置

在所有使用到SDK接口的Activity的onActivityResult方法中增加以下代码：

2.3.1.3 接口使用注意事项

1.所有SDK接口都必须在主线程中调用
2.所有SDK接口必须在SDK初始化成功后调用，除非有特殊说明

2.3.2 SDK初始化

调用下面接口对SDK进行初始化：

注意：
1.SDK初始化必须在游戏页Activity（不能是闪屏页）的onCreate()方法中调用，必须在UI线程中调用。
2.从回调中获取初始化结果，所有SDK接口都必须在SDK初始化成功的情况下才能调用。
3.建议在初始化中过程中增加laoding状态，返回结果后再关闭loading

参数说明：

示例代码：

2.4 登录

2.4.1 使用登录窗口

2.4.1.1 调用登录窗口

注意：测试时，需要联系运营添加测试设备，才能出现登录方式。

SDK内置了一个包含所有支持的登录方式的一个对话框，通过调用以下接口显示对话框：

参数说明：

注意：使用登录窗口时，点击图标登录SDK自动弹出加载框，无需再次添加加载框。

2.4.1.2 清除登录窗口的缓存

使用登录窗口对话框进行登录，如果启用了缓存，SDK会缓存当前登录方式，下一次在启用缓存的前提下使用登录窗口登录，会自动使用上一次登录方式登录，不再弹出登录窗口。清除掉缓存后，可以重新弹出登录窗口，清除缓存调用以下接口：

注意：从3.18.0开始，调用WAUserProxy.logout()时，内部已经包含清除登录窗口缓存逻辑，可以不调用该方法。

2.4.2 使用接口登录

如果CP有自己的登录窗口，可以使用以下登录接口：

2.4.3 处理登录结果

登录结果通过传入的回调返回，数据封装在WALoginResultV2类中。

WALoginResultV2字段说明

2.4.4 用户登出

需需要在游戏中添加该功能入口，一般是在游戏设置页中，具体入口位置和图标由运营决定。效果参考下图：

用户正常关闭游戏时无需调用该接口，只有在退出游戏账号的时，才必须执行登出操作。用户登出调用以下接口：

2.5 支付

2.5.1 查询库存商品列表

通过查询库存商品列表，可以获取所有可以购买的库存商品，查询库存调用接口

注意：这里返回的库存商品信息是WINGSDK平台的商品信息，并非第三方平台的商品信息。

参数说明：

WASkuDetails实体类说明：

2.5.2 购买商品

需要先接入进服和创角事件，否则无法正常通知发货。
购买指定商品，调用以下接口发起支付：

调用支付接口支付将会出现两种情况：
1）直接弹出google购买窗口（如果该商品有且只有google支付渠道）；
2）弹出支付渠道选择窗口（如果有除google之外的渠道），选择支付方式后进行支付。

参数说明：

注意：如果需要横竖屏适配，请在AndroidMainifest.xml中对弹出购买窗口的Activity声明中添加如下语句：

WAPurchaseResult实体类说明：

2.6 数据收集

使用WINGSDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。

下面流程涉及到WingSDK后台统计中非常关键的进服和创角事件，请严格按照指定时机顺序发送，具体流程如图所示：

2.6.1.常用事件对象对照表

2.6.2 常用事件发送

2.6.2.1 ghw_user_import用户进服

事件说明：用户进服事件
调用时机：玩家登录游戏服务器成功后

代码示例

2.6.2.2 ghw_user_create用户创角

事件说明：用户创角事件
调用时机：玩家创建角色成功后调用
事件参数

代码示例

2.6.2.3. ghw_user_info_update 更新用户信息

事件说明：更新用户信息。
调用时机：玩家更改角色昵称时（必须），或信息更新时（可选）

代码示例：

2.6.2.4 ghw_level_achieved 等级增长事件

事件说明：等级增长事件。
调用时机：玩家达到新的等级时调用

2.6.2.5 ghw_initiated_purchase点击购买

事件说明：点击购买事件 。
调用时机：用户点击购买时调用

事件参数：无

代码示例

2.6.2.6.ghw_self_tutorial_completed完成新手任务

事件说明：完成新手任务。
触发时机：完成新手任务时调用
无参数

参考示例:

2.7 代码混淆配置

打包apk混淆代码配置中增加以下配置

3 、高级功能

3.1 调试模式

3.1.1 开启/关闭调试模式

SDK默认是关闭调试模式的，开启调试模式可以在IDE的Logcat中查看到程序的Log信息，方便调试和测试。开启/关闭调试模式调用以下接口。

说明：调用此接口后即可显示Log悬浮窗按钮，不用再另外调用enableLogcat接口，同时如果需要，也可以调用disableLogcat接口隐藏Log按钮。

3.1.2 如何获取 client_id

在日志中，搜索警告级别日志内容 “clientid=”，可以得到appId和clientId

3.3 Firebase

原来的push模块更改为Firebase模块。Firebase为3.9.3及之后版本必须接入的模块。
Firebase包含推送通知及统计分析(包括事件跟踪)功能。

温馨提示：WINGSDK当前版本的推送是基于Firebase实现，国内环境需要VPN才能使用。

3.3.1 集成配置

添加推送模块依赖方法参考 集成SDK到项目

添加依赖后，在项目（Project）的build.gradle文件中添加依赖

在项目模块（Module）的build.gradle文件中添加插件声明（将这一句添加到build.gradle文件的最低端, 没有添加推送模块的依赖，不要添加这句 ）

3.3.2 Android 13运行时通知权限申请

以Android 13为目标的应用项目，需要在恰当的时机（建议在用户进服后）申请通知权限，否则新安装应用无法接收Firebase通知
示例代码：

3.4 智能客服 AIHelp

3.4.1. 判断是否开启AiHelp

说明：该接口返回布尔值，true表示已开启，false表示未开启。在使用其他AIHELP接口前请先判断这个接口，在返回true的情况下使用。示例如下：

3.4.2. 展示AiHelp后台配置界面

说明：该接口受WING后台中”SDK客服开关V2”控制。如果WingSDK后台未开启开关，此接口不生效。

3.4.3.获取未读消息数

调用下面接口获取未读消息数

AiHelp客服红点处理建议：
1.为了确保红点状态准确性每次进入AiHelp客服入口所在页面都调用一次该接口，更新AiHelp客服入口的红点状态。比如每次进入游戏登录页，每次进入设置页，都需要调用该接口更新红点状态。
2.当用户点击AiHelp打开客服时，需要移除红点

3.6 Android6.0 权限管理

buildVersion 在23以下版本，只需要在AndroidManifest.xml中配置权限即可，buildVersion 在23及以上版本，在AndroidManifest.xml中配置的敏感权限声明，当程序运行在API 23（android6.0）及以上的系统时，授权声明是无效的，敏感权限需要在程序运行时授权。
SDK提供了运行时权限的检查与授权接口，在程序运行时，调用以下接口进行权限自检：

参数说明：

示例：

在调用上面权限自检接口的Activity中的onRequestPermissionsResult()方法中调用已下接口，完成权限自检和授权的传递。

示例：

3.7 游戏评价窗口

游戏评价窗口用于向用户展示评分提示窗口，弹出后用户可以选择提交好评(即拉起Google评分)，或我要提意见(即打开AiHelp)，或不谢谢(即关闭窗口，手势返回关闭同这个操作一样)，具体UI可以查看后面的效果图。

注意：
1.如果需要评价完成给用户发放奖励，可以在onReviewComplete回调中进行处理
2.该功能受WingSDK后台开关控制，需要打开游戏评价开关
3.评分功能是无法获得具体评分内容和分值的，Google评分机制设计如此
4.关于Google评分的详情及测试 google 应用内评分
5.如果不需要SDK界面，另外单独做界面，可以分别调用Google评分接口google 应用内评分 （对应好评选项）和AiHelp游戏评价接口打开游戏评价客服入口 （对应吐槽选项）
示例代码：

界面效果：

3.9 Consent同意屏幕相关

3.9.1 用户同意界面显示

用户同意界面弹出是内置在SDK初始化逻辑中，当SDK正常初始化完成后，如果需要符合弹出条件，就会展示用户同意界面。

以下情况不会弹出：

1.设备网络不在欧盟地区（比如德国）
2.用户已经在同意界面操作过同意或拒绝

注意：本功能要求调用SDK初始化接口WACoreProxy.initialize() 时传入的Activity类型，必须是FragmentActivity，否则同意屏幕无法初始化。如果传入Activity已有特定继承类，比如继承 UnityPlayerActivity，则可以修改 UnityPlayerActivity 继承 FragmentActivity 来实现。

展示效果：
了解更多，会跳转到目的设置页，页面效果参考同意设置。
管理我们的x合作伙伴，会跳到 供应商设置页，页面效果参考同意设置。

3.10 AdMob功能

3.10.1 应用ID配置

在AndroidManifest.xml的application标签下添加下面代码，其中xxx为AdMob的应用ID，具体值从运营处获取

3.10.2.激励广告

3.10.2.1.判断是否开启激励广告

其中adName为广告名称（WingSDK后台配置的广告名称，可以从运营处获取）

3.10.2.2.展示激励广告

在Activity页面中展示激励广告，用户看完广告后会通过WingSDK后台进行奖励发放。
如果广告还未准备好，会立即开始请求广告并显示loading转圈，等广告加载完成后会立即展示，或者加载失败直接返回回调。

参数说明：

示例代码：

失败处理建议：可以在广告显示的 onAdFailedToShow回
调失败中提示用户，广告暂不可用，稍后再试。

Google官方使用建议：
植入激励广告的最佳做法：https://admob.google.com/intl/zh-CN_cn/home/resources/monetize-mobile-game-with-ads

3.11 官网包配置

注意：Google包无需配置。

如果是官网包，在AndroidManifest.xml中加入下面配置：

1.权限声明

2.Provider声明

注意：
authorities必须以 ”com.wa.provider.ad” 为前缀，后缀建议使用游戏简称。比如游戏简称为 loap，则authorities可以设置为 com.wa.provider.ad.loap

3.CHANNEL 声明

其中xx值从运营处获取

3.12 客服中心

客服中心已经包含账号管理、账号注销、AiHelp客服、用户中心、Consent设置功能入口，可以通过SDK后台配置进行显示控制。
效果如图：

需要在游戏的设置页中添加该功能入口，入口图标和名称可以参考使用SDK内置的图标资源R.drawable.wa_sdk_settings_center和文案资源R.string.wa_sdk_settings_customer_center。
文案内容为已国际化处理”客服中心”文本，图标效果如下：

调用下面接口弹出客服中心弹窗

参数说明：

接口调用示例：

3.13 社交功能

3.13.1 获取三方平台账号信息

获取第三方平台的账号信息，包括头像，昵称，平台信息。
注意：当前只有Google或Facebook登录后才返回信息，其他平台返回null

调用方法：

返回对象WAPlatformAccountInfo说明：

示例代码：

3.13.2 邀请活动功能

3.13.2.1 配置

在AndroidManifest.xml中的主页中添加下面配置：

在主页Activity（一般是MainActivity）中重写下面方法，并调用setIntent

3.13.2.2 分享邀请链接

调用方法：

参数说明：

示例代码：

3.13.2.3 获取已邀请人数

邀请链接分享给目标用户后，目标用户需要达到设定的条件（一般是触发完成新手任务事件）才会被统计到已邀请人数中。

调用方法：

示例代码：

4 、第三方配置

4.1 Google相关配置

游戏如需使用Google账号进行登录、Google商店进行支付，需要进行以下配置。 如果不需要使用Google相关功能，请忽略此章节
后台配置请参考第三方后台配置—Android版公共配置流程。

4.1.1 Google基本配置

在values/strings.xml中添加公钥字符串资源：

在values/strings.xml中添加服务器OAuth client ID（即Google后台Web application 类型的OAuth client ID）：

4.1.2 Google Game Service配置

游戏如需使用Google game service相关功能，需要进行以下配置。 如果不需要相关功能，请忽略此章节
使用Google Game Service服务，还需要在AndroidManifest.xml.xml中application标签下添加以下配置：

说明：字符资源的值是Google Game Service的APP ID,需要Google开发者控制台创建游戏服务获得。请参考第三方后台配置—Android版添加Google Game Service支持。

注意：因为值的内容是数字，要求必须在资源清单文件（如：strings.xml）中使用string类型声明之后引用，否则Game Service SDK无法识别。

4.1.3 Google代码混淆配置

4.1.4 Google获取SHA-1指纹

获取程序签名文件SHA-1命令如下：

其中<release_key_alias>是证书别名，<path-to-production-keystore>是证书的地址。

4.2 Facebook相关配置

游戏如需使用Facebook相关登录、社交、数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节

4.2.1 Facebook基本配置

在strings.xml中添加Facebook APP ID、Client Token、login protocol scheme声明：：

在AndroidManifest.xml中添加配置

注意：
1、string的name必须为facebook_app_id，不可更改，值为Facebook app id
2、fb_login_protocol_scheme格式为fb+ YOUR_FACEBOOK_APP_ID,如facebookkid为2929419560408279，则fb_login_protocol_scheme为 fb2929419560408279
3、将FacebookContentProvider后面的${YOUR_FACEBOOK_APP_ID}替换成你的Facebook app id。获取方式请参考第三方后台配置—Android版2.1 Facebook基础配置。
4、client token 获取方式: 获取方式参考

4.2.2 Facebook代码混淆配置

4.3 AppsFlyer相关配置

游戏如需使用Appsflyer相关数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节

4.3.1 AppsFlyer代码混淆配置

4.4.AiHelp智能客服

4.4.1 AIHelp相关配置

游戏如需使用智能客服 AIHelp客服系统，需要进行以下配置。如果不需要相关功能，请忽略此章节
在AndroidManifest.xml文件的application标签下中添加以下配置

注意事项：AIHelp_domain配置必须使用三级域名的形式。例如原gamehollywoodhk@aihelp.net需要改为 gamehollywoodhk.aihelp.net。

4.4.2 AiHelp混淆配置

打包apk混淆代码配置中增加以下配置

4.5 GHGL模块相关配置

4.5.1 基础配置

在项目app目录层级下的res/values/strings.xml中添加wa_custom_tab_scheme声明

注意：
1.string的name必须为wa_custom_tab_scheme，不可更改
2.格式为wa+YOUR_SDK_APPID。比如SDK的appid为f7f9a9d18da611e5a0be000d3a906774，则wa_custom_tab_scheme的对应内容为waf7f9a9d18da611e5a0be000d3a906774
3.这里SDK的appid为wingsdk的appid

5 、不常用功能

不常用功能

6 、附录

6.1 代码说明

6.1.1 状态码说明

SDK中的状态码统一以静态变量方式封装在WACallback接口里面，如果使用到状态码，强烈建议采用静态变量的方式调用，不要直接使用数值。

6.1.2 平台取值

平台取值统一在 WAConstants 类中，建议使用静态常量，不要直接使用对应值。比如Google平台可以使用 WAConstants.CHANNEL_GOOGLE 进行取值。

6.2 事件说明

6.2.1 SDK预定义事件名

在WAEventType接口中定义

6.2.2 SDK预定义参数名

在WAEventParameterName接口中定义