Documentation

PlayFab Admin API Categories

APIs for managing title configurations, uploaded Game Server code executables, and user data

Authentication

Account Management

  • BanUsers

    Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.

  • GetUserAccountInfo

    Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier

  • GetUserBans

    Gets all bans for a user.

  • ResetUsers

    Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics

  • RevokeAllBansForUser

    Revoke all active bans for a user.

  • RevokeBans

    Revoke all active bans specified with BanId.

  • SendAccountRecoveryEmail

    Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password

  • UpdateBans

    Updates information of a list of existing bans specified with Ban Ids.

  • UpdateUserTitleDisplayName

    Updates the title specific display name for a user

Player Data Management

  • CreatePlayerStatisticDefinition

    Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.

  • DeleteUsers

    Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not remove the player's event history, login history, inventory items, nor virtual currencies.

  • GetDataReport

    Retrieves a download URL for the requested report

  • GetPlayerStatisticDefinitions

    Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.

  • GetPlayerStatisticVersions

    Retrieves the information on the available versions of the specified statistic.

  • 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

  • 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

  • IncrementPlayerStatisticVersion

    Resets the indicated statistic, removing all player entries for it and backing up the old values.

  • RefundPurchase

    Attempts to process an order refund through the original real money payment provider.

  • ResetUserStatistics

    Completely removes all statistics for the specified user, for the current game

  • ResolvePurchaseDispute

    Attempts to resolve a dispute with the original order's payment provider.

  • UpdatePlayerStatisticDefinition

    Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.

  • 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

  • UpdateUserPublisherInternalData

    Updates the publisher-specific custom data for the user which cannot be accessed by the client

  • UpdateUserPublisherReadOnlyData

    Updates the publisher-specific custom data for the user which can only be read by the client

  • UpdateUserReadOnlyData

    Updates the title-specific custom data for the user which can only be read by the client

Title-Wide Data Management

  • AddNews

    Adds a new news item to the title's news feed

  • AddVirtualCurrencyTypes

    Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded.

  • DeleteStore

    Deletes an existing virtual item store

  • GetCatalogItems

    Retrieves the specified version of the title's catalog of virtual goods, including all defined properties

  • 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

  • GetTitleInternalData

    Retrieves the key-value store of custom title settings which cannot be read by the client

  • ListVirtualCurrencyTypes

    Retuns the list of all defined virtual currencies for the title

  • RemoveVirtualCurrencyTypes

    Removes one or more virtual currencies from the set defined for the title.

  • SetCatalogItems

    Creates the catalog configuration of all virtual goods for the specified catalog version

  • SetStoreItems

    Sets all the items in one virtual store

  • SetTitleData

    Creates and updates the key-value store of custom title settings which can be read by the client

  • SetTitleInternalData

    Updates the key-value store of custom title settings which cannot be read by the client

  • SetupPushNotification

    Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported.

  • UpdateCatalogItems

    Updates the catalog configuration for virtual goods in the specified catalog version

  • UpdateRandomResultTables

    Updates the random drop table configuration for the title

  • UpdateStoreItems

    Updates an existing virtual item store with new or modified items

Player Item Management

Matchmaking

  • GetMatchmakerGameInfo

    Retrieves the details for a specific completed session, including links to standard out and standard error logs

  • GetMatchmakerGameModes

    Retrieves the details of defined game modes for the specified game server executable

  • ModifyMatchmakerGameModes

    Updates the game server mode details for the specified game server executable

Custom Server Management

  • AddServerBuild

    Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a client is permitted to request in a call to StartGame

  • GetServerBuildInfo

    Retrieves the build details for the specified game server executable

  • GetServerBuildUploadUrl

    Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild)

  • ListServerBuilds

    Retrieves the build details for all game server executables which are currently defined for the title

  • ModifyServerBuild

    Updates the build details for the specified game server executable

  • RemoveServerBuild

    Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame

Shared Group Data

Server-Side Cloud Script

  • GetCloudScriptRevision

    Gets the contents and information of a specific Cloud Script revision.

  • GetCloudScriptVersions

    Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.

  • SetPublishedRevision

    Sets the currently published revision of a title Cloud Script

  • UpdateCloudScript

    Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision.

Content

  • DeleteContent

    Delete a content file from the title. When deleting a file that does not exist, it returns success.

  • GetContentList

    List all contents of the title and get statistics such as size

  • GetContentUploadUrl

    Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.

Characters

PlayStream

  • AddPlayerTag

    Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.

  • GetAllActionGroups

    Retrieve a list of all PlayStream actions groups.

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

ScheduledTask