C# Class PlayFab.PlayFabAdminAPI

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

Show file Open project: PlayFab/PlayFab-Samples

Public Methods

Method	Description
AddNews ( AddNewsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Adds a new news item to the title's news feed
AddPlayerTag ( AddPlayerTagRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
AddServerBuild ( AddServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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
AddUserVirtualCurrency ( AddUserVirtualCurrencyRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Increments the specified virtual currency by the stated amount
AddVirtualCurrencyTypes ( AddVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
BanUsers ( BanUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
CreatePlayerStatisticDefinition ( CreatePlayerStatisticDefinitionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.
DeleteContent ( DeleteContentRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Delete a content file from the title
DeleteStore ( DeleteStoreRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Deletes an existing virtual item store
DeleteUsers ( DeleteUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
GetAllActionGroups ( GetAllActionGroupsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieve a list of all PlayStream actions groups.
GetAllSegments ( GetAllSegmentsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
GetCatalogItems ( GetCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
GetCloudScriptRevision ( GetCloudScriptRevisionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Gets the contents and information of a specific Cloud Script revision.
GetCloudScriptVersions ( GetCloudScriptVersionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.
GetContentList ( GetContentListRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	List all contents of the title and get statistics such as size
GetContentUploadUrl ( GetContentUploadUrlRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content.
GetDataReport ( GetDataReportRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves a download URL for the requested report
GetMatchmakerGameInfo ( GetMatchmakerGameInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the details for a specific completed session, including links to standard out and standard error logs
GetMatchmakerGameModes ( GetMatchmakerGameModesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the details of defined game modes for the specified game server executable
GetPlayerSegments ( GetPlayersSegmentsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	List all segments that a player currently belongs to at this moment in time.
GetPlayerStatisticDefinitions ( GetPlayerStatisticDefinitionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.
GetPlayerStatisticVersions ( GetPlayerStatisticVersionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the information on the available versions of the specified statistic.
GetPlayerTags ( GetPlayerTagsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Get all tags with a given Namespace (optional) from a player profile.
GetPlayersInSegment ( GetPlayersInSegmentRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
GetPublisherData ( GetPublisherDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the key-value store of custom publisher settings
GetRandomResultTables ( GetRandomResultTablesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the random drop table configuration for the title
GetServerBuildInfo ( GetServerBuildInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the build details for the specified game server executable
GetServerBuildUploadUrl ( GetServerBuildUploadURLRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild)
GetStoreItems ( GetStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the set of items defined for the specified store, including all prices defined
GetTitleData ( GetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the key-value store of custom title settings which can be read by the client
GetTitleInternalData ( GetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the key-value store of custom title settings which cannot be read by the client
GetUserAccountInfo ( LookupUserAccountInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
GetUserBans ( GetUserBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Gets all bans for a user.
GetUserData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the title-specific custom data for the user which is readable and writable by the client
GetUserInternalData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the title-specific custom data for the user which cannot be accessed by the client
GetUserInventory ( GetUserInventoryRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the specified user's current inventory of virtual goods
GetUserPublisherData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the publisher-specific custom data for the user which is readable and writable by the client
GetUserPublisherInternalData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
GetUserPublisherReadOnlyData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the publisher-specific custom data for the user which can only be read by the client
GetUserReadOnlyData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the title-specific custom data for the user which can only be read by the client
GrantItemsToUsers ( GrantItemsToUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Adds the specified items to the specified user inventories
IncrementPlayerStatisticVersion ( IncrementPlayerStatisticVersionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Resets the indicated statistic, removing all player entries for it and backing up the old values.
ListServerBuilds ( ListBuildsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retrieves the build details for all game server executables which are currently defined for the title
ListVirtualCurrencyTypes ( ListVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Retuns the list of all defined virtual currencies for the title
ModifyMatchmakerGameModes ( ModifyMatchmakerGameModesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the game server mode details for the specified game server executable
ModifyServerBuild ( ModifyServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the build details for the specified game server executable
RefundPurchase ( RefundPurchaseRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Attempts to process an order refund through the original real money payment provider.
RemovePlayerTag ( RemovePlayerTagRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
RemoveServerBuild ( RemoveServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame
RemoveVirtualCurrencyTypes ( RemoveVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Removes one or more virtual currencies from the set defined for the title.
ResetCharacterStatistics ( ResetCharacterStatisticsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Completely removes all statistics for the specified character, for the current game
ResetUserStatistics ( ResetUserStatisticsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Completely removes all statistics for the specified user, for the current game
ResetUsers ( ResetUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics
ResolvePurchaseDispute ( ResolvePurchaseDisputeRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Attempts to resolve a dispute with the original order's payment provider.
RevokeAllBansForUser ( RevokeAllBansForUserRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Revoke all active bans for a user.
RevokeBans ( RevokeBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Revoke all active bans specified with BanId.
RevokeInventoryItem ( RevokeInventoryItemRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Revokes access to an item in a user's inventory
SendAccountRecoveryEmail ( SendAccountRecoveryEmailRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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
SetCatalogItems ( UpdateCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Creates the catalog configuration of all virtual goods for the specified catalog version
SetPublishedRevision ( SetPublishedRevisionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Sets the currently published revision of a title Cloud Script
SetPublisherData ( SetPublisherDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the key-value store of custom publisher settings
SetStoreItems ( UpdateStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Sets all the items in one virtual store
SetTitleData ( SetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Creates and updates the key-value store of custom title settings which can be read by the client
SetTitleInternalData ( SetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the key-value store of custom title settings which cannot be read by the client
SetupPushNotification ( SetupPushNotificationRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
SubtractUserVirtualCurrency ( SubtractUserVirtualCurrencyRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Decrements the specified virtual currency by the stated amount
UpdateBans ( UpdateBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates information of a list of existing bans specified with Ban Ids.
UpdateCatalogItems ( UpdateCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the catalog configuration for virtual goods in the specified catalog version
UpdateCloudScript ( UpdateCloudScriptRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	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.
UpdatePlayerStatisticDefinition ( UpdatePlayerStatisticDefinitionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
UpdateRandomResultTables ( UpdateRandomResultTablesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the random drop table configuration for the title
UpdateStoreItems ( UpdateStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates an existing virtual item store with new or modified items
UpdateUserData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the title-specific custom data for the user which is readable and writable by the client
UpdateUserInternalData ( UpdateUserInternalDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the title-specific custom data for the user which cannot be accessed by the client
UpdateUserPublisherData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the publisher-specific custom data for the user which is readable and writable by the client
UpdateUserPublisherInternalData ( UpdateUserInternalDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the publisher-specific custom data for the user which cannot be accessed by the client
UpdateUserPublisherReadOnlyData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the publisher-specific custom data for the user which can only be read by the client
UpdateUserReadOnlyData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the title-specific custom data for the user which can only be read by the client
UpdateUserTitleDisplayName ( UpdateUserTitleDisplayNameRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void	Updates the title specific display name for a user

Method Details

AddNews() public static method

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

public static AddNews ( AddNewsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.AddNewsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

AddPlayerTag() public static method

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

public static AddPlayerTag ( AddPlayerTagRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.AddPlayerTagRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

AddServerBuild() public static method

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

public static AddServerBuild ( AddServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.AddServerBuildRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

AddUserVirtualCurrency() public static method

Increments the specified virtual currency by the stated amount

public static AddUserVirtualCurrency ( AddUserVirtualCurrencyRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.AddUserVirtualCurrencyRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

AddVirtualCurrencyTypes() public static method

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.

public static AddVirtualCurrencyTypes ( AddVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.AddVirtualCurrencyTypesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

BanUsers() public static method

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

public static BanUsers ( BanUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.BanUsersRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

CreatePlayerStatisticDefinition() public static method

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

public static CreatePlayerStatisticDefinition ( CreatePlayerStatisticDefinitionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.CreatePlayerStatisticDefinitionRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

DeleteContent() public static method

Delete a content file from the title

public static DeleteContent ( DeleteContentRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.DeleteContentRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

DeleteStore() public static method

Deletes an existing virtual item store

public static DeleteStore ( DeleteStoreRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.DeleteStoreRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

DeleteUsers() public static method

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.

public static DeleteUsers ( DeleteUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.DeleteUsersRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetAllActionGroups() public static method

Retrieve a list of all PlayStream actions groups.

public static GetAllActionGroups ( GetAllActionGroupsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	GetAllActionGroupsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetAllSegments() public static method

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.

public static GetAllSegments ( GetAllSegmentsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	GetAllSegmentsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetCatalogItems() public static method

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

public static GetCatalogItems ( GetCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetCatalogItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetCloudScriptRevision() public static method

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

public static GetCloudScriptRevision ( GetCloudScriptRevisionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetCloudScriptRevisionRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetCloudScriptVersions() public static method

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

public static GetCloudScriptVersions ( GetCloudScriptVersionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	GetCloudScriptVersionsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetContentList() public static method

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

public static GetContentList ( GetContentListRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetContentListRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetContentUploadUrl() public static method

Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content.

public static GetContentUploadUrl ( GetContentUploadUrlRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetContentUploadUrlRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetDataReport() public static method

Retrieves a download URL for the requested report

public static GetDataReport ( GetDataReportRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetDataReportRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetMatchmakerGameInfo() public static method

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

public static GetMatchmakerGameInfo ( GetMatchmakerGameInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetMatchmakerGameInfoRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetMatchmakerGameModes() public static method

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

public static GetMatchmakerGameModes ( GetMatchmakerGameModesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetMatchmakerGameModesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPlayerSegments() public static method

List all segments that a player currently belongs to at this moment in time.

public static GetPlayerSegments ( GetPlayersSegmentsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetPlayersSegmentsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPlayerStatisticDefinitions() public static method

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

public static GetPlayerStatisticDefinitions ( GetPlayerStatisticDefinitionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	GetPlayerStatisticDefinitionsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPlayerStatisticVersions() public static method

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

public static GetPlayerStatisticVersions ( GetPlayerStatisticVersionsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetPlayerStatisticVersionsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPlayerTags() public static method

Get all tags with a given Namespace (optional) from a player profile.

public static GetPlayerTags ( GetPlayerTagsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetPlayerTagsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPlayersInSegment() public static method

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.

public static GetPlayersInSegment ( GetPlayersInSegmentRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetPlayersInSegmentRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetPublisherData() public static method

Retrieves the key-value store of custom publisher settings

public static GetPublisherData ( GetPublisherDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetPublisherDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetRandomResultTables() public static method

Retrieves the random drop table configuration for the title

public static GetRandomResultTables ( GetRandomResultTablesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetRandomResultTablesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetServerBuildInfo() public static method

Retrieves the build details for the specified game server executable

public static GetServerBuildInfo ( GetServerBuildInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetServerBuildInfoRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetServerBuildUploadUrl() public static method

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

public static GetServerBuildUploadUrl ( GetServerBuildUploadURLRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetServerBuildUploadURLRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetStoreItems() public static method

Retrieves the set of items defined for the specified store, including all prices defined

public static GetStoreItems ( GetStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetStoreItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetTitleData() public static method

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

public static GetTitleData ( GetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetTitleDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetTitleInternalData() public static method

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

public static GetTitleInternalData ( GetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetTitleDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserAccountInfo() public static method

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

public static GetUserAccountInfo ( LookupUserAccountInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.LookupUserAccountInfoRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserBans() public static method

Gets all bans for a user.

public static GetUserBans ( GetUserBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserBansRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserData() public static method

Retrieves the title-specific custom data for the user which is readable and writable by the client

public static GetUserData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserInternalData() public static method

Retrieves the title-specific custom data for the user which cannot be accessed by the client

public static GetUserInternalData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserInventory() public static method

Retrieves the specified user's current inventory of virtual goods

public static GetUserInventory ( GetUserInventoryRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserInventoryRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserPublisherData() public static method

Retrieves the publisher-specific custom data for the user which is readable and writable by the client

public static GetUserPublisherData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserPublisherInternalData() public static method

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

public static GetUserPublisherInternalData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserPublisherReadOnlyData() public static method

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

public static GetUserPublisherReadOnlyData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GetUserReadOnlyData() public static method

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

public static GetUserReadOnlyData ( GetUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GetUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

GrantItemsToUsers() public static method

Adds the specified items to the specified user inventories

public static GrantItemsToUsers ( GrantItemsToUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.GrantItemsToUsersRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

IncrementPlayerStatisticVersion() public static method

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

public static IncrementPlayerStatisticVersion ( IncrementPlayerStatisticVersionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.IncrementPlayerStatisticVersionRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ListServerBuilds() public static method

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

public static ListServerBuilds ( ListBuildsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	ListBuildsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ListVirtualCurrencyTypes() public static method

Retuns the list of all defined virtual currencies for the title

public static ListVirtualCurrencyTypes ( ListVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	ListVirtualCurrencyTypesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ModifyMatchmakerGameModes() public static method

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

public static ModifyMatchmakerGameModes ( ModifyMatchmakerGameModesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ModifyMatchmakerGameModesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ModifyServerBuild() public static method

Updates the build details for the specified game server executable

public static ModifyServerBuild ( ModifyServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ModifyServerBuildRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RefundPurchase() public static method

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

public static RefundPurchase ( RefundPurchaseRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RefundPurchaseRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RemovePlayerTag() public static method

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

public static RemovePlayerTag ( RemovePlayerTagRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RemovePlayerTagRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RemoveServerBuild() public static method

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

public static RemoveServerBuild ( RemoveServerBuildRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RemoveServerBuildRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RemoveVirtualCurrencyTypes() public static method

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

public static RemoveVirtualCurrencyTypes ( RemoveVirtualCurrencyTypesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RemoveVirtualCurrencyTypesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ResetCharacterStatistics() public static method

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

public static ResetCharacterStatistics ( ResetCharacterStatisticsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ResetCharacterStatisticsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ResetUserStatistics() public static method

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

public static ResetUserStatistics ( ResetUserStatisticsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ResetUserStatisticsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ResetUsers() public static method

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

public static ResetUsers ( ResetUsersRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ResetUsersRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

ResolvePurchaseDispute() public static method

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

public static ResolvePurchaseDispute ( ResolvePurchaseDisputeRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.ResolvePurchaseDisputeRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RevokeAllBansForUser() public static method

Revoke all active bans for a user.

public static RevokeAllBansForUser ( RevokeAllBansForUserRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RevokeAllBansForUserRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RevokeBans() public static method

Revoke all active bans specified with BanId.

public static RevokeBans ( RevokeBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RevokeBansRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

RevokeInventoryItem() public static method

Revokes access to an item in a user's inventory

public static RevokeInventoryItem ( RevokeInventoryItemRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.RevokeInventoryItemRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SendAccountRecoveryEmail() public static method

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

public static SendAccountRecoveryEmail ( SendAccountRecoveryEmailRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SendAccountRecoveryEmailRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetCatalogItems() public static method

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

public static SetCatalogItems ( UpdateCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateCatalogItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetPublishedRevision() public static method

Sets the currently published revision of a title Cloud Script

public static SetPublishedRevision ( SetPublishedRevisionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SetPublishedRevisionRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetPublisherData() public static method

Updates the key-value store of custom publisher settings

public static SetPublisherData ( SetPublisherDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SetPublisherDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetStoreItems() public static method

Sets all the items in one virtual store

public static SetStoreItems ( UpdateStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateStoreItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetTitleData() public static method

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

public static SetTitleData ( SetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SetTitleDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetTitleInternalData() public static method

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

public static SetTitleInternalData ( SetTitleDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SetTitleDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SetupPushNotification() public static method

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.

public static SetupPushNotification ( SetupPushNotificationRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SetupPushNotificationRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

SubtractUserVirtualCurrency() public static method

Decrements the specified virtual currency by the stated amount

public static SubtractUserVirtualCurrency ( SubtractUserVirtualCurrencyRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.SubtractUserVirtualCurrencyRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateBans() public static method

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

public static UpdateBans ( UpdateBansRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateBansRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateCatalogItems() public static method

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

public static UpdateCatalogItems ( UpdateCatalogItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateCatalogItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateCloudScript() public static method

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.

public static UpdateCloudScript ( UpdateCloudScriptRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateCloudScriptRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdatePlayerStatisticDefinition() public static method

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

public static UpdatePlayerStatisticDefinition ( UpdatePlayerStatisticDefinitionRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdatePlayerStatisticDefinitionRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateRandomResultTables() public static method

Updates the random drop table configuration for the title

public static UpdateRandomResultTables ( UpdateRandomResultTablesRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateRandomResultTablesRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateStoreItems() public static method

Updates an existing virtual item store with new or modified items

public static UpdateStoreItems ( UpdateStoreItemsRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateStoreItemsRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserData() public static method

Updates the title-specific custom data for the user which is readable and writable by the client

public static UpdateUserData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserInternalData() public static method

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

public static UpdateUserInternalData ( UpdateUserInternalDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserInternalDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserPublisherData() public static method

Updates the publisher-specific custom data for the user which is readable and writable by the client

public static UpdateUserPublisherData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserPublisherInternalData() public static method

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

public static UpdateUserPublisherInternalData ( UpdateUserInternalDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserInternalDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserPublisherReadOnlyData() public static method

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

public static UpdateUserPublisherReadOnlyData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserReadOnlyData() public static method

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

public static UpdateUserReadOnlyData ( UpdateUserDataRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserDataRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void

UpdateUserTitleDisplayName() public static method

Updates the title specific display name for a user

public static UpdateUserTitleDisplayName ( UpdateUserTitleDisplayNameRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request	PlayFab.AdminModels.UpdateUserTitleDisplayNameRequest
resultCallback	Action
errorCallback	Action
customData	object
return	void