概要
方法
FireCustomEvent(player: Instance,eventCategory: string,customData: Variant):() |
FireInGameEconomyEvent(player: Instance,itemName: string,economyAction: Enum.AnalyticsEconomyAction,itemCategory: string,amount: number,currency: string,location: Variant,customData: Variant):() |
FireLogEvent(player: Instance,logLevel: Enum.AnalyticsLogLevel,message: string,debugInfo: Variant,customData: Variant):() |
FirePlayerProgressionEvent(player: Instance,category: string,progressionStatus: Enum.AnalyticsProgressionStatus,location: Variant,statistics: Variant,customData: Variant):() |
GetPlayerSegmentsAsync(player: Player):Dictionary |
LogCustomEvent(player: Player,eventName: string,value: number,customFields: Dictionary):() |
LogEconomyEvent(player: Player,flowType: Enum.AnalyticsEconomyFlowType,currencyType: string,amount: number,endingBalance: number,transactionType: string,itemSku: string,customFields: Dictionary):() |
LogFunnelStepEvent(player: Player,funnelName: string,funnelSessionId: string,step: number,stepName: string,customFields: Dictionary):() |
LogOnboardingFunnelStepEvent(player: Player,step: number,stepName: string,customFields: Dictionary):() |
LogProgressionCompleteEvent(player: Player,progressionPathName: string,level: number,levelName: string,customFields: Dictionary):() |
LogProgressionEvent(player: Player,progressionPathName: string,status: Enum.AnalyticsProgressionType,level: number,levelName: string,customFields: Dictionary):() |
LogProgressionFailEvent(player: Player,progressionPathName: string,level: number,levelName: string,customFields: Dictionary):() |
LogProgressionStartEvent(player: Player,progressionPathName: string,level: number,levelName: string,customFields: Dictionary):() |
API 参考
属性
ApiKey
方法
FireCustomEvent
FireEvent
FireInGameEconomyEvent
FireLogEvent
FirePlayerProgressionEvent
GetPlayerSegmentsAsync
参数
代码示例
通过玩家分段配置服务器端体验
local Players = game:GetService("Players")
local AnalyticsService = game:GetService("AnalyticsService")
local function configurePlayerExperience(player)
local segments = AnalyticsService:GetPlayerSegmentsAsync(player)
if not segments.HasData then
return
end
if segments.WhenUserFirstPlayed == Enum.WhenUserFirstPlayed.Days0To30 then
print("为", player.Name, "显示额外的入职内容")
end
if segments.ActivePayerStatus == Enum.ActivePayerStatus.Top15Percent then
print("向", player.Name, "显示高价值优惠")
end
end
Players.PlayerAdded:Connect(configurePlayerExperience)LogCustomEvent
AnalyticsService:LogCustomEvent(
):()
参数
| 默认值：1 |
| 默认值："nil" |
返回
()
代码示例
日志自定义事件
local AnalyticsService = game:GetService("AnalyticsService")
-- 记录任务开始时
AnalyticsService:LogCustomEvent(
player,
"MissionStarted" -- 自定义事件名称
)
-- 记录任务完成时以及耗时
AnalyticsService:LogCustomEvent(
player,
"MissionCompletedDuration", -- 自定义事件名称
120 -- 聚合中使用的事件值
)LogEconomyEvent
AnalyticsService:LogEconomyEvent(
player:Player, flowType:Enum.AnalyticsEconomyFlowType, currencyType:string, amount:number, endingBalance:number, transactionType:string, itemSku:string, customFields:Dictionary
):()
参数
| 默认值："nil" |
返回
()
代码示例
跟踪应用内购买
local AnalyticsService = game:GetService("AnalyticsService")
AnalyticsService:LogEconomyEvent(
player,
Enum.AnalyticsEconomyFlowType.Source,
"Coins",
1000, -- 捆绑包中有多少金币
1020, -- 交易后的余额
Enum.AnalyticsEconomyTransactionType.IAP.Name,
"1000CoinBundle" -- 金币捆绑包的唯一标识符
)LogFunnelStepEvent
返回
()
代码示例
跟踪商店步骤
local AnalyticsService = game:GetService("AnalyticsService")
local HttpService = game:GetService("HttpService")
funnelSessionId = HttpService:GenerateGUID()
-- 记录用户打开商店的时间
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- 用于将步骤分组的漏斗名称
funnelSessionId, -- 此唯一结帐会话的漏斗会话 ID
1, -- 步骤编号
"打开商店" -- 步骤名称
)
-- 记录用户查看物品的时间
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- 用于将步骤分组的漏斗名称
funnelSessionId, -- 此唯一结帐会话的漏斗会话 ID
2, -- 步骤编号
"查看物品" -- 步骤名称
)
-- 记录用户将物品添加到购物车的时间
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- 用于将步骤分组的漏斗名称
funnelSessionId, -- 此唯一结帐会话的漏斗会话 ID
3, -- 步骤编号
"添加到购物车" -- 步骤名称
)LogOnboardingFunnelStepEvent
AnalyticsService:LogOnboardingFunnelStepEvent(
):()
参数
| 默认值："nil" |
返回
()
代码示例
跟踪入门步骤
local AnalyticsService = game:GetService("AnalyticsService")
-- 记录FTUE的第一步
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
1, -- 步骤编号
"加入游戏" -- 步骤名称
)
-- 记录FTUE的第二步
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
2, -- 步骤编号
"选择职业" -- 步骤名称
)LogProgressionCompleteEvent
AnalyticsService:LogProgressionCompleteEvent(
):()
参数
| 默认值："nil" |
返回
()
LogProgressionEvent
AnalyticsService:LogProgressionEvent(
player:Player, progressionPathName:string, status:Enum.AnalyticsProgressionType, level:number, levelName:string, customFields:Dictionary
):()
参数
| 默认值："nil" |
返回
()
LogProgressionFailEvent
AnalyticsService:LogProgressionFailEvent(
):()
参数
| 默认值："nil" |
返回
()
LogProgressionStartEvent
AnalyticsService:LogProgressionStartEvent(
):()
参数
| 默认值："nil" |
返回
()