Classe do mecanismo
AnalyticsService
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Resumo
Métodos
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):() |
Referência API
Propriedades
ApiKey
Métodos
FireCustomEvent
FireEvent
FireInGameEconomyEvent
FireLogEvent
FirePlayerProgressionEvent
GetPlayerSegmentsAsync
Parâmetros
Devolução
Amostras de código
Configure experiências do lado do servidor com segmentos de jogadores
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("Mostre integração adicional para", player.Name)
end
if segments.ActivePayerStatus == Enum.ActivePayerStatus.Top15Percent then
print("Mostre oferta de alto valor para", player.Name)
end
end
Players.PlayerAdded:Connect(configurePlayerExperience)LogCustomEvent
AnalyticsService:LogCustomEvent(
):()
Parâmetros
| Valor Padrão: 1 |
| Valor Padrão: "nil" |
Devolução
()
Amostras de código
Registrar Evento Personalizado
local AnalyticsService = game:GetService("AnalyticsService")
-- Registre quando a missão começa
AnalyticsService:LogCustomEvent(
player,
"MissionStarted" -- Nome do evento personalizado
)
-- Registre quando a missão é concluída com o tempo que levou
AnalyticsService:LogCustomEvent(
player,
"MissionCompletedDuration", -- Nome do evento personalizado
120 -- Valor do evento usado na agregação
)LogEconomyEvent
AnalyticsService:LogEconomyEvent(
player:Player, flowType:Enum.AnalyticsEconomyFlowType, currencyType:string, amount:number, endingBalance:number, transactionType:string, itemSku:string, customFields:Dictionary
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()
Amostras de código
Rastreando uma compra no aplicativo
local AnalyticsService = game:GetService("AnalyticsService")
AnalyticsService:LogEconomyEvent(
player,
Enum.AnalyticsEconomyFlowType.Source,
"Coins",
1000, -- Quantas moedas estão no pacote
1020, -- saldo após a transação
Enum.AnalyticsEconomyTransactionType.IAP.Name,
"1000CoinBundle" -- Identificador único do pacote de moedas
)LogFunnelStepEvent
Devolução
()
Amostras de código
Etapas da Loja de Rastreamento
local AnalyticsService = game:GetService("AnalyticsService")
local HttpService = game:GetService("HttpService")
funnelSessionId = HttpService:GenerateGUID()
-- Registre quando o usuário abre a loja
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas
funnelSessionId, -- ID da sessão do funil para esta sessão de checkout única
1, -- Número da etapa
"Loja Aberta" -- Nome da etapa
)
-- Registre quando o usuário visualiza um item
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas
funnelSessionId, -- ID da sessão do funil para esta sessão de checkout única
2, -- Número da etapa
"Item Visualizado" -- Nome da etapa
)
-- Registre quando o usuário adiciona ao carrinho
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas
funnelSessionId, -- ID da sessão do funil para esta sessão de checkout única
3, -- Número da etapa
"Adicionado ao Carrinho" -- Nome da etapa
)LogOnboardingFunnelStepEvent
AnalyticsService:LogOnboardingFunnelStepEvent(
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()
Amostras de código
Rastreando etapas de apresentação
local AnalyticsService = game:GetService("AnalyticsService")
-- Registra a primeira etapa do FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
1, -- Número da etapa
"Entrou no Jogo" -- Nome da etapa
)
-- Registra a segunda etapa do FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
2, -- Número da etapa
"Escolher Classe" -- Nome da etapa
)LogProgressionCompleteEvent
AnalyticsService:LogProgressionCompleteEvent(
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()
LogProgressionEvent
AnalyticsService:LogProgressionEvent(
player:Player, progressionPathName:string, status:Enum.AnalyticsProgressionType, level:number, levelName:string, customFields:Dictionary
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()
LogProgressionFailEvent
AnalyticsService:LogProgressionFailEvent(
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()
LogProgressionStartEvent
AnalyticsService:LogProgressionStartEvent(
):()
Parâmetros
| Valor Padrão: "nil" |
Devolução
()