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 comment les utilisateurs interagissent avec leurs expériences, soit la progression des joueurs, l'économie d'expérience, les funnels et les événements personnalisés.

Résumé

Méthodes

Propriétés

Méthodes

LogCustomEvent

void

Enregistre un événement utilisé pour suivre les mesures 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.

eventName: string

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

value: number

La valeur de l'événement qui sera utilisée 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. Seuls les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions. Limité à 8 000 combinaisons de valeurs par expérience.

Valeur par défaut : "nil"

Retours

void

Échantillons de code

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

void

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.

Spécifiez la direction dans laquelle la monnaie coule en utilisant Enum.AnalyticsEconomyFlowType.

currencyType: string

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

amount: number

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

endingBalance: number

Le solde de l'utilisateur après avoir ajouté ou supprimé la monnaie. Cette valeur doit toujours être supérieure ou égale à 0.

transactionType: string

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

Puisque 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.

itemSku: string

Objet ou pack d'objets acheté. Il s'agit d'un identifiant unique pour l'objet acheté. Limité à 100 identifiants 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. Seuls les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions. Limité à 8 000 combinaisons de valeurs par expérience.

Valeur par défaut : "nil"

Retours

void

Échantillons de code

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

void

Enregistre un événement utilisé pour suivre les actions de l'utilisateur qui passe à travers un pré-planned funnel. Les décomptes des événements ne prendront en compte que les valeurs de l'utilisateur et de l'événement de la première étape dans une session de funnel.

Paramètres

player: Player

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

funnelName: string

Le nom du conduit. Ceci devrait être la même chose pour tous les étapes dans le conduit. Limité à 10 conduits uniques par expérience.

funnelSessionId: string

Identifiant unique facultatif pour la session du funnel. Ceci devrait être la même chose pour tous les étapes dans le funnel.

Notez que ce champ n'est nécessaire que pour les fonctions récurrentes , par exemple un flux de travail de vente ou un item upgrade funnel. Si vous n'avez pas d'identifiant de session de funnel naturel, il est recommandé d'utiliser HttpService:GenerateGUID().

Valeur par défaut : ""
step: number

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

Les mêmes étapes par le même utilisateur dans la même session de funnel, ou quand funnelSessionId est nil seront ignorées.

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

Valeur par défaut : 1
stepName: string

Nom facultatif de la étape dans le funnel. Ce champ est seulement utilisé à des fins d'affichage dans les chiffres 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. Seuls les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions. Limité à 8 000 combinaisons de valeurs par expérience.

Valeur par défaut : "nil"

Retours

void

Échantillons de code

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

void

Enregistre un événement utilisé pour suivre les actions de l'utilisateur à travers un funnel d'onboarding. Les décomptes des funnel downgrades ne prendront en compte que les valeurs de l'utilisateur et de l'événement à partir de la première étape dans une session de funnel.

Paramètres

player: Player

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

step: number

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

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

stepName: string

Nom facultatif de la étape dans le funnel. Ce champ est seulement utilisé à des fins d'affichage dans les chiffres 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. Seuls les clés spécifiques, fournies par Enum.AnalyticsCustomFieldKeys, seront utilisées pour ces décompositions. Limité à 8 000 combinaisons de valeurs par expérience.

Valeur par défaut : "nil"

Retours

void

Échantillons de code

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

void

Enregistre un événement pour lorsqu'un utilisateur a terminé une tentative de niveau. Cet événement n'est pas actuellement affiché dans aucun tableau fourni par Roblox.

Paramètres

player: Player

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

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

Retours

void

LogProgressionEvent

void

Enregistre un événement pour quand un utilisateur a commencé, terminé ou échoué une tentative de niveau. Cet événement n'est pas actuellement affiché dans aucun tableau fourni par Roblox.

Paramètres

player: Player

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

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

Retours

void

LogProgressionFailEvent

void

Enregistre un événement pour quand un utilisateur a échoué une tentative de niveau. Cet événement n'est pas actuellement affiché dans aucun tableau fourni par Roblox.

Paramètres

player: Player

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

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

Retours

void

LogProgressionStartEvent

void

Enregistre un événement pour quand un utilisateur a commencé une tentative de niveau. Cet événement n'est pas actuellement affiché dans aucun tableau fourni par Roblox.

Paramètres

player: Player

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

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

Retours

void

Évènements