PlayFab Server API Categories

Provides functionality to allow external (developer-controlled) servers to interact with user inventories and data in a trusted manner, and to handle matchmaking and client connection orchestration

BanUsers
Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
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.
RevokeBans
Revoke all active bans specified with BanId.
SendPushNotification
Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
UpdateBans
Updates information of a list of existing bans specified with Ban Ids.
DeleteUsers
Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics.
GetFriendLeaderboard
Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard
GetLeaderboard
Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
GetLeaderboardAroundUser
Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
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.
GetPlayerStatistics
Retrieves the current version and values for the indicated statistics, for the local player.
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
GetUserPublisherData
Retrieves the publisher-specific custom data for the user which is readable and writable by the client
GetUserReadOnlyData
Retrieves the title-specific custom data for the user which can only be read by the client
UpdateUserData
Updates the title-specific custom data for the user which is readable and writable by the client
UpdateUserInternalData
Updates the title-specific custom data for the user which cannot be accessed by the client
UpdateUserPublisherData
Updates the publisher-specific custom data for the user which is readable and writable by the client
UpdateUserReadOnlyData
Updates the title-specific custom data for the user which can only be read by the client
GetCatalogItems
Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
GetTime
Retrieves the current server time
GetTitleData
Retrieves the key-value store of custom title settings
GetTitleNews
Retrieves the title news feed, as configured in the developer portal
SetTitleData
Updates the key-value store of custom title settings
ConsumeItem
Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.
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.
GetRandomResultTables
Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights
GetUserInventory
Retrieves the specified user's current inventory of virtual goods
ModifyItemUses
Modifies the number of remaining uses of a player's inventory item
RedeemCoupon
Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.
ReportPlayer
Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.
UnlockContainerInstance
Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
UnlockContainerItem
Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
AddFriend
Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
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.
RemoveFriend
Removes the specified friend from the the user's friend list
DeregisterGame
Inform the matchmaker that a Game Server Instance is removed.
RegisterGame
Inform the matchmaker that a new Game Server Instance is added.
AddSharedGroupMembers
Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members.
CreateSharedGroup
Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members.
DeleteSharedGroup
Deletes a shared group, freeing up the shared group ID to be reused for a new group
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.
RemoveSharedGroupMembers
Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted.
UpdateSharedGroupData
Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data.
ExecuteCloudScript
Executes a CloudScript function, with the 'currentPlayerId' variable set to the specified PlayFabId parameter value.
GetContentDownloadUrl
This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service
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.
GetCharacterLeaderboard
Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
GrantCharacterToUser
Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
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
GetCharacterReadOnlyData
Retrieves the title-specific custom data for the user's character which can only be read by the client
UpdateCharacterData
Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client
AddPlayerTag
Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
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.
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.
GetPlayerTags
Get all tags with a given Namespace (optional) from a player profile.
RemovePlayerTag
Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.