Skip to content

GitLab

Switch branch/tag
Find file BlameHistoryPermalink
readme.md 5.18 KB

GATA SDK for iOS

Release

本文档描述了应用程序中集成 GATA SDK 所需必要信息。

集成

在 Xcode 上将 GATA 文件夹(包含 GATA.h 和 libGATA.a 两个文件)拖入工程中，并确保 Copy items if needed 选择框处于选中状态。

最低 iOS 版本

GATA SDK 需要 iOS 6.0 或更高版本才能正常工作。

Xcode8 + 配置

GATA SDK 使用了 iOS 10 新的 UserNotifications.framework 框架来实现通知功能，故需要在 Xcode8 以上的版本中做如下配置：

  1. Linked Frameworks and Libraries 中添加 User​Notifications.framework 并将 Status 改为 Optional

  2. 将远程推送配置项开启 Push Notifications 后才能正确获取 deviceToken。 操作步骤：选中当前工程中的 Target -> Capabilities -> Push Notifications -> On

系统依赖框架

libresolv.tbd

CoreLocation.framework (可选，如需定位功能需依赖此框架)

UserNotifications.framework (可选，Xcode8 以上需要添加并修改 Status = Optional)

初始化

游戏大区设置(必接)

// 设置游戏大区，如不设置默认区域为国内
[GATA setRegion:GATARegionChina];

注：需要在初始化 startWithAppID 方法前调用。

启动并初始化(必接)

在 AppDelegate 中编写如下代码：

#import "GATA.h"
// ...
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	// 设置游戏大区，如不设置默认区域为国内
	[GATA setRegion:GATARegionChina];
	// 启动并初始化 SDk
	[GATA startWithAppID:@"AppID" channel:@"channel"];

	// ...
}

appId: 此id是数据平台单独配置的游戏唯一标记,与GaeaSDK的游戏ID不同。

channel: 游戏的渠道号，默认为 AppStore，渠道会作为一个数据细分的维度。

注：该接口在游戏启动时调用，用于设置游戏在 GATA 平台申请的唯一标识，请务必填写正确的 appId。

记录自定义事件

[GATA logEvent:@"event name ..."];
// or
[GATA logEvent:@"event name ..." content:@"event content"];
// or 
[GATA logEvent:@"event name ..." parameters:@{@"key", @"value"}}];

eventName: 事件标识名

content: 其它内容

parameters: 参数字典

用户角色统计

GAEA 用户登录(必接)

GAEA 用户登录/注册成功后需调用此接口

[GATA gaeaLoginWithUserId:@"userId"];

userId: 登录用户唯一标识

游戏角色创建(必接)

[GATA roleCreateWithRoleId:@"roleId" serverId:@"serverId"];

roleId: 游戏角色ID

serverId: 分服ID，如果是先创建角色后选区服的游戏，这里填@“”，在后面单独用setServerID单独赋值

游戏角色登录(必接)

[GATA roleLoginWithRoleId:@"roleId" serverId:@"serverId" level:0];

roleId: 游戏角色ID

serverId: 分服ID，如果是先创建角色后选区服的游戏，这里填@“”，在后面单独用setServerID单独赋值

level: 游戏角色等级

游戏角色登出(必接)

[GATA roleLogout];

设置角色等级(必接)

[GATA setLevel:];

获取设备deviceid(服务器日志上报接口必用)

此值对应服务器日志上报接口的deviceId。

[GATA deviceId];

获取设备idfa(服务器日志上报接口使用，也可自行获取)

此值对应服务器日志上报接口的deviceId1。

[GATA idfa];

获取设备idfv(服务器日志上报接口使用，也可自行获取)

此值对应服务器日志上报接口的deviceId2。

[GATA idfv];

获取App Version(服务器日志上报接口使用，也可自行获取)

[GATA appVersion];

可选功能

APNS 远程推送功能

GATA 数据 SDK 从 2.1.2 版本开始支持远程推送功能，开发商可自由选择是否接入。SDK 默认会在初始化时注册远程推送通知获取 device token 并上报，如要禁用此功能需在初始化前调用 disableRemoteNotifications 接口来禁用推送上报。

Crash 异常捕获上报

数据 SDK 默认开启异常捕获上报功能，如果开发者的工程有集成其它第三方专业的同类工具(如Bugly、Fabric Crashlytics)的话，为了避免捕获冲突需要将数据 SDK 的异常捕获功能关闭。

// 禁用数据 SDK 的异常捕获上报
[GATA setCrashReportingEnabled:NO];

记录错误日志

[GATA logError:@"NSInternalInconsistencyException ..."];

上报经纬度位置

[GATA setLatitude:39.99749624 longitude:116.48459139];

充值接口(已废弃) 

[GATA rechargeWithTransactionId:currencyAmount:currencyType:payChannel:goodsId:success:];

transactionId: 交易序列号

currencyAmount: 充值金额

currencyType: 货币类型

payChannel: 支付渠道

goodsId: 商品ID

success: 交易是否成功

记录ping的信息

记录ping的信息

[GATA checkNetworkStatusWithIp:@"ip或域名"]