Créer une statistique de base

Dans ce tutoriel, nous vous montrons comment créer une statistique de base à l’aide de notre nouveau service Statistic. Commençons par un exemple de jeu de tir qui souhaite suivre chaque tir à longue distance réussi par un joueur.

Création d’une statistique

La première étape consiste à créer une définition de statistique qui comprend les principaux éléments permettant de suivre les tirs à longue distance. Pour notre jeu de tir, nous n’avons besoin que d’une colonne pour la distance du tir. L’exemple suivant montre comment créer la définition de statistique à l’aide du SDK C#.

public static async Task CreateStatisticDefinitionAsync(PlayFabAuthenticationContext context, string statName)
{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
    CreateStatisticDefinitionRequest statDefinitionRequest = new CreateStatisticDefinitionRequest()
    {
        Name = statName,
        AuthenticationContext = context,
        EntityType = "title_player_account",
        VersionConfiguration = new VersionConfiguration()
        {
            MaxQueryableVersions = 1,
            ResetInterval = ResetInterval.Manual,
        },
        Columns = new List<StatisticColumn>()
        {
            new StatisticColumn()
            {
                Name = "Distance",
                AggregationMethod = StatisticAggregationMethod.Max,
            }
        },
    };
    
    PlayFabResult<PlayFab.LeaderboardsModels.EmptyResponse> createStatDefResult = await statsAPI.CreateStatisticDefinitionAsync(statDefinitionRequest);
}

Expliquons maintenant certains éléments clés de cet exemple :

AuthenticationContext : ce paramètre gère toute l’authentification sous-jacente à chaque requête adressée à nos services. Pour une explication détaillée, vous pouvez consulter la page suivante : Démarrage rapide des statistiques.
Name : ce paramètre vous aide à identifier la définition de statistique. Il est important d’indiquer ici une valeur pertinente, car elle sera utilisée pour effectuer d’autres requêtes de récupération d’informations
EntityType : ce paramètre spécifie le type d’entité pour lequel vous souhaitez créer votre statistique. Pour en savoir plus : Modèle de programmation des entités.
VersionConfiguration : ce paramètre vous permet de définir une stratégie de gestion des versions pour les statistiques qui se réinitialisent après une certaine période. Ce concept est traité en détail ici : Statistiques saisonnières.
Columns : nous définissons ici le nombre de colonnes de notre statistique, avec un maximum de 5 par définition. Dans cet exemple, nous ne définissons qu’une seule colonne pour les tirs à longue distance. Nous définissons également AggregationMethod sur Max, ce qui signifie que la statistique ne sera mise à jour que lorsque la nouvelle valeur sera supérieure à la précédente.
- AggregationMethod peut prendre quatre valeurs :
  - Max : la nouvelle valeur doit être supérieure à la précédente.
  - Min : la nouvelle valeur doit être inférieure à la précédente.
  - Last : la statistique est toujours mise à jour avec la dernière valeur.
  - Sum : la valeur précédente et la nouvelle valeur sont additionnées.

Toutes ces informations étant claires, vous êtes prêt à exécuter l’exemple et à créer votre première statistique.

Obtention d’une définition de statistique

Avant d’ajouter des données à cette statistique, nous voulons nous assurer qu’elle a été créée correctement. Pour ce faire, nous fournissons un exemple illustrant la façon de récupérer votre définition de statistique.

public static async Task GetStatisticDefinition(PlayFabAuthenticationContext context, string statName)
{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
    GetStatisticDefinitionRequest statDefReq = new GetStatisticDefinitionRequest()
    {
        Name = statName
    };

    PlayFabResult<GetStatisticDefinitionResponse> getStatDefResult = await statsAPI.GetStatisticDefinitionAsync(statDefReq)
}

Pour récupérer la définition de statistique, spécifiez le nom de la statistique que vous avez créée. Si vous disposez de plusieurs définitions de statistiques, vous pouvez utiliser l’exemple suivant pour obtenir toutes vos définitions de statistiques en une seule requête.

public static async Task GetStatisticDefinitions(PlayFabAuthenticationContext context)
{
     PlayFabProgressionInstanceAPI leaderboardsAPI = new PlayFabProgressionInstanceAPI(context);
     ListStatisticDefinitionsRequest request = new ListStatisticDefinitionsRequest();
     PlayFabResult<ListStatisticDefinitionsResponse> getStatDefsResult = await leaderboardsAPI.ListStatisticDefinitionsAsync(request);
           
}

Mise à jour d’une définition de statistique

Si vous souhaitez mettre à jour votre définition de statistique, procédez comme suit :

public static async Task UpdateStatisticDefinitionAsync(PlayFabAuthenticationContext context, string statisticName, VersionConfiguration version)
{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
    UpdateStatisticDefinitionRequest updateStatDefinitionRequest = new UpdateStatisticDefinitionRequest()
    {
        AuthenticationContext = context,
        Name = statisticName,
        VersionConfiguration = version

    };
    PlayFabResult<PlayFab.ProgressionModels.EmptyResponse> updateStatDefinitionResult = await statsAPI.UpdateStatisticDefinitionAsync(updateStatDefinitionRequest);

}

Notez que Columns, EntityType et ResetInterval ne peuvent pas être modifiés dans le cadre de la mise à jour.

### Suppression d'une définition de statistique

Si vous souhaitez supprimer votre définition de statistique pour ajouter des colonnes ou corriger des erreurs, procédez comme suit :

 
``` C#

public static async Task DeleteStatisticDefinition(PlayFabAuthenticationContext context, string statName)
\{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
    DeleteStatisticDefinitionRequest deleteStatDefRequest = new DeleteStatisticDefinitionRequest()
    \{
        AuthenticationContext = context,
        Name = statName,
    \};
    
    PlayFabResult<PlayFab.LeaderboardsModels.EmptyResponse> statResponse = await statsAPI.DeleteStatisticDefinitionAsync(deleteStatDefRequest);    
\}

Ajout de données à une statistique

Pour poursuivre notre exemple de jeu de tir, nous savons maintenant comment créer une définition de statistique, la récupérer et la supprimer si nécessaire. L’étape suivante consiste à commencer à ajouter des données à notre statistique. N’oubliez pas qu’il s’agit de statistiques basées sur des entités, ce qui signifie que les entrées sont des entités. Dans notre exemple, nous utilisons le type d’entité title_player_account ; notre statistique suit donc les informations d’un joueur. N’oubliez toutefois pas que vous pouvez également utiliser d’autres types d’entités. Vous pouvez les consulter ici : Types d’entités intégrés disponibles. Voyons maintenant comment ajouter des données à notre statistique.

public static async Task UpdateStatisticForPlayer(PlayFabAuthenticationContext context, string statName, string entityId, int score)
\{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
    UpdateStatisticsRequest updateStatRequest = new UpdateStatisticsRequest()
    \{
        Entity = new PlayFab.LeaderboardsModels.EntityKey()
        \{
            Id = entityId,
            Type = EntityType
        \},
        AuthenticationContext = context,
        Statistics = new List<PlayFab.LeaderboardsModels.StatisticUpdate>() 
        \{
            new PlayFab.LeaderboardsModels.StatisticUpdate() 
            \{
                Name = statName,
                Scores = new List<string> \{ score.ToString()\},
            \}
        \}
    \};

    PlayFabResult<UpdateStatisticsResponse> updateResult = await statsAPI.UpdateStatisticsAsync(updateStatRequest);
\}

Expliquons maintenant certains éléments clés de cet exemple :

Entity : ce paramètre correspond à l’entité pour laquelle nous souhaitons mettre à jour la statistique.
Statistics : ce paramètre correspond à l’ensemble réel des statistiques d’une entité.
StatisticUpdate : ce paramètre correspond aux valeurs de statistiques qui vont être ajoutées.
- Scores : ce paramètre correspond à la liste des scores que vous pouvez ajouter à une entité. N’oubliez pas que les statistiques peuvent comporter plusieurs colonnes. Vous pouvez approfondir ces concepts ici : Aller plus loin avec les statistiques
- Name : ce paramètre correspond au nom de statistique défini lors de la création de la définition de statistique.

Ces concepts étant clairs, vous êtes prêt à ajouter des données à votre statistique.

Récupération des données d’une statistique

Faisons un rapide récapitulatif. À ce stade, vous avez créé une statistique, vérifié tous les détails de configuration et commencé à y ajouter des données. Imaginons maintenant que certains joueurs ont déjà commencé à jouer à votre jeu, tous avec des tirs à longue distance impressionnants. Nous voulons interroger les données de l’un d’eux. Dans l’exemple suivant, nous vous montrons comment procéder.

public static async Task GetStatsForEntity(PlayFabAuthenticationContext context, string entityId)
\{
    PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);

    GetStatisticsRequest request = new GetStatisticsRequest()
    \{
        AuthenticationContext = context,
        Entity = new PlayFab.LeaderboardsModels.EntityKey()
        \{
            Id = entityId,
            Type = EntityType
        \},
    \};
    
    PlayFabResult<GetStatisticsResponse> result = await statsAPI.GetStatisticsAsync(request);

    Console.WriteLine("Stats for entity: " + result.Result.Entity.ToString());
    foreach (KeyValuePair<string, PlayFab.LeaderboardsModels.EntityStatisticValue> statValuePair in result.Result.Statistics)
    \{
        Console.WriteLine($"\{statValuePair.Value.Name\} : \{string.Join('|', statValuePair.Value.Scores)\}");
    \}
\}

Ici, nous interrogeons toutes les statistiques associées à une entité, puis nous affichons leur nom avec la valeur correspondante.

Suppression des valeurs de statistiques

Nos statistiques fonctionnent comme prévu et de nombreux joueurs jouent à votre jeu. Toutefois, nous commençons à remarquer un comportement inhabituel dans le jeu. Nous avons donc décidé de repartir de zéro et de supprimer les données de notre statistique. L’exemple suivant montre comment supprimer les données de votre statistique.

 public static async Task DeleteStats(PlayFabAuthenticationContext context, string entityId, List<StatisticDelete> stats)
 \{
     PlayFabProgressionInstanceAPI statsAPI = new PlayFabProgressionInstanceAPI(context);
     DeleteStatisticsRequest statsDelReq = new DeleteStatisticsRequest()
     \{
         Entity = new PlayFab.LeaderboardsModels.EntityKey()
         \{
            Id = entityId,
            Type = EntityType
         \},
         Statistics = stats
     \};
 
     PlayFabResult<DeleteStatisticsResponse> delStatsResult = await statsAPI.DeleteStatisticsAsync(statsDelReq);     
 \}

Expliquons maintenant certains éléments clés de cet exemple :

Entity : ce paramètre est l’entité dont vous souhaitez supprimer les données.
List<StatisticDelete> : ce paramètre est une liste des noms des statistiques que vous souhaitez supprimer.

Conclusions

Dans ce tutoriel, nous avons appris à effectuer les opérations suivantes :

Créer une statistique
Vérifier la configuration d’une statistique
Mettre à jour la configuration d’une statistique
Supprimer la configuration d’une statistique
Alimenter la statistique
Supprimer des entrées de la statistique.

XBOX Services

PlayFab

Création d’une statistique

Obtention d’une définition de statistique

Mise à jour d’une définition de statistique

Ajout de données à une statistique

Récupération des données d’une statistique

Suppression des valeurs de statistiques

Conclusions

Voir aussi

​Création d’une statistique

​Obtention d’une définition de statistique

​Mise à jour d’une définition de statistique

​Ajout de données à une statistique

​Récupération des données d’une statistique

​Suppression des valeurs de statistiques

​Conclusions

​Voir aussi

Création d’une statistique

Obtention d’une définition de statistique

Mise à jour d’une définition de statistique

Ajout de données à une statistique

Récupération des données d’une statistique

Suppression des valeurs de statistiques

Conclusions

Voir aussi