《统计系统》

获取统计插件对象

local agent = AgentManager:getInstance()
local analytics_plugin = agent:getAnalyticsPlugin()

相关接口

Session 的统计

1、startSession,在需要开启统计的地方,调用 startSession(),用于跟踪用户使用中的打开应用和页面跳转的数据。

analytics_plugin:startSession()

2、stopSession,在需要关闭统计的地方,调用 stopSession(),用于跟踪用户离开页面和退出应用的数据。

analytics_plugin:stopSession()

注:
一般 Android 会在 onResume 和 onPause 时调用,在 Lua 里可以在进入游戏(或切换到前台)和 离开游戏(或切换到后台)时调用;iOS 启动游戏的时候调用即可。(PS:以后可能会改成在插件代码里自动调用)

自定义事件

自定义事件可以实现在应用程序中埋点来统计用户的点击行为。同时,自定义事件还支持添加一些描述性的属性参数,使用多对 Key-Value 的方式来进行发送(非必须使用),用来对事件发生时的状况做详尽分析。

一、使用自定义事件的依赖条件

  1. 使用自定义事件功能请先该统计 SDK 的管理后台添加相应的事件后,服务器才会对相应的事件请求进行处理。
  2. 自定义事件的代码需要放在 Activity 里面的 onResume 方法后面。

调用方式:

analytics_plugin:logEvent("1")
analytics_plugin:logEvent("1", {test = "123"})

设置会话时长

当用户两次使用之间过长时,将被认为是两个的独立的 session(启动),例如用户回到 home,或进入其他程序,经过一段时间后再返回之前的应用。可通过接口: setSessionContinueMillis(long interval) 来设置这个间隔(参数单位为毫秒)。

analytics_plugin:setSessionContinueMillis(millis)

收集应用错误日志

收集应用的错误日志可帮助您来修正 BUG、改善产品。报表中,我们除了提供错误次数的数据外,还提供错误的详细信息阅览,并会对错误进行合理分类。SDK 自动获取异常信息为了简化开发者的工作,我们提供自动获取异常信息的功能,但考虑异常信息收集会损耗最终用户流量,因此自动捕获默认为关闭状态。可向以下方法中传入 true(开启自动捕获)或 false(关闭自动捕获),来控制自动捕获功能的开关:

analytics_plugin:setCaptureUncaughtException(true)

是否支持该函数

if analytics_plugin:isFuctionSupported("setAccount")  then
    --do setAccount
end

游戏统计相关接口

统计玩家帐户信息

定义一个玩家单元,更新玩家最新的属性信息。
在可确定玩家帐户后(注册、登录、登出操作完成时都需添加)尽早调用。
接口说明:
setAccount(paramMap)

参数 是否必传 参数说明
Account_Id Y 游戏中玩家 ID
Account_Name Y 游戏中玩家昵称
Account_Type Y 传入帐户的类型(ANONYMOUS 匿名,REGISTED 自有账号,SINA_WEIBO 新浪微博,TENCENT_WEIBO 腾讯微博,QQ,ND91)
Account_Level Y 游戏中玩家等级
Account_Age Y 玩家年龄
Account_Operate Y 账户操作(LOGIN 登陆,LOGOUT 登出,REGISTER 注册)
Account_Gender Y 游戏角色性别(UNKNOWN 未知,FEMALE 女性,MALE 男性)
Server_Id Y 服务器 ID

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("setAccount")) then
    local paramMap = {
        Account_Id = "123456",
        Account_Name = "test",
        Account_Type = string.format(AccountType.ANONYMOUS),
        Account_Level = "1",
        Account_Age = "1",
        Account_Operate = string.format(AccountOperate.LOGIN),
        Account_Gender = string.format(AccountGender.MALE),
        Server_Id = "1"
    }
    local data = PluginParam:create(paramMap);
    analytics_plugin:callFuncWithParam("setAccount", data);
end

跟踪玩家充值

跟踪玩家充值现金而获得虚拟币的行为,充入的现金将反映至游戏收入中。
充值过程分两个跟踪阶段:
1、发出有效的充值请求;
2、确认某次充值请求是否完成充值。
您可在玩家发起充值请求时(例如玩家选择了某个充值包,进入支付流程那一刻)调用 onChargeRequest,并传入该笔交易的唯一订单 ID 和详细信息; 在确认玩家支付成功时调用 onChargeSuccess,并告知完成的是哪个订单 ID; 在确认玩家支付失败时调用 onChargeFail,并告知完成的是哪个订单 ID 和失败原因。如果游戏中无法记录充值的发起,那么可以在某次充值成功后,调用 onChargeOnlySuccess 方法,来告知一次充值成功的相关信息。

接口说明:支付请求接口 [TalkingData Game专用] onChargeRequest(paramMap)

参数 是否必传 参数说明
Order_Id Y 订单唯一 ID
Product_Name Y 商品名
Currency_Amount Y 现金数额(元)
Currency_Type Y 请使用国际标准组织 ISO 4217 中规范的 3 位字母代码标记货币类型。点击查看参考例:人民币 CNY;美元 USD;欧元 EUR
Payment_Type Y 支付的途径,最多 16 个字符。例如:“支付宝”“苹果官方”“XX 支付 SDK
Virtual_Currency_Amount Y 虚拟币数值

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onChargeRequest")) then
    local paramMap = {
        Order_Id = "123456",
        Product_Name = "test",
        Currency_Amount = "2.0",
        Currency_Type = "CNY",
        Payment_Type = "渠道",
        Virtual_Currency_Amount = "100"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onChargeRequest",data)
end

接口说明:支付成功接口 [TalkingData Game专用] onChargeSuccess(orderId)
调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onChargeSuccess")) then
    local data = PluginParam:create("123456")
    analytics_plugin :callFuncWithParam("onChargeSuccess",data)
end

接口说明:支付失败接口 [TalkingData Game专用] onChargeFail(paramMap)

参数 是否必传 参数说明
Order_Id Y 订单唯一 ID
Fail_Reason Y 失败原因

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onChargeFail")) then
    local paramMap = {
        Order_Id = "123456",
        Fail_Reason = "test"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onChargeFail",data)
end

接口说明:仅统计支付成功接口 [DataEye专用] onChargeOnlySuccess(paramMap)

参数 是否必传 参数说明
Order_Id Y 订单唯一 ID
Product_Name Y 商品名
Currency_Amount Y 现金数额(元)
Currency_Type Y 请使用国际标准组织 ISO 4217 中规范的 3 位字母代码标记货币类型。点击查看参考例:人民币 CNY;美元 USD;欧元 EUR
Payment_Type Y 支付的途径,最多 16 个字符。例如:“支付宝”“苹果官方”“XX 支付 SDK
Virtual_Currency_Amount Y 虚拟币数值

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onChargeOnlySuccess")) then
    local paramMap = {
        Order_Id = "123456",
        Product_Name = "test",
        Currency_Amount = "2.0",
        Currency_Type = "1",
        Payment_Type = "1",
        Virtual_Currency_Amount = "100"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onChargeOnlySuccess",data)
end

跟踪游戏内消费

跟踪游戏中全部使用到虚拟币的消费点,如购买虚拟道具、VIP 服务、复活等;跟踪某物品或服务的耗尽;
在任意消费点发生时尽快调用 onPurchase,在某个道具/服务被用掉(消失)时尽快调用 onUse,在成功向玩家赠予虚拟币时调用 onReward 方法来传入相关数据。
消费点特指有价值的虚拟币的消费过程,如果游戏中存在普通游戏金币可购买。

接口说明:
void onPurchase(paramMap)

参数 是否必传 参数说明
Item_Id Y 物品 ID
Item_Type Y 物品类型
Item_Count Y 物品数量
Virtual_Currency Y 虚拟金额
Currency_Type Y 虚拟币类型

调用接口范例:

 if(analytics_plugin and analytics_plugin:isFunctionSupported("onPurchase")) then
    local paramMap = {
         Item_Id = "123456",
         Item_Type = "test",
         Item_Count = string.format(2),
         Virtual_Currency= "1",
         Currency_Type = "gold"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onPurchase",data)
end

接口说明:
void onUse(paramMap)

参数 是否必传 参数说明
Item_Id Y 物品 ID
Item_Type Y 物品类型
Item_Count Y 物品数量
Use_Reason Y 用途说明

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onUse")) then
    local paramMap = {
        Item_Id = "123456",
        Item_Type = "test",
        Item_Count = "2",
        Use_Reason = "1"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onUse",data)
end

接口说明:
void onReward(paramMap)

参数 是否必传 参数说明
Item_Id Y 物品 ID
Item_Type Y 物品类型
Item_Count Y 物品数量
Item_Price Y 物品价格
Use_Reason Y 用途说明

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("onReward")) then
    local paramMap = {
        Item_Id = "123456",
        Item_Type = "test",
        Item_Count = "2",
        Use_Reason = "1"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("onReward", data)
end

关卡

我们提供了一组方法来统计关卡相关的事件。 startLevelfailLevelfinishLevel 在游戏开启新的任务的时候调用 startLevel 方法,在任务失败的时候调用 failLevel 方法,在成功过关的时候调用 finishLevel 方法。其中 startLevelfailLevel/finishLevel 方法需要配对出现。

接口说明:
void startLevel(paramMap)

参数 是否必传 参数说明
Level_Id Y 关卡 ID
Seq_Num Y 关卡顺序

调用接口范例:

 if(analytics_plugin and analytics_plugin:isFunctionSupported("startLevel")) then
    local paramMap = {
        Level_Id = "123456",
        Seq_Num = "1"
    }
    local data = PluginParam:create(paramMap);
    analytics_plugin:callFuncWithParam("startLevel", data);
end

接口说明:
void finishLevel(levelID)
调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("finishLevel")) then
    local data = PluginParam:create("123456")
    analytics_plugin:callFuncWithParam("finishLevel",data)
end

接口说明:
void failLevel(paramMap)

参数 是否必传 参数说明
Level_Id Y 关卡 ID
Fail_Reason Y 失败原因

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("failLevel")) then
    local paramMap = {
        Level_Id = "123456",
        Fail_Reason = "test"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("failLevel",data)
end

任务

我们提供了一组方法来统计任务相关的事件。 startTaskfailTaskfinishTask 在游戏开启新的任务的时候调用 startTask 方法,在任务失败的时候调用 failTask 方法,在成功过关的时候调用 finishTask 方法。其中 startTaskfailTask/finishTask 方法需要配对出现。

接口说明:
void startTask(paramMap)

参数 是否必传 参数说明
Task_Id Y 任务 ID
Task_Type Y 任务类型(GUIDE_LINE 新手引导、MAIN_LINE 主线、 BRANCH_LINE 分支、 DAILY 日常、 ACTIVITY 活动、 OTHER 其他)

调用接口范例:

 if(analytics_plugin and analytics_plugin:isFunctionSupported("startTask")) then
    local paramMap  ={
        Task_Id = "123456",
        Task_Type = string.format(TaskType.GUIDE_LINE)
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("startTask",data)
end

接口说明:
void finishTask(taskID)
调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("finishTask")) then
    local data = PluginParam:create("123456")
    analytics_plugin:callFuncWithParam("finishTask",data)
end

接口说明:
void failTask(paramMap)

参数 是否必传 参数说明
Task_Id Y 任务 ID
Fail_Reason Y 失败原因

调用接口范例:

if(analytics_plugin and analytics_plugin:isFunctionSupported("failTask")) then
    local paramMap = {
        Task_Id = "123456",
        Fail_Reason = "test"
    }
    local data = PluginParam:create(paramMap)
    analytics_plugin:callFuncWithParam("failTask",data)
end

【评论区】