Profile Reads
Profile includes any data stored related to the player profile, entity profile, character profile, groups, and inventory. Profile data is information that applies to an individual player, group of players, or items, and is stored as Key/Value Pairs (KVPs) by PlayFab.
The following APIs cause the Profile read meter to increment.
Admin APIs
CheckLimitedEditionItemAvailability Checks the global count for the limited edition item.
GetAllSegments Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
ExportMasterPlayerData Exports all associated data of a master player account.
GetCatalogItems Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.
GetContentList List all contents of the title and get statistics such as size.
GetDataReport Retrieves a download URL for the requested report.
GetPlayerSegments List all segments that a player currently belongs to at this moment in time.
GetPlayerTags Get all tags with a given Namespace (optional) from a player profile.
GetPolicy Gets the requested policy.
GetPublisherData Retrieves the key-value store of custom publisher settings.
GetRandomResultTables Retrieves the random drop table configuration for the title.
GetStoreItems Retrieves the set of items defined for the specified store, including all prices defined.
GetTitleData Retrieves the key-value store of custom title settings which can be read by the client.
[GetUserAccountInfo](Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier) Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier.
GetUserBans Gets all bans for a user.
GetUserData Retrieves the title-specific custom data for the user which is readable and writable by the client.
GetUserInternalData Retrieves the title-specific custom data for the user which cannot be accessed by the client.
GetUserInventory Retrieves the specified user's current inventory of virtual goods
GetUserPublisherData Retrieves the publisher-specific custom data for the user which is readable and writable by the client.
GetUserPublisherInternalData Retrieves the publisher-specific custom data for the user which cannot be accessed by the client.
GetUserPublisherReadOnlyData Retrieves the publisher-specific custom data for the user which can only be read by the client.
GetUserReadOnlyData Retrieves the title-specific custom data for the user which can only be read by the client.
ListVirtualCurrencyTypes Retuns the list of all defined virtual currencies for the title
GetPlayerIdFromAuthToken Gets a player's ID from an auth token.
GetPlayersInSegment Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation.
GetExperiments Gets the details of all experiments for a title.
GetLatestScorecard Gets the latest scorecard of the experiment for the title.
GetTreatmentAssignment Gets the treatment assignments for a player for every running experiment in the title
Client APIs
GetAllUsersCharacters Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
GetCatalogItems Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.
GetCharacterData Retrieves the title-specific custom data for the character which is readable and writable by the client.
GetCharacterInventory Retrieves the specified character's current inventory of virtual goods.
GetCharacterLeaderboard Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard.
GetCharacterReadOnlyData Retrieves the title-specific custom data for the character which can only be read by the client.
GetCharacterStatistics Retrieves the details of all title-specific statistics for the user.
GetFriendLeaderboard Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard.
GetFriendLeaderboardAroundPlayer Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.
GetFriendsList Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
GetLeaderboard Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard.
GetLeaderboardAroundCharacter Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID.
GetLeaderboardAroundPlayer Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.
GetLeaderboardForUserCharacters Retrieves a list of all of the user's characters for the given statistic.
GetPaymentToken For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
GetPlayerProfile Retrieves the player's profile.
GetPlayerSegments List all segments that a player currently belongs to at this moment in time.
GetPlayerStatistics Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.
GetPlayerStatisticVersions Retrieves the information on the available versions of the specified statistic.
GetPlayerTags Get all tags with a given Namespace (optional) from a player profile.
GetPlayerTrades Gets all trades the player has either opened or accepted, optionally filtered by trade status.
GetPlayFabIDsFromFacebookIDs Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
GetPlayFabIDsFromFacebookInstantGamesIds Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
GetPlayFabIDsFromGameCenterIDs Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).
GetPlayFabIDsFromGenericIDs Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.
GetPlayFabIDsFromGoogleIDs Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls.
GetPlayFabIDsFromKongregateIDs Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).
GetPlayFabIDsFromNintendoSwitchDeviceIds Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch identifiers.
GetPlayFabIDsFromPSNAccountIDs Retrieves the unique PlayFab identifiers for the given set of PlayStation™Network identifiers.
GetPlayFabIDsFromSteamIDs Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
GetPlayFabIDsFromTwitchIDs Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
GetPlayFabIDsFromXboxLiveIDs Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
GetPublisherData Retrieves the key-value store of custom publisher settings.
GetPurchase Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.
GetSharedGroupData Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, see Using Shared Group Data.
GetStoreItems Retrieves the set of items defined for the specified store, including all prices defined.
GetTitleData Retrieves the key-value store of custom title settings
GetAccountInfo Retrieves the user's PlayFab account details.
LoginWithAndroidDeviceID Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithCustomID Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user
LoginWithEmailAddress Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.
LoginWithFacebook Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithFacebookInstantGamesId Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
LoginWithGameCenter Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithGoogleAccount Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithIOSDeviceID Signs the user in using their Google account credentials.
LoginWithKongregate Signs the user in using a Kongregate player account.
LoginWithNintendoSwitchDeviceId Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithOpenIdConnect Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.
LoginWithPlayFab which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
LoginWithPSN Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
LoginWithSteam Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithTwitch Signs the user in using a Twitch access token.
LoginWithXbox Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
GetPlayerCombinedInfo Retrieves all of the user's different kinds of info.
“PlayStation” is a registered trademark or trademark of Sony Interactive Entertainment Inc.
Data APIs
- GetObjects Retrieves objects from an entity's profile.
Groups APIs
GetGroup Gets information about a group and its roles.
IsMember Checks to see if an entity is a member of a group or role within the group.
ListGroupApplications Lists all outstanding requests to join a group.
ListGroupBlocks Lists all entities blocked from joining a group.
ListGroupInvitations Lists all outstanding invitations for a group.
ListGroupMembers Lists all members for a group.
ListMembership Lists all groups and roles for an entity.
ListMembershipOpportunities Lists all outstanding invitations and group applications for an entity.
Profile APIs
GetGlobalPolicy Gets the global title access policy.
GetProfile Retrieves the entity's profile.
GetProfiles Retrieves the entity's profile.
GetTitlePlayersFromMasterPlayerAccountIds Retrieves the title player accounts associated with the given master player account.
Server APIs
EvaluateRandomResultTable Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.
GetAllSegments Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
GetAllUsersCharacters Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
GetCatalogItems Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.
GetCharacterData Retrieves the title-specific custom data for the user which is readable and writable by the client.
GetCharacterInternalData Retrieves the title-specific custom data for the user's character which cannot be accessed by the client.
GetCharacterInventory Retrieves the specified character's current inventory of virtual goods.
GetCharacterStatistics Retrieves the details of all title-specific statistics for the specific character.
GetFriendLeaderboard Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard.
GetFriendsList Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
GetLeaderboard Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard.
GetLeaderboardAroundCharacter Retrieves a list of ranked characters for the given statistic, centered on the requested user.
GetLeaderboardAroundUser Retrieves a list of ranked characters for the given statistic, centered on the requested user.
GetLeaderboardForUserCharacters Retrieves a list of all of the user's characters for the given statistic.
GetPlayerCombinedInfo Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false.
GetPlayerProfile Retrieves the player's profile.
GetPlayerSegments List all segments that a player currently belongs to at this moment in time.
GetPlayersInSegment Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation.
GetPlayerStatistics Retrieves the current version and values for the indicated statistics, for the local player.
GetPlayerStatisticVersions Retrieves the information on the available versions of the specified statistic.
GetPlayerTags Get all tags with a given Namespace (optional) from a player profile.
GetPlayFabIDsFromFacebookIDs Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
GetPlayFabIDsFromFacebookInstantGamesIds Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
GetPlayFabIDsFromGenericIDs Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.
GetPlayFabIDsFromNintendoSwitchDeviceIds Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
GetPlayFabIDsFromPSNAccountIDs Retrieves the unique PlayFab identifiers for the given set of PlayStation Network identifiers.
GetPlayFabIDsFromSteamIDs Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
GetPlayFabIDsFromXboxLiveIDs Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
GetPublisherData Retrieves the key-value store of custom publisher settings.
GetRandomResultTables Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights.
GetServerCustomIDsFromPlayFabIDs Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
GetSharedGroupData Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared Groups are designed for sharing data between a very small number of players, see Using Shared Group Data.
GetStoreItems Retrieves the set of items defined for the specified store, including all prices defined, for the specified player.
GetTitleData Retrieves the key-value store of custom title settings.
GetTitleInternalData Retrieves the key-value store of custom internal title settings.
GetUserAccountInfo Retrieves the relevant details for a specified user.
GetUserBans Gets all bans for a user.
GetUserData Retrieves the title-specific custom data for the user which is readable and writable by the client.
GetUserInternalData Retrieves the title-specific custom data for the user which cannot be accessed by the client.
GetUserInventory Retrieves the specified user's current inventory of virtual goods.
GetUserPublisherData Retrieves the publisher-specific custom data for the user which is readable and writable by the client.
GetUserPublisherInternalData Retrieves the publisher-specific custom data for the user which cannot be accessed by the client.
GetUserReadOnlyData Updates the title-specific custom data for the user which can only be read by the client.
LoginWithServerCustomId Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
LoginWithXbox Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
LoginWithXboxId Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for