一、简介

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 环境配置要求

1、系统：Mac OS
2、开发工具：Xcode（14.0及以上）
3、Deployment Target:iOS12.0及以上版本

2.2 集成SDK到项目

集成步骤:
1、集成相应库到项目中 参考:2.2.1 库的引用
2、添加依赖库，以及配置 参考: 2.2.2 工程构建配置
3、修改配置文件 参考: 2.2.3 WINGSDK基本配置
4、编译正常，可继续sdk代码集成 参考: SDK初始化

建议:cp可先运行demo,看下配置以及需要引用的第三方库，再接入
集成参考demo: demo代码下载地址

2.2.1 库的引用

SDK的抽象层和实现层以framework的形式提供，CP可以使用cocoapods的方式或者自行下载framework拖进xcode项目的方式进行引用。

方式一：使用cocoapods进行引用

CP可以使用Cocospods进行引用更新。

这部分脚本请使用WINGSDK打包配置页面生成，CP可以将生成的脚本代码复制到自己的Podfile中。
WINGSDK打包配置页面地址：https://admin.wingsdk.com/developers/pack_config.do

目前SDK提供的库包括：
抽象层：

• WASdkIntf——必接

实现层：

• WASdkImpl（WingSdk）——必接

其它可选：

• WAAdImpl(Ad)——可选

• WAAfImpl(Appsflyer)——可选

• WAApImpl(Apple)——可选

• WACbImpl(Chartboost)——可选

• WAFbImpl(Facebook) ——可选

• WAPushImpl(Push)——可选

• WAVkImpl(VK)——可选

• WATwitterImpl(Twitter)——可选

• WAInstagramImpl(Instagram)——可选

• WAAiHelpImpl(AiHelp) ——可选

• WAWebPayImpl(WebPay)——可选,如果需要第三方支付则需添加此模块

• WAFirebaseImpl(Firebase)——可选

• WAWebLoginImpl(WebLogin)——可选

提示:使用CocoaPod引用的项目打开项目时需要点击’xcworkspace’而不是’ xcodeproj’

方式二：手动引用

如果手动引用，可以使用WINGSDK打包配置页面https://admin.wingsdk.com/developers/pack_config.do进行各个包的下载，并添加到xcode项目中。

下载完成后解压，把解压后的文件拖入xcode工程，其中WASdkIntf和WASdkImpl是必接库，其它可选。
注意：需要加入系统库libsqlite3.tbd(libsqlite3.dylib)、libz.tbd(libz.dylib)

2.2.2 工程构建配置

在项目Build Settings中搜索Other Linker Flags 修改值为-ObjC
如下图

需要引用的库：
AppTrackingTransparency.framework
libz.1.dylib
Accelerate.framework
libc++.tbd
libresolv.tbd
WebKit.framework
sqlite3

2.2.3 WINGSDK基本配置(wa_sdk.plist)

在 WASdkIntf下，以及配置文件wa_sdk_track_config.plist，wa_sdk.plist，如下图。

wa_sdk.plist文件配置:

参数说明：
WaSdkServerUrl：WINGSDK后台url（生产环境：https://api.wingsdk.com/sdkapi/）
appKey：WINGSDK后台appKey
appId：WINGSDK后台appId
os：手机操作系统
channel：发布渠道

关于wa_sdk_track_config.plist详见2.6.1 配置 (wa_sdk_track_config.plist)

2.3 SDK初始化

从3.12.0以及以后，需要增加如下配置:

1、在项目target，Signing&Capabilities，选择All，添加Capability，选择Keychain Sharing

2、点击+号，输入gamehollywood.wingsdk.clientid.group

导入头文件
#import <WASdkIntf/WASdkIntf.h>

1、请在AppDelegate的didFinishLaunchingWithOptions 调用下面代码:

2、在AppDelegate的applicationDidEnterBackground调用下面代码：

3、在AppDelegate的applicationWillEnterForeground调用下面代码：

4、在AppDelegate的applicationDidBecomeActive调用下面代码：

注：如新建Xcode项目，会默认创建SceneDelegate文件，则需要以下适配（如无SceneDelegate文件则忽略）：

2.4 登录

登录过程中如果涉及到应用间跳转，需要在AppDelegate中实现以下方法

2.4.1 登录对话框

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

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

2.4.1.1 实现协议 WALoginViewDelegate

登录结果说明 WALoginResult

3.4.1.2 调用方法

+(void)login:(id<WALoginViewDelegate>)delegate cacheEnabled:(BOOL)cacheEnabled;
cacheEnabled是否缓存登录方式。如果缓存登录方式，第二次调用的时候直接按照上次的登录方式进行登录，不会弹出登录选择框。如果想弹出登录选择框,请调用clearLoginCache方法,清除缓存
代码示例：

2.4.1.3 清除登录方式的缓存(重新弹出登录选择框)

+(void)clearLoginCache;
代码示例：

2.4.1.4 隐藏登录选择框

+(void)hide;
代码示例：

2.4.2 用户登录接口

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

2.4.2.1登录接口

(1)选择登录方式

+(void)loginWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WALoginDelegate>)delegate;
注：extInfo目前主要用于应用内登录等高级登录设置，请参考3.3.2 应用内登录相关章节
代码示例：facebook登录

登录平台请参考5.1.2 平台取值

2.4.2.2 实现协议WALoginDelegate中定义的方法

说明：关于APPLE登录，用户每次进入APP进行登录操作，Game Center只进行一次授权。假如用户在第一次登录的时候取消了，以后每次进行登录，程序都会执行登录取消的协议方法，除非用户结束应用重新打开。同样的，第一次登录的时候，出现Game Center授权错误，之后程序都会执行登录失败的协议方法，除非用户结束应用重新打开。

2.4.3 用户登出

退出游戏的时候，必须登出操作。用户登出调用以下接口：
[WAUserProxy logout];
注意：调用logout接口后，serverId、gameUseId、level字段值会被重置，如果需要保持相应字段的值不重置，需要重新设置相应字段的值，参考3.1 公共参数设置

2.5 支付

WINGSDK支付流程如下：

2.5.1 初始化

使用对应平台的支付服务前必须对其进行初始化，请在AppDelegate的didFinishLaunchingWithOptions方法调用以下方法。
+(void)init4Iap;
代码示例：

2.5.2 查询商品

2.5.2.1 实现协议 WAInventoryDelegate

2.5.2.2 调用方法

查寻库存商品，调用以下接口：
+(void)queryInventoryWithDelegate:(id<WAInventoryDelegate>)delegate;
代码示例：

注意：这里返回的库存商品信息是WINGSDK平台的商品信息，并非第三方平台的商品信息。
建议在商品页出来之前调用，最好是sdk初始化完后就开始调用，如下

2.5.3 购买商品

2.5.3.1 实现协议 WAPaymentDelegate

支付结果说明 WAIapResult

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

2.5.3.2 调用方法

购买指定平台的商品，调用以下接口：
+(void)payWithProductId:(NSString*)productId extInfo:(NSString*)extInfo delegate:(id<WAPaymentDelegate>)delegate;
代码示例：

参数说明：

2.5.3.3 查询商品本地价格

通过查询商品信息，可以获取库存商品的本地价格，查询商品本地价格调用接口:
+ (void)queryChannelProduct:(NSString )channel
callBackBlock:(void(^)(NSArray channelProductsArray,NSError *error))callBackBlock

代码示例

注意：这个接口需要在查询库存商品（ queryInventoryWithDelegate）成功回调后使用。
参数说明：

实体结果说明 WAChannelProduct:

2.5.4支付服务是否可用

通过以下接口可以获取支付服务是否可用，返回boolean类型结果，true为可用，false为不可用，只要有一个支付渠道可用即为true：
+(BOOL)isPayServiceAvailableWithPlatform;
代码示例：

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.1 配置 (wa_sdk_track_config.plist)

对各个平台进行相应的配置（修改wa_sdk_track_config.plist）。注：文件名以及key值不可修改。

其中，AppleAppID可以在iTunes Connect(https://itunesconnect.apple.com)中新建应用之后获取，具体可以参考iOS-第三方后台配置文档“Apple基础配置”章节。

每个数据收集平台都有相应的开关，可以进行配置。下图的Enable就是开关，Enable： YES-开，NO-关。

WINGSDK URL正式环境的地址： https://api.wingsdk.com/data/

2.6.2 调用

2.6.2.1 导入头文件

#import <WASdkIntf/WASdkIntf.h>

2.6.2.2 工程启动时初始化

您需要在第一次启动在应用程序上进行SDK初始化。请保证在发送下面的跟踪事件之前进行SDK初始化。请在AppDelegate中的didFinishLaunchingWithOptions方法中添加以下代码：
[WACoreProxy initAppEventTracker];

2.6.2.3 调用事件进行追踪

安装和打开游戏事件是内部触发的，另外关于充值事件(WAEventPayment)和点击充值(WAEventInitiatedPayment)的跟踪已经在WINGSDK中自动调用，用户不用自己调用。若不想启用这两个事件的自动跟踪，可在didFinishLaunchingWithOptions进行如下操作：
[WATrackProxy autoTriggerAfterPayment:NO];
调用方法有两种。方法一调用方法简单，但是发送到各个渠道的事件名称（eventName）、参数（params）、累加值（value）是一样的。如果需要自己设置事件名称、参数、累加值，请使用方法二。

2.6.2.3.1 方法一

注：当使用带有小数点的数值时，使用NSDecimalNumber类型，如[NSDecimalNumber decimalNumberWithString:@"8.88"];
调用事件的用法如下：
+(void)trackWithEventName:(NSString *)eventName valueToSum: (double)value params:(NSDictionary *)params;
-eventName:事件名称可在附表中查询
-valueToSum:传入一个double值作为累加值，没有累加值可以传0。
-params:参数字典参数可在附表中查询
例如：

调用购买事件WAEventPayment，
参数：WAEventParameterNameContentType道具类型，
WAEventParameterNameContentID内容ID,
WAEventParameterNameItemAmount购买数量，
WAEventParameterNameCurrencyType货币类型,
WAEventParameterNameCurrencyAmount现金额
…

2.6.2.3.2 方法二

注：当使用带有小数点的数值时，使用NSDecimalNumber类型，如[NSDecimalNumber decimalNumberWithString:@"8.88"];

2.6.2.3.2.1 调用示例

步骤一 构建WAEvent实例

步骤二 发送数据：

2.6.2.3.2.2 关于WAEvent 实例的构建

（1）设置默认的事件名称

设置该事件的事件名称，请参考5.2.1 SDK 预定义事件名
event.defaultEventName = WAEventLevelAchieved;

（2）设置渠道自定义事件名称

注：
1）eventNameDict的key参考附表 2.6.2 渠道名称表
2）AppsFlyer和facebook的应用内事件和WINGSDK的应用内事件已经做了映射（例如: ghw_login <-> af_login，ghw_login<->fb_login，参考下图），用户无需再手动自定义。
3）如果不进行设置，所有的渠道将采用设置的默认值(defaultEventName)。

各渠道事件映射对应表

（3）设置默认累加值

设置累加值用于统计数字，比如购买的金额等
event.defaultValue = 1;

（4）设置渠道自定义累加值

1）valueDict的key值参考 附表2.6.2 渠道名称表
2）如果不进行设置，所有的渠道将采用设置的默认值（defaultValue）。

（5）设置事件默认的参数/值

注：
1）参数名称参考5.2.2 SDK 预定义参数名

（6）设置事件渠道自定义的参数/值

注：
1）渠道名称参考：附表 2.6.2 渠道名称表
2）参数名称参考：5.2.2 SDK 预定义参数名
3）如果不进行设置，所有的渠道将采用设置的默认值（defaultParamValues）

（7）渠道开关设置

注：以上代码会关闭Appsflyer对该事件的收集，而Facebook、WINGSDK、Chartboost、firebase是打开的。默认情况下，WINGSDK和Appsflyer、firebase是打开的，而Facebook和Chartboost是关闭的。

2.6.3 预定义事件

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

2.6.3.1 ghw_user_import

说明：导入用户事件，用户每次进服事件–通过用户id在后台查找

注意：发送ghw_user_import事件前需要调用 设置服务器ID 和设置角色ID 、设置昵称、设置级别
代码示例：

2.6.3.2 ghw_initiated_purchase 点击购买

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

2.6.3.3 ghw_purchase 购买完成

说明:点击购买的时候调用（用于游戏内部虚拟交易统计）。
注：valueToSum（或者defaultValue）的值要传，而且值要和price一样。

代码示例：

2.6.3.4 ghw_level_achieved

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

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

代码示例：

2.6.3.5 WAEventUserCreate

说明:创建游戏角色

代码示例：

2.6.3.6 ghw_self_tutorial_completed 完成新手任务

说明:新手完成新手任务时调用
无参数
代码示例：

2.6.3.7 ghw_self_lv_x 关键等级

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

无参数

代码示例：

2.6.3.8. ghw_user_info_update 更新用户信息

代码示例：

2.6.4 自定义事件

事件描述：自定义事件
事件名称：自定义
参数：自定义
有无累计值：自定义
说明:支持自定义事件的统计
自定义

自定义事件目前只支持事件名和累加值，见示例。
例如：

附表 2.6.1 货币标识

详见：https://en.wikipedia.org/wiki/ISO_4217

附表 2.6.2 渠道名称表

2.6.5 获取 IDFA 弹出“询问用户是否授权”适配

应苹果要求，iOS14后，获取IDFA需要授权弹框。目前sdk默认为不弹框获取用户授权。如需弹框授权，需要以下步骤
1、xcode升级到12或者以后版本
2、接入sdk3.9.1或以后版本
3、Info.plist 中新增 key Privacy – Tracking Usage Description ，value 填写使用 IDFA 原因。其中原因将展示给用户。参考文案：Your info will be used for personalized ads.

效果如图：

2.7. 隐私政策

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

2.7.1 获取隐私政策url

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

示例：

2.7.2 获取隐私政策更新时间

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

示例：

2.7.3 显示隐私政策详情UI

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

示例：

三、高级功能

3.1 公共参数设置

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

3.1.1 设置服务器ID

当用户的服务器ID发生改变时，需要调用设置服务器ID接口设置新的服务器ID，例如每次进入服务器：
[WACoreProxy setServerId: @"127.0.0.1"];
注意：设置服务器ID的操作在每次选服后都需要进行，必须在调用其他接口前设置。

3.1.2 设置用户gameUserId

用户在选择服务器并且登录之后将用户gameUserId设置到SDK中以便于跟踪。
[WACoreProxy setGameUserId:@"12345"];

3.1.3 设置用户等级level

设置游戏玩家的角色等级，调用接口：
[WACoreProxy setLevel:10];
注意：第一次进服获取玩家等级或玩家等级变更后，需要及时调用这个接口设置玩家等级，必须在调用其他接口前设置。

3.1.4 设置玩家昵称

设置游戏玩家的昵称，调用接口：
[WACoreProxy setNickName:@"测试角色名称"];
注意：
1.当玩家登录、登出游戏，或修改昵称时，需要及时调用这个接口设置玩家昵称。
2.调用该接口设置昵称后，玩家进行购买时会自动记录昵称到订单信息中。

3.2 调试模式

3.2.1 开启、关闭调试模式

WINGSDK具备调试模式并提供了Log悬浮按钮调试工具，打开调试模式就会显示Log悬浮按钮，使用这个工具测试人员不需要IDE环境就可以在工具窗口中查看调试信息。开启/关闭调试模式调用以下接口（WINGSDK默认是关闭调试模式的）。
[WACoreProxy setDebugMode:YES];
关闭调试模式：
[WACoreProxy setDebugMode:NO];

3.2.2 如何获取 client_id

打开调试模式后，显示Logcat工具，点击-设备信息-clientid，点击获取

3.3 登录高级设置

3.3.1 设置登录流程接口

使用该接口需注意以下两点：
1)一般来说，如果应用登录的时候有登录方式选择界面，就不需要使用此接口，此接口默认是这种方式（取值为1）。

2)这个接口主要是用来满足以下需求：用户第一次登录是以游客方式进行登录，进到应用里面可以切换其它登录方式，下次登录会直接以切换后的账户进行登录（取值为2）。

+(void)setLoginFlowType:(int)flowType;
代码示例：
[WAUserProxy setLoginFlowType:WA_LOGIN_FLOW_TYPE_DEFAULT];
登录流程有两种模式，在WAConstants类中定义，取值如下表：

3.3.2 应用内登录

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

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

实例：

字段说明：

3.4 账户管理

3.4.1 使用账户管理页面

SDK内置了账户管理页面，打开这个内置的页面之前必须先登录，通过这个页面可以对账户进行管理操作，包括账号绑定、解绑、切换账户、新建账户。

3.4.1.1 实现协议 WAAcctManagerDelegate

3.4.1.2 调用方法

+(void)openAccountManager:(id<WAAcctManagerDelegate>)delegate;

代码示例：

3.4.1.3 关于绑定解绑的通知

账户管理界面没有返回绑定和解绑结果，但是会以通知的方式将结果回调给CP。当绑定有结果之后（无论成功失败），将回传一个WABindingResult实例。当解绑有结果（无论成功失败），将回传一个WAAccount实例。有四个通知，分别是绑定成功、绑定失败、解绑成功、解绑失败，通知的名称分别是以下常量：
WABindDidSucceedNotification;//绑定成功
WABindDidFailNotification;//绑定失败
WAUnbindDidSucceedNotification;//解绑成功
WAUnbindDidFailNotification;//解绑失败

注：关于绑定facebook成功之后，请注意触发邀请奖励。代码如下：

3.4.2 绑定第三方平台账户

3.4.2.1 实现协议WAAccountBindingDelegate

说明：关于APPLE账号的绑定，请参考2.4.2.2 实现协议WALoginDelegate中定义的方法的说明。

3.4.2.2 调用方法

+(void)bindingAccountWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WAAccountBindingDelegate>)delegate;
绑定平台取值：

示例代码：

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

通过以下接口，可以查询当前的账户已经绑定的第三方平台账户：
+(void)queryBoundAccountWithCompleteBlock:(void(^)(NSError* error,NSArray<WAAccount *>* accounts))block;

示例代码：

3.4.4 解绑第三方平台账户

通过以下接口，可以解绑已经绑定的第三方平台账户：
+(void)unBindAccountWithPlatform:(NSString *const)platform platformUserId:(NSString*)pUserId completeBlock:(void(^)(NSError* error))completeBlock;
有以下情况之一者，不可解绑：
1．解绑的账户为WINGSDK平台的；
2．用户没有绑定第三方平台账户的；
3．用户只绑定一个第三方平台账户，且用户没有与当前设备绑定的。
示例代码：

3.4.5 切换账户

使用以下接口可以快速切换登录的账户
+(void)switchAccountWithPlatform:(NSString *const)platform completeBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

3.4.6 新建账户

+(void)createNewAccountWithCompleteBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

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

3.4.7获取账户信息

SDK提供了获取指定平台的账户信息，可以通过以下接口获取：

+(WAAppUser*)getAccountInfoWithPlatform:(NSString *const)platform;

示例代码：

3.7消息推送

WINGSDK推送功能是基于苹果APNS，可以给客户端发送推送通知，通过简单几步配置即可使用。

3.7.1苹果相关配置

导出App推送证书为p12，并上传到WINGSDK后台。
注意：
1、苹果消息推送证书配置请参考Apple官方文档
http://help.apple.com/xcode/mac/current/#/dev11b059073

3.7.2推送集成配置

添加推送模块依赖方法参考2.2 集成SDK到项目
注：Appsflyer卸载检测某些配置与消息推送一样，但如果是用于Appsflyer，此步骤可忽略

3.7.3 Xcode配置

1)开启推送功能

在 Xcode 8.x 以上，必须开启Push Notification能力。找到应用Target设置中的Capabilities -> Push Notifications，确认开关已经设为ON状态。如果没有开启该开关，在 Xcode 8.x 上编译后的应用将获取不到DeviceToken。

2)APNs静默推送权限设置

为了更好支持消息推送，提高消息到达率，需要配置APNs静默推送权限

3.7.4 编写集成代码

1、导入文件头，在AppDelegate中导入:
#import <UserNotifications/UserNotifications.h>

2、初始化消息推送，在AppDelegate的application:initPushWithDelegate:调用下面代码:

注：Appsflyer卸载检测某些配置与消息推送一样，但如果是用于Appsflyer，此步骤可忽略

3、监控用户对推送消息的设置

4、注册DeviceToken
在AppDelegate的application:didRegisterForRemoteNotificationsWithDeviceToken:调用下面代码:

5、监控APNs推送错误
在AppDelegate的application:didFailToRegisterForRemoteNotificationsWithError:调用下面代码:

6、为更好统计用户在不同场景下和不同iOS系统中收到的消息，需在AppDelegate的userNotificationCenter: willPresentNotification:调用下面代码:

7、在iOS 10 以前，为统计 APNs 消息接收事件，需在AppDelegate里的application:didReceiveRemoteNotification:fetchCompletionHandler:回调方法中调用以下接口

对于iOS 10 及以后版本，为统计 APNs 消息接收事件,需要AppDelegate实现协议 UNUserNotificationCenterDelegate，然后在AppDelegate的 userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:回调方法中调用以下接口：

8、iOS10中，App可以在前台获取通知，为统计这种消息的接收情况，需在AppDelegate的userNotificationCenter:willPresentNotification:withCompletionHandler:调用下面代码:

3.8 越狱检测

WINGSDK具备调试模式并提供了检测设备是否越狱接口

3.10 智能客服 AIHelp

3.10.1. 判断是否开启AiHelp

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

3.10.2.展示WING后台配置界面

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

3.10.3.判断是否开启游戏评分AiHelp

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

3.10.4. 打开游戏评分AiHelp界面

说明：该接口受WING后台中参数设置-客户端-游戏评价开关
控制。如果后台未开启开关，此接口不生效。

调用示例：
        

3.10.5.设置客服系统语言

示例代码:

参数说明：

语言支持列表图:

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

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

3.11.1 获取用户中心数据接口

3.11.1.1实现协议WAUserCenterNoticeDelegate

WAUserCenterResult说明

3.11.1.2 调用方法

3.11.2 显示用户中心弹窗

3.11.2.1实现协议WAUserCenterNoticeUIDelegate

1）用户中心界面关闭回调接口

2）用户中心界面错误回调接口

3.11.2.2调用方法

3.12 调用评分模块

3.12.1 调用评分界面

cp可根据需求，调用appStore评分界面，调用方法

系统要求：iOS10.3及以上系统才可以调起评分界面。

3.12.2 调用游戏评价窗口

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

 [WAUserProxy openGameReview:block]

注意：
1.如果需要评价完成给用户发放奖励，可以在OpenGameReviewStateOpentReview回调中进行处理
2.该功能受WingSDK后台开关控制，需要打开游戏评价开关
3.评分功能是无法获得用户是否进行评分以及具体评分内容和分值的
4.由于apple评分没有任何回调，无法感知用户操作，目前的OpenGameReviewStateOpentReview回调为点击提交好评按钮后5秒进行回调返回。

示例代码：

3.13 账号删除

3.13.1 UI 版本

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

类名：WAUserProxy
方法名：requestDeleteAccoutUI
返回值：callback
调用方法：WAUserProxy.requestDeleteAccoutUI

调用示例:

3.13.2 接口 版本

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

3.13.2.1 第三方账号删除授权接口

描述:如果是SIGGINWITHAPPLE登录（可通过接口[WAUserProxy getCurrentLoginPlatform]获取登录方式），需要单独授权一次拿到授权信息,然后再调用请求删除账号接口，目前只支持SIGGINWITHAPPLE
类名：WAUserProxy
方法名：deleteAccounAuthorizationWithPlatform
请求参数:paltform，登录平台
调用方法：WAUserProxy.deleteAccounAuthorizationWithPlatform
调用示例:

WADeleteRequestModel说明

3.13.2.2 请求删除账号接口

类名：WAUserProxy
方法名：requestDeleteAccout
请求参数:(WADeleteRequestModel*)deleteResult,如无则传递nil。此参数通过调用第三方账号删除授权接口回掉获取。如signinwithappie需要传递此参数
返回值：callback
调用方法：WAUserProxy.requestDeleteAccout
调用示例:

3.13.2.2 取消删除账号接口

类名：WAUserProxy
方法名：cancelRequestDeleteAccoutWithUserid
返回值：callback
调用方法：WAUserProxy.cancelRequestDeleteAccoutWithUserid
调用示例:

3.14 Consent同意相关

3.14.1 同意通知ID配置

Info.plist的配置如下：
GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE NO
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS NO
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE NO
GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA NO
FacebookAutoLogAppEventsEnabled NO
ConsentNoticeId (运营提供)

如

ConsentNoticeId 为Consent后台创建的应用id，具体内容咨询运营人员。

3.14.2 同意界面显示

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

以下情况不会弹出：
1.不在Consent生效地区（一般指欧盟）
2.苹果TTA弹框，用户选择了拒绝
3.用户已经在同意界面操作过同意或拒绝
弹出效果图如下

3.14.3 打开同意设置

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

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

弹出效果图如下：

3.15 AdMob功能

3.15.1 配置

a、在Info.plist文件中,添加key为GADApplicationIdentifier，value为对应AdMob的应用ID，具体值从运营处获取
b、在Info.plist文件中添加key为SKAdNetworkItems ，Array类型，具体值为

3.15.2 设置测试状态

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

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

参数说明：

示例代码：

3.15.3 横幅广告

参数说明：

3.15.4 插页广告

3.15.4.1检查和预加载插页广告

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

返回值说明：

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

3.15.4.2 展示插页广告

示例代码：

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

3.15.5 开屏广告

3.15.5.1检查和预加载开屏广告

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

返回值说明：

3.15.5.2检查和预加载开屏广告

示例代码：

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

3.15.6 激励广告

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

参数说明：

示例代码：

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

3.15.7 UMP同意弹窗相关

3.15.7.1同意弹窗说明

SDK在初始化的时候会在页面进行UMP同意弹窗初始化，并展示给需要的用户（欧盟地区）进行同意授权，授权完成后AdMob功能才会进行初始化及加载广告。如果是非欧盟地区用户，则会直接返回授权成功，并进行后续逻辑。
以上为SDK内部逻辑，研发无需处理。除此之外，研发需要在游戏内部放置一个按钮，可供用户打开UMP同意设置并修改同意状态，需要用到下面“检查设置”和”展示设置“两个方法。

UMP同意弹窗效果如下：

3.15.7.2 开关配置

UMP功能默认关闭，如果需要开启UMP功能，在Info.plist中加入下面配置：
AdmobUseUMP 为YES

3.15.7.3 检查配置

检查是否需要展示UMP同意设置。

返回值说明：

3.15.7.4 展示配置

展示UMP同意设置

参数说明：

示例代码：

3.15.7.5添加UMP同意监听

SDK初始化时的UMP同意弹窗授权状态监听.

notification.userInfo回掉参数说明：

示例代码：

四、第三方配置

4.1 Facebook相关配置

4.1.1 Facebook基本配置

游戏如需使用Facebook相关登录、社交、数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节
具体配置请参考第三方后台配置—iOS版 二、Facebook第三方登录后台配置。
1、在facebook开发者平台创建一个Facebook应用，创建完之后会生成App ID和App Secret
这里的App ID要配置在项目当中，作为客户端与后台服务器连接的标识

注：从3.9.7版本开始，需要配置FacebookClientToken，获取方式：设置-高级-客户端口令

2、在Xcode中配置相应的信息，主要是在info.plist文件中配置URL Schemes、FacebookAppID、FacebookDisplayName、FacebookClientToken。注意一定要对应到facebook后台该App的App ID和Display Name、FacebookClientToken。参考步骤1的截图。

3、针对iOS9做的一些配置
(1)Whitelist Facebook Servers for Network Requests
在info.plist增加下面配置

(2)Whitelist Facebook Apps

4.1.2 Facebook登录权限对照表

4.2 APPLE相关配置

游戏如需使用APPLE账号进行登录、APPLE商店进行支付，需要进行以下配置。 如果不需要使用APPLE相关功能，请忽略此章节
具体配置请参考第三方后台配置—iOS版 一、Apple后台应用配置。

4.3 Appsflyers 相关配置

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

4.3.1 数据收集配置

详见2.6.1 配置 (wa_sdk_track_config.plist)
appsflyer 的DevKey获取方式参考：获取AppsFlyer的DevKey

4.3.2卸载检测

a)官方说明：https://support.appsflyer.com/hc/en-us/articles/211211963-iOS-Uninstall-Tracking

b)对接WINGSDK代码同3.7消息推送

c) 导出App推送证书p12文件，进入appsflyer后台–配置-应用配置-卸载模块
上传p12证书与密码，点击验证。开启卸载衡量开关

4.8 智能客服 AIHelp 相关配置

如果不需要AiHelp 功能，请忽略此章节
具体配置请参考WINGSDK第三方后台配置-智能客服 AIHelp 相关章节。

4.8.1 在AiHelp开发者平台创建一个AiHelp应用，创建完之后会生成appId、domain和appSecret(appKey)

可复制下面代码到info.plist中在修改为对应appId、domain和appSecret(appKey)

注：从3.9.7版本开始，项目中的domain如果为gamehollywoodhk@aihelp.net，接入新版本后，可能后闪退，需要把domain的@改成.
如 gamehollywoodhk.aihelp.net

4.8.2 配置权限

Privacy – Photo Library Additions Usage Description

4.9 Firebase相关配置

如果不需要Firebase 功能，请忽略此章节
具体配置请参考WINGSDK第三方后台配置-Firebase相关章节。

4.9.1 接入

1、引入WAFirebaseImpl库到项目
2、引用GoogleService-Info.plist配置文件到项目中

Firebase SDK会自动收集事件，详情请参考:Firebase自动收集事件。
完成以上两个步骤，即完成Firebase 模块的接入工作

4.9.2 调试

firebase analytics调试方法
1、在xcode中，选择Product > Scheme > Edit scheme…
2、在左侧菜单选择Run
3、选择Arguments 项
4、在Arguments Passed On Launch区域，添加-FIRAnalyticsDebugEnabled

5、运行项目后，登录firebase 管理后台，项目—分析—DebugView模块，可查看到调试设备上传事件

5.0 weblogin模块相关配置

在Info.plist文件中，URL types下配置URL Schemes

注意
1.格式为wa+YOUR_SDK_APPID。比如SDK的appid为f7f9a9d18da611e5a0be000d3a906774，则对应内容为waf7f9a9d18da611e5a0be000d3a906774
2.这里SDK的appid为wingsdk的appid

五、附录

5.1 代码说明

5.1.1 状态码说明

SDK所有的状态码都定义在枚举WACode中，详见下表：

5.1.2 平台取值

5.1.3 请求类型说明

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

5.2 事件说明

5.2.1 SDK 预定义事件名

5.2.2 SDK 预定义参数名