一、简介

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.1.7 支付模块

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

1.1.8 数据收集模块

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

1.1.9 推送

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

1.1.10 . 智能客服 AIHelp

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

1.1.11 .隐私政策

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

1.1.12 . 用户中心

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

二、快速集成

2.1 环境配置要求

• Android API 15及以上版本

• jdk1.7及以上版本。

• compileSdkVersion 26及以上版本

2.2 集成SDK到项目

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

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

第三方SDK依赖关系如下表

2.2.0 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.2.1 手动集成 （供参考）

2.2.1.0 打包配置页面下载SDK包

打包配置页面地址在上面章节查找。下载页面如下图所示：

2.2.1.1 导入SDK包到项目中

打开项目，在菜单“File→New→New Module”

打开新建Module页面，选择“Import .JAR/.AAR Package”项，下一步

选择下载好的SDK .AAR包，导入

此时项目的目录将会多了一个上面新建的Module，然后将Module关联到程序Module中，关联方法有两种：
第一种：直接在程序Module中的build.gradle的dependencies下添加代码（单引号内部为要关联的Module名称，以冒号“:”开头）

第二种：选中程序Module，鼠标右键→Open Module Settings（或F12），打开程序Module设置面板

在打开的Module设置窗口中选中程序Module，定位到“Dependencies”选项卡，点击“+”符号添加依赖，选择“Module Dependency”，

弹出Module选择窗口，在这个窗口中会展示出所有的未关联的Module

选中要关联的Module，OK→OK完成配置

2.2.1.2 手动集成AAR注意事项

1）wa-sdk-base AAR包（必选）
2）wa-sdk-core AAR包（必选）
需要依赖androidx.legacy:legacy-support-v4

3）wa-sdk-appsflyer AAR包（可选）
需要依赖AppsFlyer AAR包，5.3.0版本

4）wa-sdk-chartboost AAR包（可选）
5）wa-sdk-facebook AAR包（可选）
需要依赖Facebook SDK，6.5.1版本

6）wa-sdk-google AAR包（可选）
需要依赖Google Service相关包，版本为16.0.1

7）wa-sdk- vk AAR包（可选）
需要依赖VK SDK包，版本1.6.9

8）wa-sdk-webpay AAR包（可选）
9) wa-sdk-push AAR包（可选）
需要依赖Google Firebase相关包，版本为15.0.2

10) wa-sdk-twitter AAR包（可选）
需要依赖Twitter sdk，版本3.3.0

11) wa-sdk-instagram AAR包（可选）
12) wa-sdk-ad AAR包（可选）
13) wa-sdk-aihelp AAR包（可选）
需要依赖aihelp sdk，版本1.7.2.2

说明：以上的“必选”项目必须引入，“可选”项目可根据需求引入

2.3 SDK配置及初始化

2.3.0 SDK配置

2.3.0.0 AndroidManifest.xml配置：

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

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

注：WINGSDK中使用到的权限
1）SDK内部自动添加的权限（普通权限）

2）CP选配权限（危险权限） 如果应用上Google推荐，需注意Google推荐位需知

2.3.0.1 Activity结果传递配置

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

2.3.1 SDK初始化

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

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

参数说明：

示例代码：

2.4 登录

2.4.0 使用登录窗口

2.4.0.0 调用登录窗口

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

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

参数说明：

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

2.4.0.1 清除登录窗口的缓存

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

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

2.4.1 使用接口登录

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

2.4.2 处理登录结果

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

WALoginResult字段说明

2.4.3 用户登出

退出游戏的时候，必须执行登出操作。用户登出调用以下接口：

注意：调用logout接口后，serverId、gameUseId、level字段值会被重置，如果需要保持相应字段的值不重置，需要重新设置相应字段的值，参考 公共参数设置

2.5 支付

WINGSDK支付流程如下：

2.5.0 初始化支付

初始化支付，SDK会对所有已经支持的支付平台做初始化，初始化调用接口

参数说明：

支付的初始化在调用Activity的onCreate中初始化。

2.5.1 查询库存商品列表

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

注意：这里返回的库存商品信息是WINGSDK平台的商品信息，并非第三方平台的商品信息。建议在游戏商品页出来之前调用，最好是支付初始化完后就开始调用一次，可以参考下方代码示例进行调用：

参数说明：

WASkuDetails实体类说明：

2.5.2 购买商品

购买指定商品，调用以下接口发起支付：

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

注意：如果需要在订单信息中记录当前玩家昵称，需要按设置玩家昵称设置玩家昵称。

参数说明：

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

WAPurchaseResult实体类说明：

2.5.3 查询支付服务是否可用

通过以下接口可以获取支付服务是否可用，返回boolean类型结果，true为可用，false为不可用，只要有一个支付渠道可用即为true。

参数说明：

2.5.4 查询商品本地价格

通过查询商品信息，可以获取库存商品的本地价格，查询商品本地价格调用接口

注意：这个接口需要在查询库存商品（WAPayProxy.queryInventory）成功回调后使用。

参数说明：

WAChannelProduct实体类说明：

2.6 数据收集

使用WINGSDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。WINGSDK数据收集使用在游戏的过程中打点的方式，如图所示：

1. 以上流程图中涉及到的几个接口是有时序要求的，请参考流程图中的逻辑步骤进行设置：setServerId、setGameUserId、setLevel、setNickname、ghw_user_import事件、ghw_user_create事件
2. 其它的事件如ghw_level_achieved、ghw_self_tutorial_completed、ghw_self_lv_x等请根据对应业务逻辑，在对应业务发生时调用接口发送

2.6.0 发送数据

2.6.0.0 构建WAEvent对象

使用WAEvent.Builder构建一个WAEvent类对象，并设置数据收集的相关参数：

2.6.0.1 发送数据

调用第一步创建WAEvent对象的trackEvent(Context)方法发送数据

或者调用以下接口发送：

2.6.0.2 WAEvent.Builder方法介绍

• 设置默认的事件名称

参数：
eventName事件名称

• 设置渠道自定义事件名称，针对某个渠道需要设置特定的事件名称

参数：
eventChannel 渠道名称
eventName 事件名称

注意：
1）AppsFlyer预定义的事件名称和WINGSDK预定义的事件名称已经做了映射（例如: ghw_login <-> af_login），用户无需再手动自定义。
2）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置默认累加值

参数：
value 累加统计的数值

• 设置渠道自定义累加值，针对某个渠道需要设定特定的累加值

参数：
eventChannel 渠道名称
value 累加统计的数值

注意：
1）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置事件默认的参数/值，每次可添加多个

参数：
eventValues 参数/值Map

• 添加一个事件默认的参数/值，每次添加一个

参数：
paramName 参数名称
paramValue 参数值

• 设置事件渠道自定义的参数/值，每次可添加多个，针对某个渠道需要设定特定的参数或者值

参数：
eventChannel 渠道名称
eventValues参数/值Map

注意：
1）AppsFlyer预定义的参数名称和WINGSDK预定义的参数名称已经做了映射，用户无需再手动自定义。
2）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置事件渠道自定义的参数/值,每次添加一个，针对某个渠道需要设定特定的参数或者值

参数：
eventChannel 渠道名称
paramName 参数名
paramValue 参数值

注意：
1）AppsFlyer预定义的参数名称和WINGSDK预定义的参数名称已经做了映射，用户无需再手动自定义。
2）如果不进行设置，所有的渠道将采用设置的默认值。

• 禁用渠道，禁用后的渠道不会发送数据

参数：
eventChannel 渠道名称

注意：
1）默认情况下是所有启用的渠道都发送
2）该接口只是针对当前事件禁用发送到某个渠道
3）完全启用/关闭某个渠道数据收集，请参考四、第三方配置相关章节

2.6.1 SDK预定义事件

建议参数属性：（参数对应的静态变量名请看 SDK预定义参数名）

2.6.1.0 ghw_user_import导入用户事件

说明:导入用户事件，玩家每次进服时调用–通过用户id在后台查找

注意：发送ghw_user_import事件前需调用设置服务器ID接口更新服务器id、设置gameUserId接口更新服务器id、调用设置昵称接口更新昵称
代码示例

2.6.1.1 ghw_initiated_purchase点击购买（虚拟货币）

说明:点击购买的时候调用（用于游戏内部虚拟交易统计）。
无参数
代码示例

2.6.1.2 ghw_purchase购买完成（虚拟货币）

说明:购买完成的时候调用（用于游戏内部虚拟交易统计）。

代码示例

2.6.1.3 ghw_level_achieved 等级增长事件

说明:统计玩家等级增长事件，达到等级时调用。

注意：发送ghw_level_achieved事件前需调用 设置用户等级level接口更新用户等级信息。

2.6.1.4 ghw_user_create 创建角色

说明:创建游戏角色，游戏角色创建时调用

注意：发送ghw_user_create事件前需调用setGameUserId、setNickname、setLevel、setServerId接口
参考示例:

2.6.1.5 ghw_self_tutorial_completed 完成新手任务

说明:新手完成新手任务时调用
无参数

参考示例:

2.6.1.6 ghw_self_lv_x 关键等级

说明:完成关键等级时调用，如ghw_self_lv_1、ghw_self_lv_3

参考示例:

无参数

2.6.1.7. ghw_user_info_update 更新用户信息

代码示例：

2.6.2 自定义事件

说明:支持自定义事件的统计
例如：

2.7.隐私政策

如果CP对接的登录方式是接口登录方式，则可以使用以下几个接口来实现隐私政策流程，具体流程可参考下图。

2.7.0.获取隐私政策url

WINGSDK有自己的隐私政策，调用以下接口获取到隐私政策url（隐私政策内容为html页面）：

参数说明：

返回值说明：

2.7.1.获取隐私政策更新时间

隐私政策更新需要重新显示时可以调用以下接口获取最新隐私政策更新时间，和上一次保存的时间戳作对比，从而确定是否需要展示：

参数说明：

返回值说明：

2.7.2.显示隐私政策详情UI

当需要显示隐私政策详情时，可以调用以下接口显示出隐私政策详情界面：

参数说明：

调用示例,当窗口关闭时会回调onCancel接口。

2.8 代码混淆配置

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

三、高级功能

3.0 公共参数设置

WINGSDK包括serverId等公共参数，这些参数主要用于数据跟踪和统计。
公共参数必须严格按照文档进行设置，在后续的接口中会使用到这些公共的参数，没有按照要求配置会导致部分接口调用失败。

3.0.0 设置服务器ID

当用户的服务器ID发生改变时，需要调用设置服务器ID接口设置新的服务器ID，例如每次进入服务器

注意：设置服务器id的操作在每次选服后都需要进行，必须在调用其他接口前设置。

3.0.1 设置gameUserId

当gameUserId发生改变时，需要调用设置gameUserId接口设置新的gameUserId，例如成功登录账号后、切换账号成功后

注意：必须在调用其他接口前设置。

3.0.2 设置用户等级Level

当用户角色等级发生改变时，需要调用设置等级接口设置新的等级，例如开始进入游戏、等级提升等。

注意：第一次进服获取玩家等级或玩家等级变更后，需要及时调用这个接口设置玩家等级，必须在调用其他接口前设置。

3.0.3 设置游戏玩家昵称

设置游戏玩家的昵称，调用接口：

注意：
1.当玩家登录、登出游戏，或修改昵称时，需要及时调用这个接口设置玩家昵称。
2.调用该接口设置昵称后，玩家进行购买时会自动记录昵称到订单信息中。

3.1 调试模式

3.1.0 开启/关闭调试模式

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

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

3.1.1 Logcat工具

SDK提供了调试信息显示的Logcat工具，使用这个工具测试人员不需要IDE环境就可以查看调试信息，工具可以看到应用的调试Log信息（不包含系统打印）。使用前必须确保手机的安全软件没有拦截该程序的悬浮窗口权限，使用调用以下接口：

3.1.2 显示Logcat悬浮按钮

说明：如果已经开启了调试模式，不需要调用该接口就可以显示Logcat入口悬浮窗。

3.1.2.0 隐藏Logcat悬浮按钮

3.1.2.1 向Logcat增加一条日志

通过以下接口，开发者可以向Logcat工具中增加一条开发日志，日志会在Logcat工具的Log标签中显示。

3.1.3 如何获取 client_id

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

3.2 登录高级设置

3.2.0 设置登录流程

使用该接口需注意以下两点：
1）一般来说，如果应用登录的时候有登录方式选择界面，就不需要使用此接口，此接口默认是这种方式（取值为1）。
2）这个接口主要是用来满足以下需求：用户第一次登录是以游客方式进行登录，进到应用里面可以切换其它登录方式，下次登录会直接以切换后的账户进行登录（取值为2）。

登录流程有两种模式，在WAConstants类中定义，取值如下表：

3.2.1 应用内登录

SDK平台应用内登录，是指CP本身有自己登录系统，先登录CP后台拿到用户信息后登录SDK后台，应用内登录调用接口 使用接口登录，登录平台取值APPSELF（CHANNEL_APPSELF），需要将CP后台返回的用户信息按照规定格式（JSON字符串）通过extInfo字段传入。

应用内登录extInfo格式（标准JSON格式字符串）

示例：

字段说明：

3.2.2 Facebook自定义权限登录

Facebook平台登录默认权限是public_profile，如果需要自定义登录获取的权限，可以调用接口 使用接口登录，将需要获取的权限声明按照规定格式（JSON字符串）通过extra字段传入。

Facebook自定义权限登录extra格式（标准JSON格式字符串）

字段说明：

3.3 账户管理

3.3.0 内置账户管理界面

SDK内置了账户管理界面，在这个界面可以对账户进行管理操作，包括账号绑定、解绑、切换账户、新建账户。

注意：使用内置账户管理界面之前必须先登录
参数说明：

onBoundAccountChang方法参数说明：

WABindResult方法参数说明：

3.3.1 绑定第三方平台账户

绑定第三方平台账户，不但可以使用第三方平台账户登录，而且可以防止账户信息丢失，调用以下接口绑定平台账户

参数说明

3.3.2 查询已绑定的第三方平台账户

查询当前的账户已经绑定的第三方平台账户列表，调用接口

WAAccountResult字段说明

WAAccount字段说明

3.3.3 解绑第三方平台账户

解绑已经绑定的第三方平台账户，调用接口

注意：有以下情况之一者，不可解绑
1．解绑的账户为SDK平台的；
2．用户没有绑定第三方平台账户的；
3．用户只绑定一个第三方平台账户，且用户没有与当前设备绑定的

3.3.4 切换账户

切换账户可以一键切换登录账户，调用接口

参数说明：

3.3.5 新建账户

新建账户可以新建一个全新的玩家账户。

注意：新建账户后，新的账户会跟当前设备绑定，如果之前的账户没有绑定第三方平台账户，数据将会丢失。

3.3.6 获取账户信息

获取账户信息接口可以获取指定平台的账户信息，调用接口

参数说明：

3.3.7 Game Service

必须需要在AndroidManifest.xm中添加游戏服务的APPID，才可调用Game Service相关功能，具体参考《Google Game Service配置》。

3.3.7.0 登录Game Service

登录Game Service调用接口：

注意：3.17.0之后Play游戏服务会在游戏启动时自动尝试登录(只有完成上一步的Game Service配置才会进行登录)，若无需获取WAPlayer信息，并且不强制用户登录Play游戏服务，则可以不进行这一步操作。

参数说明：

3.3.7.1 成就解锁

标准类型的成就是一次性解锁，解锁调用以下接口：

参数说明：

3.3.7.2 分步成就进度增加

分步类型成就是可以分步进行解锁的，进度增加会在原来的进度上完成递增，无需知道当前的进度，进度递增调用以下接口：

参数说明：

3.3.7.3 分步成就进度设置

分步类型成就除了可以使用分步成就进度增加实现进度递增外，也可以使用以下接口直接设置进度：

参数说明：

3.3.7.4 显示隐藏成就

隐藏状态下的成就不能解锁，需要显示后才能解锁操作，显示隐藏的成就调用以下接口：

参数说明：

3.3.7.5 展示成就列表

展示成就列表是打开自带的页面，调用以下接口：

参数说明：

3.3.7.6 加载成就列表

通过以下接口，可以加载所有成就的列表：

参数说明：

WAAchievement字段说明：

3.3.7.7 判断是否已经登录Game Service

判断当前是否已经登录了Game Service，调用以下接口，结果在callback中回调，onSuccess回调表示已经登录，onError回调表示未登录。

参数说明：

3.3.8 游戏社区

3.3.8.0 通过Group id查询Group详情

通过Group id查询Group详情，调用以下接口

参数说明：

WAGroup字段说明：

3.3.8.1 查询当前应用关联的Group

一个应用只能关联一个Group，通过以下接口可以查询当前应用关联的Group详细信息：

参数说明：

3.3.8.2 查询当前用户已加入的Group

查询当前用户加入的Group详细信息调用以下接口：

参数说明：

3.3.8.3 查询当前用户是否Group的成员

查询当前的用户是否为指定的某个Group的成员，调用以下接口：

参数说明：

3.3.8.4 加入Group

加入指定的某个Group，调用以下接口：

参数说明：

3.3.8.5 进入Group详情页

进入Group的详情页面，调用以下接口：

如果客户端已经安装platform指定平台的app客户端，将会进入到app客户端详情页面，如果没有安装，则打开网页详情页。

参数说明：

3.4 Firebase

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

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

3.4.0 Firebase相关配置

在Firebase后台配置后，会得到两个文件，一个是google-services.json，需要研发配置到游戏中去；另一个是Firebase服务器秘钥，需要配置到SDK后台，游戏内无需操作

3.4.0.0 新建Firebase项目

如果您还没有 Firebase 项目，请在Firebase控制台中创建一个。 如果已经有一个与您的移动应用关联的现有 Google 项目，请点击导入项目(Import Google Project)。 否则，请点击新建项目(Create New Project)。

3.4.0.1 新建应用

进入项目，新建应用，输入应用的包名称，新建应用后下载一个 google-services.json 配置文件。可以随时重新下载此文件，如果包名改变必须重新配置并且重新下载google-services.json。将下载的配置文件复制到项目模块文件夹，通常为 app/。
注：如果您有多个CPS渠道包含有已定义的不同包名称，则必须在 Firebase console 中将每个应用添加到您的项目。

3.4.0.2 在WINGSDK后台配置Firebase服务器秘钥

在WINGSDK后台应用配置中，添加Firebase服务器秘钥，打开Firebase控制台，进入项目，进入关联的应用，打开设置页面，打开云消息传递标签页面可以找到服务器秘钥。

3.4.1 集成配置

3.4.1.0 将WINGSDK推送模块集成到项目

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

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

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

3.4.1.1事件记录开关

在AndroidManifest.xml中配置Firebase的事件记录开关

3.4.1.2 获取推送消息的数据

收到推送消息后，WINGSDK将在设备通知栏显示通知，用户点击通知后打开应用程序，会将消息的数据传递给应用（例如自定义的数据），如果在应用中需要接收数据，需要实现一个BroadcastReceiver子类，并且在AndroidManifest.xml配置。当BroadcastReceiver接收到一个Action值为com.wa.sdk.push.intent.NOTIFICATION_OPENED的广播时，即收到了打开的推送消息包含的数据，数据为存放在Intent的Extras中。
说明：推送消息数据的处理非必要，如果推送消息中没有数据需要处理，可以不用配置。

数据接收BroadcastReceiver实现示例
实现一个类继承BroadcastReceiver，在onReceive方法中处理数据

在AndroidManifest.xml中配置Receiver，注意action值必须一致。

3.4.2 发送推送消息

进入WINGSDK后台消息推送页面，填写推送消息的内容，发送到已注册的设备。
说明：
1. 应用启动时Logcat日志中会打印出token，在SDK的Logcat工具的设备信息中也有token信息，如果token不为空，即说明程序已向服务器注册成功，可以接收推送消息了(SDK初始化时自动注册，无需手动调用接口)。
2. 程序卸载后，需要重新注册，覆盖安装不需要重新注册，但是有可能会出现token更新的情况。
3. 推送服务使用Firebase服务，必要时可能需要VPN。

3.4.3 自定义通知图标及背景颜色

该项为可选配置，但是为了更好的通知显示效果，建议配置。
若不使用自定义图标，通知会默认以白色渲染的应用图标作为通知图标来显示，效果参考下方图示。

a、自定义通知图标

在res/drawable文件夹下添加通知图标的图片文件。
通知图标要求：
1.文件名ic_wa_push_notification.png
2.图片格式png
3.图标尺寸参考应用桌面图标。
4.尽量带透明效果，体现图标易于辨认的核心形状。不要有圆形，圆角，方形等不透明背景，保证轮廓辨识度，因为Android系统默认会把该图标统一渲染颜色。若是核心形状辨识度不足，会影响视觉体验。下方有相应效果示例。

b、自定义通知图标背景颜色

1.在AndroidManifest.xml清单中添加下面内容

2.在res/values/colors.xml中添加 color_wa_push_notification 颜色声明，其中色值修改为项目要求的颜色

效果展现

Demo应用图标原图：

通知显示效果：

自定义通知图标增加透明效果，及设置通知图标背景颜色为红色：

自定义后通知显示效果：

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

以Android 13为目标的应用项目，需要在恰当的时机（比如进入游戏时，或勾选开启通知按钮）申请通知权限，否则新安装应用无法接收Firebase通知，以下为申请通知权限逻辑示例：

3.5 广告

WINGSDK广告功能可以向玩家展示视频广告，可实现对观看视频广告的玩家进行奖励，提高广告的点击播放数。通过简单几步配置即可使用。

3.5.0 设置广告缓存成功回调接口

使用广告系统，必须先登录SDK，登录成功后SDK自动同步广告数据，当有新的广告数据缓存完成时，会在此回调中收到通知。

WAAdCachedCallback回调说明：

3.5.1 获取展示广告数接口

这个接口返回当前可展示的广告数量，当返回值大于1时，才能展示视频广告

3.5.2 展示视频广告接口

当用户登录SDK后，SDK自动同步广告并且缓存，缓存成功后广告才可用，有可展示广告时调用接口打开广告页面，无可用广告时返回错误。

说明：extra参数是CP自定义数据，在展示视频的回调中和通知CP后台发放奖励时，会原样返回。

WAAdCallback回调说明：

3.6 智能客服 AIHelp

3.6.0. 判断是否开启AiHelp

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

3.6.1. 展示AiHelp后台配置界面

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

3.6.2.打开游戏评价客服入口

说明：该接口受WING后台中”游戏评价开关”控制。如果后台未开启开关，此接口不生效。

3.6.3.设置客服系统语言

示例代码:

语言支持列表图:

3.6.4.APP对外名称及客服ICON等配置

sdk版本3.9.7及以后版本，废弃原来的设置名称(WACscProxy.setName(game_name))方法，及机器人或人工客服头像的项目本地资源配置方式。统一在AiHelp后台进行配置，设置路径为APP-设置-SDK自定义设置，详情参考《第三方后台配置—Android版》的AiHelp模块的自定义SDK配置章节。

3.7 用户中心（充值中心账号信息）

游戏后台、运营需要如何操作， 参考

3.7.0.获取用户中心数据接口

示例代码

3.7.1.显示用户中心弹窗

示例代码

结果通过传入的回调返回，数据封装在WAShortUrlResult类中。
WAShortUrlResult字段说明

3.8 获取CPS Channel更新链接地址

Android会出现需要分包的情况，分不同的cps channel包，不同的包会有不同的更新链接地址（分包请参阅分包相关文档），获取当前的包的更新链接调用以下接口：

结果在Callback中返回，如果后台配置了渠道的更新地址，将会返回相应渠道的更新链接地址，返回的结果可能为null或者空字符，需要判断处理。

3.9 Android6.0 权限管理

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

参数说明：

示例：

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

示例：

3.10 google 应用内评分

Google 应用内评分参考：
https://developer.android.com/guide/playcore/in-app-review
通过此接口，可以在应用内调起应用内评分

示例：

备注:
评分回调onSuccess后，并不能知道用户是否已经评分，是否弹出评分界面，这是调用google 评分的api流程完成，不能作为用户已经完成评分的依据

谷歌商店评分页面的显示逻辑是完全由谷歌内部控制的，会根据用户是否弹过，评分接口调用频率等等一些逻辑去控制显示或者不显示，这个规则也不对外公开。
如果希望百分百观察到评分页面弹出及操作，需要按照谷歌文档进行操作，建议使用内部测试轨道进行测试。
Google测试说明：

https://developer.android.com/guide/playcore/in-app-review/test?hl=zh-cn

如果发现调不起评分界面，请查看问题排查：
https://developer.android.com/guide/playcore/in-app-review/test?hl=zh-cn#troubleshooting

3.11 游戏评价窗口

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

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

界面效果：

3.12 账号删除

3.12.0 UI版本

sdk内部已经完成了完整流程的UI展示，以及请求接口操作,CP只需要调用即可。

参数说明：

示例代码：

3.12.1 接口版本

接口版本为，cp需要自己做UI，然后调用sdk接口进行删除操作。

3.12.1.0 请求删除账号接口

注意：需要在sdk登录成功的情况下才可调用。

参数说明：

WADeleteResult实体类说明：

示例代码：

3.12.1.1 取消删除账号接口

参数说明：

示例代码：

3.13 打开内置链接

调用该接口，可以使用WebView打开后台配置的内置链接
WACoreProxy.showOpenUrl(Context context, WACallback callback)

注意：必须先在后台配置该链接，否则返回失败

3.14 Consent同意屏幕相关

3.14.0 同意通知ID配置

在AndroidManifest.xml中添加下面代码，其中xxx为同意通知ID，具体值从运营处获取

3.14.1 用户同意界面显示

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

以下情况不会弹出：
1.不在生效地区（一般指欧盟）
2.用户已经在同意界面操作过同意或拒绝

注意：初始化时传入的Activity类型，必须是FragmentActivity，否则同意屏幕无法初始化。

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

3.14.2 打开同意设置

为了允许用户修改同意状态，需要游戏在添加一个按钮入口，并在用户点击按钮入口时调用下面接口打开同意设置界面。

注意：如果不在生效地区（一般指欧盟），调用该接口不会有任何反应。

目的同意设置页，和供应商同意设置页，展示效果：

3.15 AdMob功能

3.15.0 应用ID配置

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

3.15.1 设置测试状态

注意：只有在PlayStore上下载的应用才允许播放生产环境广告，否则可能会因违反AdMob协议而封停账号。

为了确保在本地测试时播放的是测试广告，需要在SDK初始化之前调用该接口传入true，在打线上包时才改为传入false。

参数说明：

示例代码：

3.15.2 横幅广告

横幅广告必须启用硬件加速功能，在AndroidManifest.xml的application标签中添加android:hardwareAccelerated=”true”，示例如下：

在Activity页面的布局中加入的横幅广告

参数说明：

失败处理建议：尽可能确保广告加载失败时，不影响用户后续体验。建议不要
给容器强制保留固定的宽高并设置游戏不一样的特殊背景如纯白背景进行展示。
Google官方使用建议：
植入横幅广告的最佳做法：https://admob.google.com/intl/zh-CN_cn/home/resources/monetize-mobile-game-with-ads

3.15.3 插页广告

3.15.3.0 检查和预加载插页广告

检查插页广告是否已准备好，若未准备好，则内部会立即开始缓存广告。

返回值说明：

备注：SDK初始化后会立即开始缓存广告，无需在此时调用该接口。为了避免调用展示的时候因缓存失败而无法显示，建议在展示前适当的时机调用该接口确保广告预加载成功（该接口判断如果接口未准备好会立即开始缓存）。比如：可以在进入关卡时调用一次该接口，确保关卡完成后调用showInterstitialAd可以正常展示广告。

3.15.3.1 展示插页广告

在Activity页面中展示插页广告

参数说明：

示例代码：

失败处理建议：尽可能确保广告加载失败时，不影响用户后续体验。建议在
WAAdMobProxy.checkinterstitialAdReady()为 false 时，直接忽略显示广告继续游戏。

Google官方使用建议：
最佳实践指南：https://developers.google.com/admob/android/interstitial?hl=en#some_best_practices
植入插页式广告的最佳做法：https://admob.google.com/intl/zh-CN_cn/home/resources/monetize-mobile-game-with-ads

3.15.4.开屏广告

3.15.4.0 检查和预加载开屏广告

检查开屏广告是否已准备好，若未准备好，则内部会立即开始缓存广告。

返回值说明：

3.15.4.1 展示开屏广告

在Activity页面中展示开屏广告

参数说明：

示例代码：

失败处理建议：尽可能确保广告加载失败时，不影响用户后续体验。建议在
WAAdMobProxy.checkAppOpenAdReady()为 false 时，直接忽略显示广告继续游戏。

Google官方使用建议：
最佳实践指南：https://developers.google.com/admob/android/app-open?hl=en#best_practices

场景使用建议：
1.在启动程序的时候展示；考虑到冷启动时要等广告缓存完成才会显示，所以建议创建一个启动页，在启动页中加载游戏资源及显示开屏广告，再进入主游戏页。具体实现，可以参考Demo。
2.从其他应用切回程序的时候展示；为了避免的频繁切换应用展示过多广告，建议进行展示间隔限制，比如30分钟内切回程序只展示一次开屏广告。另外要考虑不要遮挡到可能正在展示的其他广告，比如插页，激励广告。具体实现，可以参考Demo。

Demo代码下载地址：https://github.com/ghw-wingsdk/demo-android/archive/refs/heads/master.zip

3.15.5.激励广告

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

参数说明：

示例代码：

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

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

3.15.6 UMP同意弹窗相关

3.15.6.0 同意弹窗说明

SDK在初始化的时候会在该Activity页面进行UMP同意弹窗初始化，并展示给需要的用户（欧盟地区）进行同意授权，授权完成后AdMob功能才会进行初始化及加载广告。如果是非欧盟地区用户，则会直接返回授权成功，并进行后续逻辑。

以上为SDK内部逻辑，研发无需处理。除此之外，研发需要在游戏内部放置一个按钮，可供用户打开UMP同意设置并修改同意状态，需要用到下面“检查设置”和”展示设置“两个方法。
UMP同意弹窗效果如下：

3.15.6.1 开关配置

UMP功能默认关闭，如果需要开启UMP功能，在AndroidManifest.xml中加入下面配置：

3.15.6.2 检查设置

返回值说明：

3.15.6.3 展示设置

展示UMP同意设置

参数说明：

3.15.6.4 添加UMP同意监听

注意：该接口功能用于配合启动页展示开屏广告，如非必要，无需接入使用。

添加SDK初始化时的UMP同意弹窗授权状态监听，主要在SDK初始化方法之前调用。

参数说明：

示例代码：

3.16 官网包配置

注意：Google包无需配置。

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

2.权限声明

3.Provider声明

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

四、第三方配置

4.0 Google相关配置

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

4.0.0 Google基本配置

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

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

4.0.1 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.0.2 Google代码混淆配置

4.0.3 Google获取SHA-1指纹

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

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

4.1 Facebook相关配置

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

4.1.0 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.1.1 Facebook代码混淆配置

4.1.2 Facebook登录权限对照表

4.2 AppsFlyer相关配置

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

4.2.0 AppsFlyer基本配置

在AndroidManifest.xml中添加以下声明

4.2.1 AppsFlyer代码混淆配置

4.2.2 AppsFlyer卸载检测配置

a）官方说明：官方说明
b）集成Firebase，参考3.7.2 集成配置
c）从Firebase 控制台获取 服务器密钥，填入AppsFlyer的卸载配置中

4.3.智能客服

4.3.0 AIHelp相关配置

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

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

4.3.1 AiHelp混淆配置

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

4.4.华为HMS相关配置

4.4.0.华为HMS基本配置

1）在项目级别根build.gradle中配置华为仓库地址和依赖插件，如下：

2）在应用级别的根目录中添加agconnect-services.json文件，如下图所示：

agconnect-services.json的生成请参考《WINGSDK第三方后台配置.docx》中添加华为HMS后台配置章节。

3）在应用级别的build.gradle中，添加华为插件，如下：
apply plugin: ‘com.huawei.agconnect’
如果使用性能监测，则需要添加APMS开关代码，如下：
agcp{
enableAPMS true
}

4）在应用级别的build.gradle中，添加华为多语种支持，配置如下：
android {
defaultConfig {
//华为多语种设置，由CP配置
resConfigs “en”, “zh-rCN”, “pt”
}
}

支持语言参考：
https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides-V5/support-language-0000001050040564-V5

5）在AndroidManifest.xml中添加配置:

4.4.1.华为HMS混淆配置

1)proguard-rules.pro文件配置

2）AndResGuard配置方式

说明：如果应用无相关混淆可不配置。

4.4.2.华为HMS权限配置

说明：SDK已经集成权限，如果危险权限需要CP动态申请权限。

4.5 weblogin模块相关配置

4.5.0 基础配置

在项目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

4.6 nowgg相关配置

4.6.0 nowgg基本配置

AndroidManifest.xml.xml中application标签下添加以下配置：

CLIENT_ID 和 PAYMENT_ID 的具体值从运营处获取。

PaymentId 付款编号 获取参考：付款编号获取
ClientId 登录凭证 获取参考：登录凭证获取

五、附录

5.0 代码说明

5.0.0 状态码说明

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

5.0.1 平台取值

5.0.2 请求类型说明

说明：vk平台测试游戏邀请功能需要申请权限，可以把请求类型设置成REQUEST_REQUEST来测试普通邀请，待申请权限通过后改成REQUEST_INVITE来测试。关于vk邀请功能的业务流程图如下：

5.1 事件说明

5.1.0 SDK预定义事件名

在WAEventType接口中定义

5.1.1 SDK预定义参数名

在WAEventParameterName接口中定义