Description des API du compteur Profile Reads

​

API Admin

• CheckLimitedEditionItemAvailability Vérifie le nombre global de l’objet en édition limitée.
• GetAllSegments Récupère un tableau de définitions de segments de joueurs. Les résultats peuvent être utilisés dans des appels d’API ultérieurs tels que GetPlayersInSegment, qui nécessite un ID de segment. Bien que les noms de segments puissent changer, l’ID de ce segment ne change pas.
• ExportMasterPlayerData Exporte toutes les données associées d’un compte de joueur principal.
• GetCatalogItems Récupère la version spécifiée du catalogue de biens virtuels du titre, y compris toutes les propriétés définies.
• GetContentList Répertorie tout le contenu du titre et obtient des statistiques telles que la taille.
• GetDataReport Récupère une URL de téléchargement pour le rapport demandé.
• GetPlayerSegments Répertorie tous les segments auxquels un joueur appartient actuellement à ce moment précis.
• GetPlayerTags Obtient toutes les balises ayant un Namespace donné (facultatif) à partir d’un profil de joueur.
• GetPolicy Obtient la stratégie demandée.
• GetPublisherData Récupère le magasin clé-valeur des paramètres d’éditeur personnalisés.
• GetRandomResultTables Récupère la configuration de la table de butin aléatoire pour le titre.
• GetStoreItems Récupère l’ensemble des objets définis pour la boutique spécifiée, y compris tous les prix définis.
• GetTitleData Récupère le magasin clé-valeur des paramètres de titre personnalisés pouvant être lus par le client.
• [GetUserAccountInfo](Récupère les détails pertinents d’un utilisateur spécifié, sur la base d’une correspondance avec un identifiant unique fourni) Récupère les détails pertinents d’un utilisateur spécifié, sur la base d’une correspondance avec un identifiant unique fourni.
• GetUserBans Obtient tous les bannissements d’un utilisateur.
• GetUserData Récupère les données personnalisées propres au titre pour l’utilisateur, lisibles et modifiables par le client.
• GetUserInternalData Récupère les données personnalisées propres au titre pour l’utilisateur, auxquelles le client ne peut pas accéder.
• GetUserInventory Récupère l’inventaire actuel de biens virtuels de l’utilisateur spécifié
• GetUserPublisherData Récupère les données personnalisées propres à l’éditeur pour l’utilisateur, lisibles et modifiables par le client.
• GetUserPublisherInternalData Récupère les données personnalisées propres à l’éditeur pour l’utilisateur, auxquelles le client ne peut pas accéder.
• GetUserPublisherReadOnlyData Récupère les données personnalisées propres à l’éditeur pour l’utilisateur, qui ne peuvent être que lues par le client.
• GetUserReadOnlyData Récupère les données personnalisées propres au titre pour l’utilisateur, qui ne peuvent être que lues par le client.
• ListVirtualCurrencyTypes Renvoie la liste de toutes les monnaies virtuelles définies pour le titre
• GetPlayerIdFromAuthToken Obtient l’ID d’un joueur à partir d’un jeton d’authentification.
• GetPlayersInSegment Permet de parcourir page par page tous les joueurs d’un segment donné. Cette API crée un instantané de tous les profils de joueurs correspondant à la définition du segment au moment de sa création ; cet instantané subsiste pendant la durée Total Seconds to Live, sa durée de vie étant renouvelée à chaque utilisation ultérieure du jeton de continuation. Les profils qui changent pendant la pagination ne seront pas reflétés dans les résultats. Les segments de test A/B ne sont actuellement pas pris en charge par cette opération.
• GetExperiments Obtient les détails de toutes les expériences d’un titre.
• GetLatestScorecard Obtient la dernière fiche de performance de l’expérience pour le titre.
• GetTreatmentAssignment Obtient les attributions de traitement d’un joueur pour chaque expérience en cours dans le titre

​

API Client

• GetAllUsersCharacters Répertorie tous les personnages appartenant à un utilisateur spécifique. Les CharacterIds ne sont pas uniques au niveau global ; le characterId doit être évalué avec le PlayFabId parent pour garantir l’unicité.
• GetCatalogItems Récupère la version spécifiée du catalogue de biens virtuels du titre, y compris toutes les propriétés définies.
• GetCharacterData Récupère les données personnalisées propres au titre pour le personnage, lisibles et modifiables par le client.
• GetCharacterInventory Récupère l’inventaire actuel de biens virtuels du personnage spécifié.
• GetCharacterLeaderboard Récupère une liste de personnages classés pour la statistique donnée, à partir du point indiqué dans le classement.
• GetCharacterReadOnlyData Récupère les données personnalisées propres au titre pour le personnage, qui ne peuvent être que lues par le client.
• GetCharacterStatistics Récupère les détails de toutes les statistiques propres au titre pour l’utilisateur.
• GetFriendLeaderboard Récupère une liste classée des amis du joueur actuel pour la statistique donnée, à partir du point indiqué dans le classement.
• GetFriendLeaderboardAroundPlayer Récupère une liste classée des amis du joueur actuel pour la statistique donnée, centrée sur l’utilisateur PlayFab demandé. Si PlayFabId est vide ou null, l’utilisateur actuellement connecté est renvoyé.
• GetFriendsList Récupère la liste d’amis actuelle de l’utilisateur local, limitée aux utilisateurs disposant d’un compte PlayFab. Les amis provenant de comptes liés (Facebook, Steam) sont également inclus. Vous pouvez éventuellement exclure les amis de certains services liés.
• GetLeaderboard Récupère une liste d’utilisateurs classés pour la statistique donnée, à partir du point indiqué dans le classement.
• GetLeaderboardAroundCharacter Récupère une liste de personnages classés pour la statistique donnée, centrée sur l’ID de personnage demandé.
• GetLeaderboardAroundPlayer Récupère une liste d’utilisateurs classés pour la statistique donnée, centrée sur le joueur demandé. Si PlayFabId est vide ou null, l’utilisateur actuellement connecté est renvoyé.
• GetLeaderboardForUserCharacters Récupère la liste de tous les personnages de l’utilisateur pour la statistique donnée.
• GetPaymentToken Pour les flux de paiement dans lesquels le fournisseur exige que PlayFab (l’exécutant) lance la transaction, mais où le client termine le reste du flux. Dans le cas de Xsolla, le jeton renvoyé ici est transmis à Xsolla par le client pour créer un panier. Interrogez GetPurchase à l’aide de l’OrderId renvoyé une fois le paiement terminé.
• GetPlayerProfile Récupère le profil du joueur.
• GetPlayerSegments Répertorie tous les segments auxquels un joueur appartient actuellement à ce moment précis.
• GetPlayerStatistics Récupère les statistiques indiquées (version actuelle et valeurs de toutes les statistiques, si aucune n’est spécifiée), pour le joueur local.
• GetPlayerStatisticVersions Récupère les informations sur les versions disponibles de la statistique spécifiée.
• GetPlayerTags Obtient toutes les balises ayant un Namespace donné (facultatif) à partir d’un profil de joueur.
• GetPlayerTrades Obtient tous les échanges que le joueur ouvre ou accepte, éventuellement filtrés par statut d’échange.
• GetPlayFabIDsFromFacebookIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Facebook.
• GetPlayFabIDsFromFacebookInstantGamesIds Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Facebook Instant Games.
• GetPlayFabIDsFromGameCenterIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Game Center (appelés Player Identifier dans le Game Center Programming Guide).
• GetPlayFabIDsFromGenericIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants de service génériques. Un identifiant générique est constitué du nom du service et de l’ID propre au service du joueur, tel que spécifié par le titre lors de l’ajout de l’identifiant générique au compte du joueur.
• GetPlayFabIDsFromGoogleIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Google. Les identifiants Google sont les ID des comptes d’utilisateur, disponibles sous la forme id dans les appels de l’API Google+ People.
• GetPlayFabIDsFromKongregateIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Kongregate. Les identifiants Kongregate sont les ID des comptes d’utilisateur, disponibles sous la forme user_id à partir des méthodes de l’API Kongregate (par exemple, https://docs.kongregate.com/docs/concepts-handling-guests).
• GetPlayFabIDsFromNintendoSwitchDeviceIds Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Nintendo Switch.
• GetPlayFabIDsFromPSNAccountIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants PlayStation™ Network.
• GetPlayFabIDsFromSteamIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Steam. Les identifiants Steam sont les ID de profil des comptes d’utilisateur, disponibles sous la forme SteamId dans les appels de l’API Steamworks Community.
• GetPlayFabIDsFromTwitchIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Twitch. Les identifiants Twitch sont les ID des comptes d’utilisateur, disponibles sous la forme “_id” à partir des méthodes de l’API Twitch (par exemple : https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
• GetPlayFabIDsFromXboxLiveIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants XboxLive.
• GetPublisherData Récupère le magasin clé-valeur des paramètres d’éditeur personnalisés.
• GetPurchase Récupère un achat ainsi que son statut PlayFab actuel. Renvoie les objets d’inventaire de l’achat qui sont toujours actifs.
• GetSharedGroupData Récupère les données stockées dans un objet de groupe partagé, ainsi que la liste des membres du groupe. Les non-membres du groupe l’utilisent pour récupérer les données du groupe, y compris l’appartenance, mais ils ne reçoivent pas les données des clés marquées comme privées. Les groupes partagés sont conçus pour partager des données entre un petit nombre de joueurs. Pour plus d’informations, consultez Utilisation des données de groupe partagé.
• GetStoreItems Récupère l’ensemble des objets définis pour la boutique spécifiée, y compris tous les prix définis.
• GetTitleData Récupère le magasin clé-valeur des paramètres de titre personnalisés
• GetAccountInfo Récupère les détails du compte PlayFab de l’utilisateur.
• LoginWithAndroidDeviceID Connecte l’utilisateur à l’aide de l’identifiant d’appareil Android et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithCustomID Connecte l’utilisateur à l’aide d’un identifiant unique personnalisé généré par le titre et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié
• LoginWithEmailAddress Connecte l’utilisateur au compte PlayFab et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié. Contrairement à la plupart des autres appels d’API de connexion, LoginWithEmailAddress ne permet pas la création de nouveaux comptes via CreateAccountFlag. Les adresses e-mail peuvent servir à créer des comptes via RegisterPlayFabUser.
• LoginWithFacebook Connecte l’utilisateur à l’aide d’un jeton d’accès Facebook et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithFacebookInstantGamesId Connecte l’utilisateur à l’aide d’un ID Facebook Instant Games et renvoie un identifiant de session qui peut ensuite être utilisé pour les appels d’API nécessitant un utilisateur authentifié. Nécessite que Facebook Instant Games soit configuré.
• LoginWithGameCenter Connecte l’utilisateur à l’aide d’un identifiant de joueur iOS Game Center et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithGoogleAccount Connecte l’utilisateur à l’aide d’un identifiant de joueur iOS Game Center et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithIOSDeviceID Connecte l’utilisateur à l’aide des informations d’identification de son compte Google.
• LoginWithKongregate Connecte l’utilisateur à l’aide d’un compte de joueur Kongregate.
• LoginWithNintendoSwitchDeviceId Connecte l’utilisateur à l’aide d’un ID d’appareil Nintendo Switch et renvoie un identifiant de session qui peut ensuite être utilisé pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithOpenIdConnect Connecte un utilisateur à l’aide d’un JWT OpenID Connect créé par une relation existante entre un titre et un fournisseur OpenID Connect.
• LoginWithPlayFab nécessitant un utilisateur authentifié. Contrairement à la plupart des autres appels d’API de connexion, LoginWithPlayFab ne permet pas la création de nouveaux comptes via CreateAccountFlag. Les informations d’identification nom d’utilisateur/mot de passe peuvent servir à créer des comptes via RegisterPlayFabUser, ou être ajoutées à des comptes existants à l’aide de AddUsernamePassword.
• LoginWithPSN Connecte l’utilisateur au compte PlayFab et renvoie un identifiant de session qui peut ensuite être utilisé pour les appels d’API nécessitant un utilisateur authentifié. Contrairement à la plupart des autres appels d’API de connexion, LoginWithPlayFab ne permet pas la création de nouveaux comptes via CreateAccountFlag. Les informations d’identification nom d’utilisateur/mot de passe servent à créer des comptes via RegisterPlayFabUser, ou sont ajoutées à des comptes existants à l’aide de AddUsernamePassword.
• LoginWithSteam Connecte l’utilisateur à l’aide d’un ticket d’authentification Steam et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithTwitch Connecte l’utilisateur à l’aide d’un jeton d’accès Twitch.
• LoginWithXbox Connecte l’utilisateur à l’aide d’un jeton XBOX Live et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• GetPlayerCombinedInfo Récupère tous les différents types d’informations de l’utilisateur.

​

API Data

• GetObjects Récupère des objets à partir du profil d’une entité.

​

API Groups

• GetGroup Obtient des informations sur un groupe et ses rôles.
• IsMember Vérifie si une entité est membre d’un groupe ou d’un rôle au sein du groupe.
• ListGroupApplications Répertorie toutes les demandes en attente pour rejoindre un groupe.
• ListGroupBlocks Répertorie toutes les entités empêchées de rejoindre un groupe.
• ListGroupInvitations Répertorie toutes les invitations en attente pour un groupe.
• ListGroupMembers Répertorie tous les membres d’un groupe.
• ListMembership Répertorie tous les groupes et rôles d’une entité.
• ListMembershipOpportunities Répertorie toutes les invitations et candidatures de groupe en attente pour une entité.

​

API Profile

• GetGlobalPolicy Obtient la stratégie d’accès globale du titre.
• GetProfile Récupère le profil de l’entité.
• GetProfiles Récupère le profil de l’entité.
• GetTitlePlayersFromMasterPlayerAccountIds Récupère les comptes de joueur de titre associés au compte de joueur principal donné.

​

API Server

• EvaluateRandomResultTable Renvoie le résultat d’une évaluation d’une Random Result Table, c’est-à-dire l’ItemId du catalogue du jeu qui aurait été ajouté à l’inventaire du joueur si la Random Result Table avait été ajoutée via un Bundle ou un appel à UnlockContainer.
• GetAllSegments Récupère un tableau de définitions de segments de joueurs. Les résultats peuvent être utilisés dans des appels d’API ultérieurs tels que GetPlayersInSegment, qui nécessite un ID de segment. Bien que les noms de segments puissent changer, l’ID de ce segment ne change pas.
• GetAllUsersCharacters Répertorie tous les personnages appartenant à un utilisateur spécifique. Les CharacterIds ne sont pas uniques au niveau global ; le characterId doit être évalué avec le PlayFabId parent pour garantir l’unicité.
• GetCatalogItems Récupère la version spécifiée du catalogue de biens virtuels du titre, y compris toutes les propriétés définies.
• GetCharacterData Récupère les données personnalisées propres au titre pour l’utilisateur, lisibles et modifiables par le client.
• GetCharacterInternalData Récupère les données personnalisées propres au titre pour le personnage de l’utilisateur, auxquelles le client ne peut pas accéder.
• GetCharacterInventory Récupère l’inventaire actuel de biens virtuels du personnage spécifié.
• GetCharacterReadOnlyData
• GetCharacterStatistics Récupère les détails de toutes les statistiques propres au titre pour le personnage spécifique.
• GetFriendLeaderboard Récupère une liste classée des amis du joueur donné pour la statistique donnée, à partir du point indiqué dans le classement.
• GetFriendsList Récupère les amis actuels de l’utilisateur ayant le PlayFabId, limités aux utilisateurs disposant d’un compte PlayFab. Les amis provenant de comptes liés (Facebook, Steam) sont également inclus. Vous pouvez éventuellement exclure les amis de certains services liés.
• GetLeaderboard Récupère une liste d’utilisateurs classés pour la statistique donnée, à partir du point indiqué dans le classement.
• GetLeaderboardAroundCharacter Récupère une liste de personnages classés pour la statistique donnée, centrée sur l’utilisateur demandé.
• GetLeaderboardAroundUser Récupère une liste de personnages classés pour la statistique donnée, centrée sur l’utilisateur demandé.
• GetLeaderboardForUserCharacters Récupère la liste de tous les personnages de l’utilisateur pour la statistique donnée.
• GetPlayerCombinedInfo Renvoie toutes les informations demandées dans la réponse pour l’utilisateur. Notez que des données personnelles, comme l’adresse e-mail ou l’ID Facebook, peuvent être renvoyées. Tous les paramètres ont la valeur false par défaut.
• GetPlayerProfile Récupère le profil du joueur.
• GetPlayerSegments Répertorie tous les segments auxquels un joueur appartient actuellement à ce moment précis.
• GetPlayersInSegment Permet de parcourir page par page tous les joueurs d’un segment donné. Cette API crée un instantané de tous les profils de joueurs correspondant à la définition du segment au moment de sa création ; cet instantané subsiste pendant la durée Total Seconds to Live, sa durée de vie étant renouvelée à chaque utilisation ultérieure du jeton de continuation. Les profils qui changent pendant la pagination ne sont pas reflétés dans les résultats. Les segments de test A/B ne sont actuellement pas pris en charge par cette opération.
• GetPlayerStatistics Récupère la version actuelle et les valeurs des statistiques indiquées, pour le joueur local.
• GetPlayerStatisticVersions Récupère les informations sur les versions disponibles de la statistique spécifiée.
• GetPlayerTags Obtient toutes les balises ayant un Namespace donné (facultatif) à partir d’un profil de joueur.
• GetPlayFabIDsFromFacebookIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Facebook.
• GetPlayFabIDsFromFacebookInstantGamesIds Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Facebook.
• GetPlayFabIDsFromGenericIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants de service génériques. Un identifiant générique est constitué du nom du service et de l’ID propre au service du joueur, tel que spécifié par le titre lors de l’ajout de l’identifiant générique au compte du joueur.
• GetPlayFabIDsFromNintendoSwitchDeviceIds Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants d’appareil Nintendo Switch.
• GetPlayFabIDsFromPSNAccountIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants PlayStation Network.
• GetPlayFabIDsFromSteamIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants Steam. Les identifiants Steam sont les ID de profil des comptes d’utilisateur, disponibles sous la forme SteamId dans les appels de l’API Steamworks Community.
• GetPlayFabIDsFromXboxLiveIDs Récupère les identifiants PlayFab uniques correspondant à l’ensemble donné d’identifiants XboxLive.
• GetPublisherData Récupère le magasin clé-valeur des paramètres d’éditeur personnalisés.
• GetRandomResultTables Récupère les informations de configuration des tables de résultats aléatoires spécifiées pour le titre, y compris toutes les valeurs ItemId et tous les poids.
• GetServerCustomIDsFromPlayFabIDs Récupère les identifiants de compte PlayFab associés à l’ensemble donné d’identifiants personnalisés de serveur.
• GetSharedGroupData Récupère les données stockées dans un objet de groupe partagé, ainsi que la liste des membres du groupe. Le serveur peut accéder à toutes les données publiques et privées du groupe. Les groupes partagés sont conçus pour partager des données entre un petit nombre de joueurs. Pour plus d’informations, consultez Utilisation des données de groupe partagé.
• GetStoreItems Récupère l’ensemble des objets définis pour la boutique spécifiée, y compris tous les prix définis, pour le joueur spécifié.
• GetTitleData Récupère le magasin clé-valeur des paramètres de titre personnalisés.
• GetTitleInternalData Récupère le magasin clé-valeur des paramètres de titre internes personnalisés.
• GetUserAccountInfo Récupère les détails pertinents d’un utilisateur spécifié.
• GetUserBans Obtient tous les bannissements d’un utilisateur.
• GetUserData Récupère les données personnalisées propres au titre pour l’utilisateur, lisibles et modifiables par le client.
• GetUserInternalData Récupère les données personnalisées propres au titre pour l’utilisateur, auxquelles le client ne peut pas accéder.
• GetUserInventory Récupère l’inventaire actuel de biens virtuels de l’utilisateur spécifié.
• GetUserPublisherData Récupère les données personnalisées propres à l’éditeur pour l’utilisateur, lisibles et modifiables par le client.
• GetUserPublisherInternalData Récupère les données personnalisées propres à l’éditeur pour l’utilisateur, auxquelles le client ne peut pas accéder.
• GetUserPublisherReadOnlyData
• GetUserReadOnlyData Met à jour les données personnalisées propres au titre pour l’utilisateur, qui ne peuvent être que lues par le client.
• LoginWithServerCustomId Connecte de manière sécurisée un client de jeu à partir d’un back-end de serveur externe à l’aide d’un identifiant personnalisé pour ce joueur. Server Custom ID et Client Custom ID s’excluent mutuellement et ne peuvent pas être utilisés pour récupérer le même compte de joueur.
• LoginWithXbox Connecte l’utilisateur à l’aide d’un jeton XBOX Live provenant d’un back-end de serveur externe et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.
• LoginWithXboxId Connecte l’utilisateur à l’aide d’un ID XBOX et d’un ID de sandbox et renvoie un identifiant de session qui peut être utilisé ultérieurement pour les appels d’API nécessitant un utilisateur authentifié.