AnalyticsService

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Serviço
Não replicado

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

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

player: Player

O usuário que disparou o evento.

Valor Padrão: ""
eventName: string

O nome do evento personalizado.

Valor Padrão: ""
value: number

O valor do evento que será usado na agregação.

Valor Padrão: 1
customFields: Dictionary

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.

Valor Padrão: "nil"

Devolução

()

Amostras de código

This example uses AnalyticsService:LogCustomEvent() to log two custom events: MissionStarted and MissionCompletedDuration.

Log Custom Event

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

player: Player

O usuário que disparou o evento.

Valor Padrão: ""

Deve especificar a direção que a moeda está fluindo usando Enum.AnalyticsEconomyFlowType .

Valor Padrão: ""
currencyType: string

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.

Valor Padrão: ""
amount: number

A quantidade de moeda que está sendo adicionada ou removida. Este valor deve sempre ser positivo.

Valor Padrão: ""
endingBalance: number

O saldo do usuário após a moeda ter sido adicionada ou removida. Este valor deve sempre ser maior ou igual a 0.

Valor Padrão: ""
transactionType: string

O tipo de transação que ocorreu.Enquanto você é livre para usar qualquer digitarde 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 / cadeia / texto, você precisará passar o valor Name da enum. Por exemplo, Enum.AnalyticsEconomyTransactionType.IAP.Name.

Limitado a 20 tipos únicos por experiência.

Valor Padrão: ""
itemSku: string

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.

Valor Padrão: ""
customFields: Dictionary

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.

Valor Padrão: "nil"

Devolução

()

Amostras de código

The following sample tracks a Robux purchase of a 1000-coin bundle, using the IAP (in-app purchase) transaction type. Note the item name provided as an optional parameter when compared to the previous sample.

Tracking an in-app purchase

local AnalyticsService = game:GetService("AnalyticsService")
AnalyticsService:LogEconomyEvent(
player,
Enum.AnalyticsEconomyFlowType.Source,
"Coins",
1000, -- How many coins are in the bundle
1020, -- balance after transaction
Enum.AnalyticsEconomyTransactionType.IAP.Name,
"1000CoinBundle" -- Unique identifier of the coin bundle
)

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

player: Player

O usuário que disparou o evento.

Valor Padrão: ""
funnelName: string

O nome do funil. Isso deve ser o mesmo para todos os passos no funil. Limitado a 10 funis únicos por experiência.

Valor Padrão: ""
funnelSessionId: string

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().

Valor Padrão: ""
step: number

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.

Valor Padrão: 1
stepName: string

Nome opcional do passo no funil. Este campo é usado apenas para fins de exibição em gráficos fornecidos pelo Roblox.

Valor Padrão: ""
customFields: Dictionary

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.

Valor Padrão: "nil"

Devolução

()

Amostras de código

The following sample tracks some basic events for each user beginning the process to buy an item from an "armory" shop. Note the funnelSessionId used to distinguish between different sessions of the same user opening the shop.

Tracking Shop steps

local AnalyticsService = game:GetService("AnalyticsService")
local HttpService = game:GetService("HttpService")
funnelSessionId = HttpService:GenerateGUID()
-- Log when the user opens the store
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Funnel name used to group steps together
funnelSessionId, -- Funnel session id for this unique checkout session
1, -- Step number
"Opened Store" -- Step name
)
-- Log when the user views an item
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Funnel name used to group steps together
funnelSessionId, -- Funnel session id for this unique checkout session
2, -- Step number
"Viewed Item" -- Step name
)
-- Log when the user views adds to cart
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Funnel name used to group steps together
funnelSessionId, -- Funnel session id for this unique checkout session
3, -- Step number
"Added to Cart" -- Step name
)

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

player: Player

O usuário que disparou o evento.

Valor Padrão: ""
step: number

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.

Valor Padrão: ""
stepName: string

Nome opcional do passo no funil. Este campo é usado apenas para fins de exibição em gráficos fornecidos pelo Roblox.

Valor Padrão: ""
customFields: Dictionary

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.

Valor Padrão: "nil"

Devolução

()

Amostras de código

The following sample demonstrates how to log two steps of an onboarding funnel. An onboarding funnel typically introduces players to the game's core loop.

Tracking onboarding steps

local AnalyticsService = game:GetService("AnalyticsService")
-- Log the first step of the FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
1, -- Step number
"Joined Game" -- Step name
)
-- Log the second step of the FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
2, -- Step number
"Choose Class" -- Step name
)

LogProgressionCompleteEvent

()

Registra um evento quando um usuário concluiu uma tentarde nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.

Parâmetros

player: Player

O jogador que disparou o evento.

Valor Padrão: ""
progressionPathName: string
Valor Padrão: ""
level: number
Valor Padrão: ""
levelName: string
Valor Padrão: ""
customFields: Dictionary
Valor Padrão: "nil"

Devolução

()

LogProgressionEvent

()

Registra um evento quando um usuário iniciou, concluiu ou falhou uma tentarde nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.

Parâmetros

player: Player

O jogador que disparou o evento.

Valor Padrão: ""
progressionPathName: string
Valor Padrão: ""
Valor Padrão: ""
level: number
Valor Padrão: ""
levelName: string
Valor Padrão: ""
customFields: Dictionary
Valor Padrão: "nil"

Devolução

()

LogProgressionFailEvent

()

Registra um evento quando um usuário falhar em uma tentarde nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.

Parâmetros

player: Player

O usuário que disparou o evento.

Valor Padrão: ""
progressionPathName: string
Valor Padrão: ""
level: number
Valor Padrão: ""
levelName: string
Valor Padrão: ""
customFields: Dictionary
Valor Padrão: "nil"

Devolução

()

LogProgressionStartEvent

()

Registra um evento quando um usuário iniciou uma tentarde nível. Este evento não é exibido atualmente em nenhum gráfico fornecido pelo Roblox.

Parâmetros

player: Player

O jogador que disparou o evento.

Valor Padrão: ""
progressionPathName: string
Valor Padrão: ""
level: number
Valor Padrão: ""
levelName: string
Valor Padrão: ""
customFields: Dictionary
Valor Padrão: "nil"

Devolução

()

Eventos