AnalyticsService
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Serviço de análise é uma coleção de métodos que permite que os desenvolvedores rastreiem como os usuários interagem com suas experiências, especificamente a progressão do jogador, a economia na experiência, funis e eventos personalizados.
Resumo
Métodos
Registra um evento usado para rastrear métricas personalizadas de um usuário na experiência.
- LogEconomyEvent(player : Player,flowType : Enum.AnalyticsEconomyFlowType,currencyType : string,amount : number,endingBalance : number,transactionType : string,itemSku : string,customFields : Dictionary):()
Registra um evento usado para rastrear ações do jogador relacionadas à experiência.
- LogFunnelStepEvent(player : Player,funnelName : string,funnelSessionId : string,step : number,stepName : string,customFields : Dictionary):()
Registra um evento usado para rastrear ações do usuário passando por um funil pré-planejado.
- LogOnboardingFunnelStepEvent(player : Player,step : number,stepName : string,customFields : Dictionary):()
Registra um evento usado para rastrear ações do usuário passando por um funil de integração.
- LogProgressionCompleteEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Registra um evento quando um usuário concluiu uma tentativa de nível.
- LogProgressionEvent(player : Player,progressionPathName : string,status : Enum.AnalyticsProgressionType,level : number,levelName : string,customFields : Dictionary):()
Registra um evento quando um usuário iniciou, concluiu ou falhou uma tentativa de nível.
- LogProgressionFailEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Registra um evento quando um usuário falhar em uma tentativa de nível.
- LogProgressionStartEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Registra um evento quando um usuário iniciou uma tentativa de nível.
Propriedades
Métodos
LogCustomEvent
Registra um evento usado para rastrear métricas personalizadas de um usuário na experiência. Para mais informações, veja Eventos personalizados.
Parâmetros
O usuário que disparou o evento.
O nome do evento personalizado.
O valor do evento que será usado na agregação.
Dicionário opcional de campos personalizados que fornecerá detalhes em gráficos fornecidos pelo Roblox.Apenas chaves específicas, fornecidas por Enum.AnalyticsCustomFieldKeys , serão usadas para esses resumos.Limitado a 8.000 combinações únicas de valores em três campos personalizados por experiência.
Devolução
Amostras de código
This example uses AnalyticsService:LogCustomEvent() to log two custom events: MissionStarted and MissionCompletedDuration.
local AnalyticsService = game:GetService("AnalyticsService")
-- Log when the mission starts
AnalyticsService:LogCustomEvent(
player,
"MissionStarted" -- Custom event name
)
-- Log when the mission is completed with the time it took
AnalyticsService:LogCustomEvent(
player,
"MissionCompletedDuration", -- Custom event name
120 -- Event value used in aggregation
)LogEconomyEvent
Registra um evento usado para rastrear ações do jogador relacionadas à experiência.
Parâmetros
O usuário que disparou o evento.
Deve especificar a direção que a moeda está fluindo usando Enum.AnalyticsEconomyFlowType .
O nome da moeda que está sendo adicionada ou removida, por exemplo "gold" , "gems" ou "energy" .Limitado a 5 tipos de moeda únicos por experiência.
A quantidade de moeda que está sendo adicionada ou removida. Este valor deve sempre ser positivo.
O saldo do usuário após a moeda ter sido adicionada ou removida. Este valor deve sempre ser maior ou igual a 0.
O tipo de transação que ocorreu.Enquanto você é livre para usar qualquer tipo de transação, é recomendado usar os tipos fornecidos de Enum.AnalyticsEconomyTransactionType como "IAP" ou "ContextualPurchase" para habilitar futuras análises de ferramentas e gráficos do Roblox.
Como este tipo de campo é uma string, você precisará passar o valor Name da enum. Por exemplo, Enum.AnalyticsEconomyTransactionType.IAP.Name.
Limitado a 20 tipos únicos por experiência.
SKU opcional do item ou pacote que está sendo comprado.Este é um identificador exclusivo do item que está sendo comprado.Limitado a 100 SKUs únicos por experiência.
Dicionário opcional de campos personalizados que fornecerá detalhes em gráficos fornecidos pelo Roblox.Apenas chaves específicas, fornecidas por Enum.AnalyticsCustomFieldKeys , serão usadas para esses resumos.Limitado a 8.000 combinações únicas de valores em três campos personalizados por experiência.
Devolução
Amostras de código
A seguinte amostra rastreia uma compra de Robux de um pacote de 1000 moedas, usando o tipo de transação IAP (compra dentro do aplicativo).Observe o nome do item fornecido como um parâmetro opcional em comparação com a amostra anterior.
local AnalyticsService = game:GetService("AnalyticsService")
AnalyticsService:LogEconomyEvent(
player,
Enum.AnalyticsEconomyFlowType.Source,
"Coins",
1000, -- Quantas moedas estão no pacote
1020, -- balanceamento após a transação
Enum.AnalyticsEconomyTransactionType.IAP.Name,
"1000CoinBundle" -- Identificador exclusivo do pacote de moedas
)LogFunnelStepEvent
Registra um evento usado para rastrear ações do usuário passando por um funil pré-planejado.Os resumos de funil só considerarão os valores do usuário e do evento do primeiro passo em uma sessão de funil.
Parâmetros
O usuário que disparou o evento.
O nome do funil. Isso deve ser o mesmo para todos os passos no funil. Limitado a 10 funis únicos por experiência.
Identificador exclusivo opcional para a sessão do funil. Isso deve ser o mesmo para todos os passos no funil.
Observe que este campo é necessário apenas para funis recorrentes , por exemplo, um funil de fluxo de compra ou um funil de atualização de item.Se você não tiver um identificador de sessão de funil natural, é recomendado usar HttpService:GenerateGUID().
O número do passo no funil. Este deve ser único para cada passo no funil. Todos os funis começam no passo 1. Limitado aos passos 1-100.
Passos repetidos pelo mesmo usuário na mesma sessão de funil, ou quando funnelSessionId é nil será ignorado.
Observe que, se algum passo for omitido, os passos intermediários serão considerados concluídos.
Nome opcional do passo no funil. Este campo é usado apenas para fins de exibição em gráficos fornecidos pelo Roblox.
Dicionário opcional de campos personalizados que fornecerá detalhes em gráficos fornecidos pelo Roblox.Apenas chaves específicas, fornecidas por Enum.AnalyticsCustomFieldKeys , serão usadas para esses resumos.Limitado a 8.000 combinações únicas de valores em três campos personalizados por experiência.
Devolução
Amostras de código
A seguinte amostra rastreia alguns eventos básicos para cada usuário que inicia o processo de comprar um item de uma loja de "armas".Observe o funnelSessionId usado para distinguir entre diferentes sessões do mesmo usuário que abrem a loja.
local AnalyticsService = game:GetService("AnalyticsService")
local HttpService = game:GetService("HttpService")
funnelSessionId = HttpService:GenerateGUID()
-- Registrar quando o usuário abre a loja
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas juntas
funnelSessionId, -- ID de sessão de funil para esta sessão de checkout única
1, -- Número de passo
"Opened Store" -- Nome do passo
)
-- Registrar quando o usuário vê um item
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas juntas
funnelSessionId, -- ID de sessão de funil para esta sessão de checkout única
2, -- Número de passo
"Viewed Item" -- Nome do passo
)
-- Registre quando o usuário visualiza adiciona ao carrinho
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nome do funil usado para agrupar etapas juntas
funnelSessionId, -- ID de sessão de funil para esta sessão de checkout única
3, -- Número de passo
"Added to Cart" -- Nome do passo
)LogOnboardingFunnelStepEvent
Registra um evento usado para rastrear ações do usuário passando por um funil de integração.Os resumos de funil só considerarão os valores do usuário e do evento do primeiro passo em uma sessão de funil.
Parâmetros
O usuário que disparou o evento.
O número do passo no funil. Este deve ser único para cada passo no funil. Todos os funis começam no passo 1. Limitado aos passos 1-100.
Observe que, se algum passo for omitido, os passos intermediários serão considerados concluídos.
Nome opcional do passo no funil. Este campo é usado apenas para fins de exibição em gráficos fornecidos pelo Roblox.
Dicionário opcional de campos personalizados que fornecerá detalhes em gráficos fornecidos pelo Roblox.Apenas chaves específicas, fornecidas por Enum.AnalyticsCustomFieldKeys , serão usadas para esses resumos.Limitado a 8.000 combinações únicas de valores em três campos personalizados por experiência.
Devolução
Amostras de código
O seguinte exemplo mostra como registrar dois passos de um funil de integração.Um funil de integração geralmente apresenta os jogadores ao loop principal do jogo.
local AnalyticsService = game:GetService("AnalyticsService")
-- Registre o primeiro passo do FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
1, -- Número de passo
"Joined Game" -- Nome do passo
)
-- Registre o segundo passo do FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
2, -- Número de passo
"Choose Class" -- Nome do passo
)LogProgressionCompleteEvent
Registra um evento quando um usuário concluiu uma tentativa de nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.
Parâmetros
O jogador que disparou o evento.
Devolução
LogProgressionEvent
Registra um evento quando um usuário iniciou, concluiu ou falhou uma tentativa de nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.
Parâmetros
O jogador que disparou o evento.
Devolução
LogProgressionFailEvent
Registra um evento quando um usuário falhar em uma tentativa de nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.
Parâmetros
O usuário que disparou o evento.
Devolução
LogProgressionStartEvent
Registra um evento quando um usuário iniciou uma tentativa de nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.
Parâmetros
O jogador que disparou o evento.