AnalyticsService

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Création impossible
Service
Non répliqué

AnalyticsService est une collection de méthodes qui permet aux développeurs de suivre la façon dont les utilisateurs interagissent avec leurs expériences, notamment la progression des joueurs, l'économie en expérience, les conduits et les événements personnalisés.

Résumé

Méthodes

Propriétés

Méthodes

LogCustomEvent

()

Enregistre un événement utilisé pour suivre les métriques personnalisées d'un utilisateur dans l'expérience. Pour plus d'informations, voir événements personnalisés.

Paramètres

player: Player

L'utilisateur qui a déclenché l'événement.

Valeur par défaut : ""
eventName: string

Le nom de l'événement personnalisé.

Valeur par défaut : ""
value: number

La valeur de l'événement qui sera utilisé dans l'agrégation.

Valeur par défaut : 1
customFields: Dictionary

Dictionnaire facultatif de champs personnalisés qui fournira des décompositions dans les tableaux fournis par Roblox.Seules les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions.Limité à 8 000 combinaisons uniques de valeurs dans les trois champs personnalisés par expérience.

Valeur par défaut : "nil"

Retours

()

Échantillons de code

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

()

Enregistre un événement utilisé pour suivre les actions du joueur liées à l'expérience.

Paramètres

player: Player

L'utilisateur qui a déclenché l'événement.

Valeur par défaut : ""

Doit spécifier la direction dans laquelle la devise circule en utilisant Enum.AnalyticsEconomyFlowType .

Valeur par défaut : ""
currencyType: string

Le nom de la devise ajoutée ou supprimée, par exemple "gold" , "gems" ou "energy" .Limité à 5 types de devise uniques par expérience.

Valeur par défaut : ""
amount: number

Quantité de devise ajoutée ou supprimée. Cette valeur doit toujours être positive.

Valeur par défaut : ""
endingBalance: number

L'équilibre de l'utilisateur après l'ajout ou la suppression de la devise. Cette valeur doit toujours être supérieure ou égale à 0.

Valeur par défaut : ""
transactionType: string

Le type de transaction qui s'est produite.Bien que vous soyez libre d'utiliser n'importe quel taperde transaction, il est recommandé d'utiliser les types fournis à partir de Enum.AnalyticsEconomyTransactionType tels que "IAP" ou "ContextualPurchase" pour activer les futures analyses des outils et des tableaux Roblox.

Comme ce type de champ est une chaîne, vous devrez passer la valeur Name de l'enum. Par exemple Enum.AnalyticsEconomyTransactionType.IAP.Name.

Limité à 20 types uniques par expérience.

Valeur par défaut : ""
itemSku: string

SKU facultatif de l'article ou du pack acheté.Il s'agit d'un identifiant unique pour l'élément acheté.Limité à 100 SKUs uniques par expérience.

Valeur par défaut : ""
customFields: Dictionary

Dictionnaire facultatif de champs personnalisés qui fournira des décompositions dans les tableaux fournis par Roblox.Seules les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions.Limité à 8 000 combinaisons uniques de valeurs dans les trois champs personnalisés par expérience.

Valeur par défaut : "nil"

Retours

()

Échantillons de code

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

()

Enregistre un événement utilisé pour suivre les actions de l'utilisateur en passant à travers un entonnoir prémâché.Les écarts de funnel ne prendront en compte que les valeurs utilisateur et événement du premier pas dans une session de funnel.

Paramètres

player: Player

L'utilisateur qui a déclenché l'événement.

Valeur par défaut : ""
funnelName: string

Le nom du funnel. Cela devrait être le même pour toutes les étapes du funnel. Limité à 10 funnels uniques par expérience.

Valeur par défaut : ""
funnelSessionId: string

Identifiant unique facultatif pour la session du tunnel. Cela devrait être le même pour toutes les étapes du tunnel.

Remarquez que ce champ n'est nécessaire que pour les récurrents tuyaux, par exemple un tuyau de flux d'achat ou un tuyau de mise à niveau d'objets.Si vous n'avez pas d'identifiant de session de conduit naturel, il est recommandé d'utiliser HttpService:GenerateGUID() .

Valeur par défaut : ""
step: number

Le numéro d'étape dans le funnel. Cela devrait être unique pour chaque étape dans le funnel. Tous les funnels commencent à l'étape 1. Limité à 1-100 étapes.

Les étapes répétées par le même utilisateur dans la même session de funnel, ou lorsque funnelSessionId est ignoré, nil sera ignoré.

Notez que si des étapes sont omises, les étapes intermédiaires seront considérées comme terminées.

Valeur par défaut : 1
stepName: string

Nom facultatif de l'étape dans le funnel. Ce champ n'est utilisé que pour des fins d'affichage dans les tableaux fournis par Roblox.

Valeur par défaut : ""
customFields: Dictionary

Dictionnaire facultatif de champs personnalisés qui fournira des décompositions dans les tableaux fournis par Roblox.Seules les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions.Limité à 8 000 combinaisons uniques de valeurs dans les trois champs personnalisés par expérience.

Valeur par défaut : "nil"

Retours

()

Échantillons de code

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

()

Enregistre un événement utilisé pour suivre les actions de l'utilisateur en passant à travers un tunnel d'embarquement.Les écarts de funnel ne prendront en compte que les valeurs utilisateur et événement du premier pas dans une session de funnel.

Paramètres

player: Player

L'utilisateur qui a déclenché l'événement.

Valeur par défaut : ""
step: number

Le numéro d'étape dans le funnel. Cela devrait être unique pour chaque étape dans le funnel. Tous les funnels commencent à l'étape 1. Limité à 1-100 étapes.

Notez que si des étapes sont omises, les étapes intermédiaires seront considérées comme terminées.

Valeur par défaut : ""
stepName: string

Nom facultatif de l'étape dans le funnel. Ce champ n'est utilisé que pour des fins d'affichage dans les tableaux fournis par Roblox.

Valeur par défaut : ""
customFields: Dictionary

Dictionnaire facultatif de champs personnalisés qui fournira des décompositions dans les tableaux fournis par Roblox.Seules les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions.Limité à 8 000 combinaisons uniques de valeurs dans les trois champs personnalisés par expérience.

Valeur par défaut : "nil"

Retours

()

Échantillons de code

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

()

Enregistre un événement lorsqu'un utilisateur a terminé une tentative de niveau. Cet événement ne s'affiche actuellement dans aucun tableau fourni par Roblox.

Paramètres

player: Player

Le joueur qui a déclenché l'événement.

Valeur par défaut : ""
progressionPathName: string
Valeur par défaut : ""
level: number
Valeur par défaut : ""
levelName: string
Valeur par défaut : ""
customFields: Dictionary
Valeur par défaut : "nil"

Retours

()

LogProgressionEvent

()

Enregistre un événement lorsqu'un utilisateur a commencé, terminé ou échoué une tentative de niveau. Cet événement ne s'affiche actuellement dans aucun tableau fourni par Roblox.

Paramètres

player: Player

Le joueur qui a déclenché l'événement.

Valeur par défaut : ""
progressionPathName: string
Valeur par défaut : ""
Valeur par défaut : ""
level: number
Valeur par défaut : ""
levelName: string
Valeur par défaut : ""
customFields: Dictionary
Valeur par défaut : "nil"

Retours

()

LogProgressionFailEvent

()

Enregistre un événement lorsqu'un utilisateur a échoué à un niveau de tentative. Cet événement ne s'affiche actuellement dans aucun tableau fourni par Roblox.

Paramètres

player: Player

L'utilisateur qui a déclenché l'événement.

Valeur par défaut : ""
progressionPathName: string
Valeur par défaut : ""
level: number
Valeur par défaut : ""
levelName: string
Valeur par défaut : ""
customFields: Dictionary
Valeur par défaut : "nil"

Retours

()

LogProgressionStartEvent

()

Enregistre un événement lorsqu'un utilisateur a commencé une tentative de niveau. Cet événement ne s'affiche actuellement dans aucun tableau fourni par Roblox.

Paramètres

player: Player

Le joueur qui a déclenché l'événement.

Valeur par défaut : ""
progressionPathName: string
Valeur par défaut : ""
level: number
Valeur par défaut : ""
levelName: string
Valeur par défaut : ""
customFields: Dictionary
Valeur par défaut : "nil"

Retours

()

Évènements