AnalyticsService
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
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
Journalise un événement utilisé pour suivre les métriques personnalisées d'un utilisateur dans l'expérience.
- LogEconomyEvent(player : Player,flowType : Enum.AnalyticsEconomyFlowType,currencyType : string,amount : number,endingBalance : number,transactionType : string,itemSku : string,customFields : Dictionary):()
Enregistre un événement utilisé pour suivre les actions du joueur liées à l'expérience.
- LogFunnelStepEvent(player : Player,funnelName : string,funnelSessionId : string,step : number,stepName : string,customFields : Dictionary):()
Enregistre un événement utilisé pour suivre les actions de l'utilisateur en passant à travers un entonnoir prémâché.
- LogOnboardingFunnelStepEvent(player : Player,step : number,stepName : string,customFields : Dictionary):()
Enregistre un événement utilisé pour suivre les actions de l'utilisateur en passant à travers un tunnel d'embarquement.
- LogProgressionCompleteEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Enregistre un événement lorsqu'un utilisateur a terminé une tentative de niveau.
- LogProgressionEvent(player : Player,progressionPathName : string,status : Enum.AnalyticsProgressionType,level : number,levelName : string,customFields : Dictionary):()
Enregistre un événement lorsqu'un utilisateur a commencé, terminé ou échoué une tentative de niveau.
- LogProgressionFailEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Enregistre un événement lorsqu'un utilisateur a échoué à un niveau d'essai.
- LogProgressionStartEvent(player : Player,progressionPathName : string,level : number,levelName : string,customFields : Dictionary):()
Enregistre un événement lorsqu'un utilisateur a commencé une tentative de niveau.
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
L'utilisateur qui a déclenché l'événement.
Le nom de l'événement personnalisé.
La valeur de l'événement qui sera utilisé dans l'agrégation.
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.
Retours
Échantillons de code
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
Enregistre un événement utilisé pour suivre les actions du joueur liées à l'expérience.
Paramètres
L'utilisateur qui a déclenché l'événement.
Doit spécifier la direction dans laquelle la devise circule en utilisant Enum.AnalyticsEconomyFlowType .
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.
Quantité de devise ajoutée ou supprimée. Cette valeur doit toujours être positive.
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.
Le type de transaction qui s'est produite.Bien que vous soyez libre d'utiliser n'importe quel type de 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.
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.
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.
Retours
Échantillons de code
L'exemple suivant suit l'achat d'un paquet de 1000 pièces en Robux, en utilisant le type de transaction IAP (achat dans l'application).Remarquez le nom de l'élément fourni en tant que paramètre facultatif par rapport à l'échantillon précédent.
local AnalyticsService = game:GetService("AnalyticsService")
AnalyticsService:LogEconomyEvent(
player,
Enum.AnalyticsEconomyFlowType.Source,
"Coins",
1000, -- Combien de pièces sont dans le paquet
1020, -- équilibre après la transaction
Enum.AnalyticsEconomyTransactionType.IAP.Name,
"1000CoinBundle" -- Identifiant unique du paquet de pièces
)
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
L'utilisateur qui a déclenché l'événement.
Le nom du funnel. Cela devrait être le même pour toutes les étapes du funnel. Limité à 10 funnels uniques par expérience.
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() .
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.
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.
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.
Retours
Échantillons de code
L'échantillon suivant suit quelques événements de base pour chaque utilisateur débutant le processus d'achat d'un article dans une boutique d'armurerie.Notez l'ID de session funnel utilisé pour distinguer les différentes sessions d'un même utilisateur ouvrant la boutique.
local AnalyticsService = game:GetService("AnalyticsService")
local HttpService = game:GetService("HttpService")
funnelSessionId = HttpService:GenerateGUID()
-- Journaliser lorsque l'utilisateur ouvre la boutique
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nom du tunnel utilisé pour regrouper les étapes ensemble
funnelSessionId, -- ID de session de tunnel pour cette session de paiement unique
1, -- Numéro d'étape
"Opened Store" -- Nom de la étape
)
-- Enregistrer lorsque l'utilisateur affiche un élément
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nom du tunnel utilisé pour regrouper les étapes ensemble
funnelSessionId, -- ID de session de tunnel pour cette session de paiement unique
2, -- Numéro d'étape
"Viewed Item" -- Nom de la étape
)
-- Enregistrer lorsque l'utilisateur ajoute des articles au panier
AnalyticsService:LogFunnelStepEvent(
player,
"ArmoryCheckout", -- Nom du tunnel utilisé pour regrouper les étapes ensemble
funnelSessionId, -- ID de session de tunnel pour cette session de paiement unique
3, -- Numéro d'étape
"Added to Cart" -- Nom de la étape
)
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
L'utilisateur qui a déclenché l'événement.
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.
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.
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.
Retours
Échantillons de code
L'exemple suivant montre comment enregistrer deux étapes d'un funnel d'embarquement.Un tunnel d'embarquement introduit généralement les joueurs dans la boucle principale du jeu.
local AnalyticsService = game:GetService("AnalyticsService")
-- Enregistrer la première étape du FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
1, -- Numéro d'étape
"Joined Game" -- Nom de la étape
)
-- Enregistrer la deuxième étape du FTUE
AnalyticsService:LogOnboardingFunnelStepEvent(
player,
2, -- Numéro d'étape
"Choose Class" -- Nom de la étape
)
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
Le joueur qui a déclenché l'événement.
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
Le joueur qui a déclenché l'événement.
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
L'utilisateur qui a déclenché l'événement.
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
Le joueur qui a déclenché l'événement.