PlayFab.ClientModels Namespace Reference

Classes
class	AcceptTradeRequest
class	AcceptTradeResponse
class	AdCampaignAttributionModel
class	AddFriendRequest
class	AddFriendResult
class	AddGenericIDRequest
class	AddGenericIDResult
class	AddOrUpdateContactEmailRequest
	This API adds a contact email to the player's profile. If the player's profile already contains a contact email, it will update the contact email to the email address specified. More...
class	AddOrUpdateContactEmailResult
class	AddSharedGroupMembersRequest
class	AddSharedGroupMembersResult
class	AddUsernamePasswordRequest
class	AddUsernamePasswordResult
	Each account must have a unique username and email address in the PlayFab service. Once created, the account may be associated with additional accounts (Steam, Facebook, Game Center, etc.), allowing for added social network lists and achievements systems. This can also be used to provide a recovery method if the user loses their original means of access. More...
class	AddUserVirtualCurrencyRequest
	This API must be enabled for use as an option in the game manager website. It is disabled by default. More...
class	AdPlacementDetails
	A single ad placement details including placement and reward information. More...
class	AdRewardItemGranted
	Details for each item granted. More...
class	AdRewardResults
	Details on what was granted to the player. More...
class	AndroidDevicePushNotificationRegistrationRequest
	More information can be found on configuring your game for the Google Cloud Messaging service in the Google developer documentation, here: http://developer.android.com/google/gcm/client.html. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart. More...
class	AndroidDevicePushNotificationRegistrationResult
class	AttributeInstallRequest
	If you have an ad attribution partner enabled, this will post an install to their service to track the device. It uses the given device id to match based on clicks on ads. More...
class	AttributeInstallResult
class	CancelTradeRequest
class	CancelTradeResponse
class	CartItem
class	CatalogItem
	A purchasable item from the item catalog. More...
class	CatalogItemBundleInfo
class	CatalogItemConsumableInfo
class	CatalogItemContainerInfo
	Containers are inventory items that can hold other items defined in the catalog, as well as virtual currency, which is added to the player inventory when the container is unlocked, using the UnlockContainerItem API. The items can be anything defined in the catalog, as well as RandomResultTable objects which will be resolved when the container is unlocked. Containers and their keys should be defined as Consumable (having a limited number of uses) in their catalog defintiions, unless the intent is for the player to be able to re-use them infinitely. More...
class	CharacterInventory
class	CharacterLeaderboardEntry
class	CharacterResult
class	CollectionFilter
	Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. More...
class	ConfirmPurchaseRequest
	The final step in the purchasing process, this API finalizes the purchase with the payment provider, where applicable, adding virtual goods to the player inventory (including random drop table resolution and recursive addition of bundled items) and adjusting virtual currency balances for funds used or added. Note that this is a pull operation, and should be polled regularly when a purchase is in progress. Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation. More...
class	ConfirmPurchaseResult
	When the FailedByPaymentProvider error is returned, it's important to check the ProviderErrorCode, ProviderErrorMessage, and ProviderErrorDetails to understand the specific reason the payment was rejected, as in some rare cases, this may mean that the provider hasn't completed some operation required to finalize the purchase. More...
class	ConsumeItemRequest
class	ConsumeItemResult
class	ConsumeMicrosoftStoreEntitlementsRequest
class	ConsumeMicrosoftStoreEntitlementsResponse
class	ConsumePS5EntitlementsRequest
class	ConsumePS5EntitlementsResult
class	ConsumePSNEntitlementsRequest
class	ConsumePSNEntitlementsResult
class	ConsumeXboxEntitlementsRequest
class	ConsumeXboxEntitlementsResult
class	ContactEmailInfoModel
class	Container_Dictionary_String_String
	A data container. More...
class	CreateSharedGroupRequest
	If SharedGroupId is specified, the service will attempt to create a group with that identifier, and will return an error if it is already in use. If no SharedGroupId is specified, a random identifier will be assigned. More...
class	CreateSharedGroupResult
class	CurrentGamesRequest
class	CurrentGamesResult
class	DeviceInfoRequest
	Any arbitrary information collected by the device. More...
class	EmptyResponse
class	EmptyResult
class	EntityKey
	Combined entity type and ID structure which uniquely identifies a single entity. More...
class	EntityTokenResponse
class	ExecuteCloudScriptRequest
class	ExecuteCloudScriptResult
class	FacebookInstantGamesPlayFabIdPair
class	FacebookPlayFabIdPair
class	FriendInfo
class	GameCenterPlayFabIdPair
class	GameInfo
class	GameServerRegionsRequest
class	GameServerRegionsResult
class	GenericPlayFabIdPair
class	GenericServiceId
class	GetAccountInfoRequest
class	GetAccountInfoResult
	This API retrieves details regarding the player in the PlayFab service. Note that when this call is used to retrieve data about another player (not the one signed into the local client), some data, such as Personally Identifying Information (PII), will be omitted for privacy reasons or to comply with the requirements of the platform belongs to. The user account returned will be based on the identifier provided in priority order: PlayFabId, Username, Email, then TitleDisplayName. If no identifier is specified, the currently signed in user's information will be returned. More...
class	GetAdPlacementsRequest
	Using an AppId to return a list of valid ad placements for a player. More...
class	GetAdPlacementsResult
	Array of AdPlacementDetails. More...
class	GetCatalogItemsRequest
class	GetCatalogItemsResult
	If CatalogVersion is not specified, only inventory items associated with the most recent version of the catalog will be returned. More...
class	GetCharacterDataRequest
	Data is stored as JSON key-value pairs. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom character data will be returned. More...
class	GetCharacterDataResult
class	GetCharacterInventoryRequest
	All items currently in the character inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. Also returns their virtual currency balances. More...
class	GetCharacterInventoryResult
class	GetCharacterLeaderboardRequest
class	GetCharacterLeaderboardResult
	Note that the Position of the character in the results is for the overall leaderboard. More...
class	GetCharacterStatisticsRequest
class	GetCharacterStatisticsResult
	In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab. More...
class	GetContentDownloadUrlRequest
class	GetContentDownloadUrlResult
class	GetFriendLeaderboardAroundPlayerRequest
class	GetFriendLeaderboardAroundPlayerResult
	Note: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic.If Facebook friends are included, make sure the access token from previous LoginWithFacebook call is still valid and not expired. If Xbox Live friends are included, make sure the access token from the previous LoginWithXbox call is still valid and not expired. More...
class	GetFriendLeaderboardRequest
class	GetFriendsListRequest
class	GetFriendsListResult
	If any additional services are queried for the user's friends, those friends who also have a PlayFab account registered for the title will be returned in the results. For Facebook, user has to have logged into the title's Facebook app recently, and only friends who also plays this game will be included. For Xbox Live, user has to have logged into the Xbox Live recently, and only friends who also play this game will be included. More...
class	GetLeaderboardAroundCharacterRequest
class	GetLeaderboardAroundCharacterResult
	Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic. More...
class	GetLeaderboardAroundPlayerRequest
class	GetLeaderboardAroundPlayerResult
	Note: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have the corresponding statistic. More...
class	GetLeaderboardForUsersCharactersRequest
class	GetLeaderboardForUsersCharactersResult
	NOTE: The position of the character in the results is relative to the other characters for that specific user. This mean the values will always be between 0 and one less than the number of characters returned regardless of the size of the actual leaderboard. More...
class	GetLeaderboardRequest
class	GetLeaderboardResult
	Note that the Position of the user in the results is for the overall leaderboard. If Facebook friends are included, make sure the access token from previous LoginWithFacebook call is still valid and not expired. If Xbox Live friends are included, make sure the access token from the previous LoginWithXbox call is still valid and not expired. More...
class	GetPaymentTokenRequest
class	GetPaymentTokenResult
class	GetPhotonAuthenticationTokenRequest
class	GetPhotonAuthenticationTokenResult
class	GetPlayerCombinedInfoRequest
class	GetPlayerCombinedInfoRequestParams
class	GetPlayerCombinedInfoResult
	Returns whatever info is requested in the response for the user. If no user is explicitly requested this defaults to the authenticated user. If the user is the same as the requester, PII (like email address, facebook id) is returned if available. Otherwise, only public information is returned. All parameters default to false. More...
class	GetPlayerCombinedInfoResultPayload
class	GetPlayerProfileRequest
	This API allows for access to details regarding a user in the PlayFab service, usually for purposes of customer support. Note that data returned may be Personally Identifying Information (PII), such as email address, and so care should be taken in how this data is stored and managed. Since this call will always return the relevant information for users who have accessed the title, the recommendation is to not store this data locally. More...
class	GetPlayerProfileResult
class	GetPlayerSegmentsRequest
class	GetPlayerSegmentsResult
class	GetPlayerStatisticsRequest
class	GetPlayerStatisticsResult
	In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab. More...
class	GetPlayerStatisticVersionsRequest
class	GetPlayerStatisticVersionsResult
class	GetPlayerTagsRequest
	This API will return a list of canonical tags which includes both namespace and tag's name. If namespace is not provided, the result is a list of all canonical tags. TagName can be used for segmentation and Namespace is limited to 128 characters. More...
class	GetPlayerTagsResult
class	GetPlayerTradesRequest
class	GetPlayerTradesResponse
class	GetPlayFabIDsFromFacebookIDsRequest
class	GetPlayFabIDsFromFacebookIDsResult
	For Facebook identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromFacebookInstantGamesIdsRequest
class	GetPlayFabIDsFromFacebookInstantGamesIdsResult
	For Facebook Instant Game identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromGameCenterIDsRequest
class	GetPlayFabIDsFromGameCenterIDsResult
	For Game Center identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromGenericIDsRequest
class	GetPlayFabIDsFromGenericIDsResult
	For generic service identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromGoogleIDsRequest
class	GetPlayFabIDsFromGoogleIDsResult
	For Google identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromKongregateIDsRequest
class	GetPlayFabIDsFromKongregateIDsResult
	For Kongregate identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest
class	GetPlayFabIDsFromNintendoSwitchDeviceIdsResult
	For Nintendo Switch identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromPSNAccountIDsRequest
class	GetPlayFabIDsFromPSNAccountIDsResult
	For PlayStation Network identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromSteamIDsRequest
class	GetPlayFabIDsFromSteamIDsResult
	For Steam identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromTwitchIDsRequest
class	GetPlayFabIDsFromTwitchIDsResult
	For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPlayFabIDsFromXboxLiveIDsRequest
class	GetPlayFabIDsFromXboxLiveIDsResult
	For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned. More...
class	GetPublisherDataRequest
	This API is designed to return publisher-specific values which can be read, but not written to, by the client. This data is shared across all titles assigned to a particular publisher, and can be used for cross-game coordination. Only titles assigned to a publisher can use this API. For more information email hello.nosp@m.play.nosp@m.fab@m.nosp@m.icro.nosp@m.soft..nosp@m.com. Note that there may up to a minute delay in between updating title data and this API call returning the newest value. More...
class	GetPublisherDataResult
class	GetPurchaseRequest
class	GetPurchaseResult
class	GetSegmentResult
class	GetSharedGroupDataRequest
class	GetSharedGroupDataResult
class	GetStoreItemsRequest
	A store contains an array of references to items defined in one or more catalog versions of the game, along with the prices for the item, in both real world and virtual currencies. These prices act as an override to any prices defined in the catalog. In this way, the base definitions of the items may be defined in the catalog, with all associated properties, while the pricing can be set for each store, as needed. This allows for subsets of goods to be defined for different purposes (in order to simplify showing some, but not all catalog items to users, based upon different characteristics), along with unique prices. Note that all prices defined in the catalog and store definitions for the item are considered valid, and that a compromised client can be made to send a request for an item based upon any of these definitions. If no price is specified in the store for an item, the price set in the catalog should be displayed to the user. More...
class	GetStoreItemsResult
class	GetTimeRequest
	This query retrieves the current time from one of the servers in PlayFab. Please note that due to clock drift between servers, there is a potential variance of up to 5 seconds. More...
class	GetTimeResult
	Time is always returned as Coordinated Universal Time (UTC). More...
class	GetTitleDataRequest
	This API is designed to return title specific values which can be read, but not written to, by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. If the player belongs to an experiment variant that uses title data overrides, the overrides are applied automatically and returned with the title data. Note that there may up to a minute delay in between updating title data and this API call returning the newest value. More...
class	GetTitleDataResult
class	GetTitleNewsRequest
class	GetTitleNewsResult
class	GetTitlePublicKeyRequest
	An RSA CSP blob to be used to encrypt the payload of account creation requests when that API requires a signature header. For example if Client/LoginWithCustomId requires signature headers but the player does not have an account yet follow these steps: 1) Call Client/GetTitlePublicKey with one of the title's shared secrets. 2) Convert the Base64 encoded CSP blob to a byte array and create an RSA signing object. 3) Encrypt the UTF8 encoded JSON body of the registration request and place the Base64 encoded result into the EncryptedRequest and with the TitleId field, all other fields can be left empty when performing the API request. 4) Client receives authentication token as normal. Future requests to LoginWithCustomId will require the X-PlayFab-Signature header. More...
class	GetTitlePublicKeyResult
class	GetTradeStatusRequest
class	GetTradeStatusResponse
class	GetUserDataRequest
	Data is stored as JSON key-value pairs. Every time the data is updated via any source, the version counter is incremented. If the Version parameter is provided, then this call will only return data if the current version on the system is greater than the value provided. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom user data will be returned. More...
class	GetUserDataResult
class	GetUserInventoryRequest
class	GetUserInventoryResult
	All items currently in the user inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. More...
class	GooglePlayFabIdPair
class	GrantCharacterToUserRequest
	Grants a character to the user of the type specified by the item ID. The user must already have an instance of this item in their inventory in order to allow character creation. This item can come from a purchase or grant, which must be done before calling to create the character. More...
class	GrantCharacterToUserResult
class	ItemInstance
	A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase. More...
class	ItemPurchaseRequest
class	KongregatePlayFabIdPair
class	LinkAndroidDeviceIDRequest
class	LinkAndroidDeviceIDResult
class	LinkAppleRequest
class	LinkCustomIDRequest
class	LinkCustomIDResult
class	LinkedPlatformAccountModel
class	LinkFacebookAccountRequest
	Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID. More...
class	LinkFacebookAccountResult
class	LinkFacebookInstantGamesIdRequest
class	LinkFacebookInstantGamesIdResult
class	LinkGameCenterAccountRequest
class	LinkGameCenterAccountResult
class	LinkGoogleAccountRequest
	Google sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google sign-in for Android APIs on the device and passing it to this API. More...
class	LinkGoogleAccountResult
class	LinkIOSDeviceIDRequest
class	LinkIOSDeviceIDResult
class	LinkKongregateAccountRequest
class	LinkKongregateAccountResult
class	LinkNintendoServiceAccountRequest
class	LinkNintendoSwitchDeviceIdRequest
class	LinkNintendoSwitchDeviceIdResult
class	LinkOpenIdConnectRequest
class	LinkPSNAccountRequest
class	LinkPSNAccountResult
class	LinkSteamAccountRequest
	Steam authentication is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth (requires sign-in). NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Publisher Key in the PlayFab Game Manager (under Properties). Information on creating a Publisher Key (referred to as the Secret Key in PlayFab) for your title can be found here: https://partner.steamgames.com/documentation/webapi#publisherkey. More...
class	LinkSteamAccountResult
class	LinkTwitchAccountRequest
class	LinkTwitchAccountResult
class	LinkXboxAccountRequest
class	LinkXboxAccountResult
class	ListUsersCharactersRequest
	Returns a list of every character that currently belongs to a user. More...
class	ListUsersCharactersResult
class	LocationModel
class	LoginResult
class	LoginWithAndroidDeviceIDRequest
	On Android devices, the recommendation is to use the Settings.Secure.ANDROID_ID as the AndroidDeviceId, as described in this blog post (http://android-developers.blogspot.com/2011/03/identifying-app-installations.html). More information on this identifier can be found in the Android documentation (http://developer.android.com/reference/android/provider/Settings.Secure.html). If this is the first time a user has signed in with the Android device and CreateAccount is set to true, a new PlayFab account will be created and linked to the Android device ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Android device, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. Please note that while multiple devices of this type can be linked to a single user account, only the one most recently used to login (or most recently linked) will be reflected in the user's account information. We will be updating to show all linked devices in a future release. More...
class	LoginWithAppleRequest
class	LoginWithCustomIDRequest
	It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. More...
class	LoginWithEmailAddressRequest
	Email address and password lengths are provided for information purposes. The server will validate that data passed in conforms to the field definition and report errors appropriately. It is recommended that developers not perform this validation locally, so that future updates do not require client updates. More...
class	LoginWithFacebookInstantGamesIdRequest
class	LoginWithFacebookRequest
	Facebook sign-in is accomplished using the Facebook User Access Token. More information on the Token can be found in the Facebook developer documentation (https://developers.facebook.com/docs/facebook-login/access-tokens/). In Unity, for example, the Token is available as AccessToken in the Facebook SDK ScriptableObject FB. If this is the first time a user has signed in with the Facebook account and CreateAccount is set to true, a new PlayFab account will be created and linked to the provided account's Facebook ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Facebook account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. Note that titles should never re-use the same Facebook applications between PlayFab Title IDs, as Facebook provides unique user IDs per application and doing so can result in issues with the Facebook ID for the user in their PlayFab account information. If you must re-use an application in a new PlayFab Title ID, please be sure to first unlink all accounts from Facebook, or delete all users in the first Title ID. More...
class	LoginWithGameCenterRequest
	The Game Center player identifier (https://developer.apple.com/library/ios/documentation/Accounts/Reference/ACAccountClassRef/index.html#//apple_ref/occ/instp/ACAccount/identifier) is a generated string which is stored on the local device. As with device identifiers, care must be taken to never expose a player's Game Center identifier to end users, as that could result in a user's account being compromised. If this is the first time a user has signed in with Game Center and CreateAccount is set to true, a new PlayFab account will be created and linked to the Game Center identifier. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Game Center account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. More...
class	LoginWithGoogleAccountRequest
	Google sign-in is accomplished by obtaining a Google OAuth 2.0 credential using the Google sign-in for Android APIs on the device and passing it to this API. If this is the first time a user has signed in with the Google account and CreateAccount is set to true, a new PlayFab account will be created and linked to the Google account. Otherwise, if no PlayFab account is linked to the Google account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. The current (recommended) method for obtaining a Google account credential in an Android application is to call GoogleSignInAccount.getServerAuthCode() and send the auth code as the ServerAuthCode parameter of this API. Before doing this, you must create an OAuth 2.0 web application client ID in the Google API Console and configure its client ID and secret in the PlayFab Game Manager Google Add-on for your title. This method does not require prompting of the user for additional Google account permissions, resulting in a user experience with the least possible friction. For more information about obtaining the server auth code, see https://developers.google.com/identity/sign-in/android/offline-access. The previous (deprecated) method was to obtain an OAuth access token by calling GetAccessToken() on the client and passing it as the AccessToken parameter to this API. for the with the Google OAuth 2.0 Access Token. More information on this change can be found in the Google developer documentation (https://android-developers.googleblog.com/2016/01/play-games-permissions-are-changing-in.html). More...
class	LoginWithIOSDeviceIDRequest
	On iOS devices, the identifierForVendor (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html#//apple_ref/occ/instp/UIDevice/identifierForVendor) must be used as the DeviceId, as the UIDevice uniqueIdentifier has been deprecated as of iOS 5, and use of the advertisingIdentifier for this purpose will result in failure of Apple's certification process. If this is the first time a user has signed in with the iOS device and CreateAccount is set to true, a new PlayFab account will be created and linked to the vendor-specific iOS device ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the iOS device, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. Please note that while multiple devices of this type can be linked to a single user account, only the one most recently used to login (or most recently linked) will be reflected in the user's account information. We will be updating to show all linked devices in a future release. More...
class	LoginWithKongregateRequest
	More details regarding Kongregate and their game authentication system can be found at http://developers.kongregate.com/docs/virtual-goods/authentication. Developers must provide the Kongregate user ID and auth token that are generated using the Kongregate client library. PlayFab will combine these identifiers with the title's unique Kongregate app ID to log the player into the Kongregate system. If CreateAccount is set to true and there is not already a user matched to this Kongregate ID, then PlayFab will create a new account for this user and link the ID. In this case, no email or username will be associated with the PlayFab account. If there is already a different PlayFab user linked with this account, then an error will be returned. More...
class	LoginWithNintendoServiceAccountRequest
class	LoginWithNintendoSwitchDeviceIdRequest
class	LoginWithOpenIdConnectRequest
class	LoginWithPlayFabRequest
	Username and password lengths are provided for information purposes. The server will validate that data passed in conforms to the field definition and report errors appropriately. It is recommended that developers not perform this validation locally, so that future updates to the username or password do not require client updates. More...
class	LoginWithPSNRequest
	If this is the first time a user has signed in with the PlayStation Network account and CreateAccount is set to true, a new PlayFab account will be created and linked to the PSN account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the PSN account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. More...
class	LoginWithSteamRequest
	Steam sign-in is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth (requires sign-in). NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Web API Key in the PlayFab Game Manager (under Steam in the Add-ons Marketplace). You can obtain a Web API Key from the Permissions page of any Group associated with your App ID in the Steamworks site. If this is the first time a user has signed in with the Steam account and CreateAccount is set to true, a new PlayFab account will be created and linked to the provided account's Steam ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Steam account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. More...
class	LoginWithTwitchRequest
	More details regarding Twitch and their authentication system can be found at https://github.com/justintv/Twitch-API/blob/master/authentication.md. Developers must provide the Twitch access token that is generated using one of the Twitch authentication flows. PlayFab will use the title's unique Twitch Client ID to authenticate the token and log in to the PlayFab system. If CreateAccount is set to true and there is not already a user matched to the Twitch username that generated the token, then PlayFab will create a new account for this user and link the ID. In this case, no email or username will be associated with the PlayFab account. If there is already a different PlayFab user linked with this account, then an error will be returned. More...
class	LoginWithXboxRequest
	If this is the first time a user has signed in with the Xbox Live account and CreateAccount is set to true, a new PlayFab account will be created and linked to the Xbox Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Xbox Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. More...
class	LogStatement
class	MatchmakeRequest
class	MatchmakeResult
class	MembershipModel
class	MicrosoftStorePayload
class	ModifyUserVirtualCurrencyResult
class	NameIdentifier
	Identifier by either name or ID. Note that a name may change due to renaming, or reused after being deleted. ID is immutable and unique. More...
class	NintendoSwitchPlayFabIdPair
class	OpenTradeRequest
class	OpenTradeResponse
class	PayForPurchaseRequest
	This is the second step in the purchasing process, initiating the purchase transaction with the payment provider (if applicable). For payment provider scenarios, the title should next present the user with the payment provider'sinterface for payment. Once the player has completed the payment with the provider, the title should call ConfirmPurchase tofinalize the process and add the appropriate items to the player inventory. More...
class	PayForPurchaseResult
	For web-based payment providers, this operation returns the URL to which the user should be directed inorder to approve the purchase. Items added to the user inventory as a result of this operation will be marked as unconfirmed. More...
class	PaymentOption
class	PlayerLeaderboardEntry
class	PlayerProfileModel
class	PlayerProfileViewConstraints
class	PlayerStatisticVersion
class	PlayStation5Payload
class	PSNAccountPlayFabIdPair
class	PurchaseItemRequest
	Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add). More...
class	PurchaseItemResult
class	PurchaseReceiptFulfillment
class	PushNotificationRegistrationModel
class	RedeemCouponRequest
	Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error. More...
class	RedeemCouponResult
class	RefreshPSNAuthTokenRequest
class	RegionInfo
class	RegisterForIOSPushNotificationRequest
	The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart. More...
class	RegisterForIOSPushNotificationResult
class	RegisterPlayFabUserRequest
class	RegisterPlayFabUserResult
	Each account must have a unique email address in the PlayFab service. Once created, the account may be associated with additional accounts (Steam, Facebook, Game Center, etc.), allowing for added social network lists and achievements systems. More...
class	RemoveContactEmailRequest
	This API removes an existing contact email from the player's profile. More...
class	RemoveContactEmailResult
class	RemoveFriendRequest
class	RemoveFriendResult
class	RemoveGenericIDRequest
class	RemoveGenericIDResult
class	RemoveSharedGroupMembersRequest
class	RemoveSharedGroupMembersResult
class	ReportAdActivityRequest
	Report ad activity. More...
class	ReportAdActivityResult
	Report ad activity response has no body. More...
class	ReportPlayerClientRequest
class	ReportPlayerClientResult
	Players are currently limited to five reports per day. Attempts by a single user account to submit reports beyond five will result in Updated being returned as false. More...
class	RestoreIOSPurchasesRequest
	The title should obtain a refresh receipt via restoreCompletedTransactions in the SKPaymentQueue of the Apple StoreKit and pass that in to this call. The resultant receipt contains new receipt instances for all non-consumable goods previously purchased by the user. This API call iterates through every purchase in the receipt and restores the items if they still exist in the catalog and can be validated. More...
class	RestoreIOSPurchasesResult
	Once verified, the valid items will be restored into the user's inventory. More...
class	RewardAdActivityRequest
	Details on which placement and reward to perform a grant on. More...
class	RewardAdActivityResult
	Result for rewarding an ad activity. More...
class	ScriptExecutionError
class	SendAccountRecoveryEmailRequest
	If the account in question is a "temporary" account (for example, one that was created via a call to LoginFromIOSDeviceID), thisfunction will have no effect. Only PlayFab accounts which have valid email addresses will be able to receive a password reset email using this API. More...
class	SendAccountRecoveryEmailResult
class	SetFriendTagsRequest
	This operation is not additive. It will completely replace the tag list for the specified user. Please note that only users in the PlayFab friends list can be assigned tags. Attempting to set a tag on a friend only included in the friends list from a social site integration (such as Facebook or Steam) will return the AccountNotFound error. More...
class	SetFriendTagsResult
class	SetPlayerSecretRequest
	APIs that require signatures require that the player have a configured Player Secret Key that is used to sign all requests. Players that don't have a secret will be blocked from making API calls until it is configured. To create a signature header add a SHA256 hashed string containing UTF8 encoded JSON body as it will be sent to the server, the current time in UTC formatted to ISO 8601, and the players secret formatted as 'body.date.secret'. Place the resulting hash into the header X-PlayFab-Signature, along with a header X-PlayFab-Timestamp of the same UTC timestamp used in the signature. More...
class	SetPlayerSecretResult
class	SharedGroupDataRecord
class	StartGameRequest
	This API must be enabled for use as an option in the game manager website. It is disabled by default. More...
class	StartGameResult
class	StartPurchaseRequest
	This is the first step in the purchasing process. For security purposes, once the order (or "cart") has been created, additional inventory objects may no longer be added. In addition, inventory objects will be locked to the current prices, regardless of any subsequent changes at the catalog level which may occur during the next two steps. More...
class	StartPurchaseResult
class	StatisticModel
class	StatisticNameVersion
class	StatisticUpdate
class	StatisticValue
class	SteamPlayFabIdPair
class	StoreItem
	A store entry that list a catalog item at a particular price. More...
class	StoreMarketingModel
	Marketing data about a specific store. More...
class	SubscriptionModel
class	SubtractUserVirtualCurrencyRequest
	This API must be enabled for use as an option in the game manager website. It is disabled by default. More...
class	TagModel
class	TitleNewsItem
class	TradeInfo
class	TreatmentAssignment
class	TwitchPlayFabIdPair
class	UnlinkAndroidDeviceIDRequest
class	UnlinkAndroidDeviceIDResult
class	UnlinkAppleRequest
class	UnlinkCustomIDRequest
class	UnlinkCustomIDResult
class	UnlinkFacebookAccountRequest
class	UnlinkFacebookAccountResult
class	UnlinkFacebookInstantGamesIdRequest
class	UnlinkFacebookInstantGamesIdResult
class	UnlinkGameCenterAccountRequest
class	UnlinkGameCenterAccountResult
class	UnlinkGoogleAccountRequest
class	UnlinkGoogleAccountResult
class	UnlinkIOSDeviceIDRequest
class	UnlinkIOSDeviceIDResult
class	UnlinkKongregateAccountRequest
class	UnlinkKongregateAccountResult
class	UnlinkNintendoServiceAccountRequest
class	UnlinkNintendoSwitchDeviceIdRequest
class	UnlinkNintendoSwitchDeviceIdResult
class	UnlinkOpenIdConnectRequest
class	UnlinkPSNAccountRequest
class	UnlinkPSNAccountResult
class	UnlinkSteamAccountRequest
class	UnlinkSteamAccountResult
class	UnlinkTwitchAccountRequest
class	UnlinkTwitchAccountResult
class	UnlinkXboxAccountRequest
class	UnlinkXboxAccountResult
class	UnlockContainerInstanceRequest
	Specify the container and optionally the catalogVersion for the container to open. More...
class	UnlockContainerItemRequest
	Specify the type of container to open and optionally the catalogVersion for the container to open. More...
class	UnlockContainerItemResult
	The items and vc found within the container. These will be added and stacked in the appropriate inventory. More...
class	UpdateAvatarUrlRequest
class	UpdateCharacterDataRequest
	This function performs an additive update of the arbitrary strings containing the custom data for the character. In updating the custom data object, keys which already exist in the object will have their values overwritten, while keys with null values will be removed. New keys will be added, with the given values. No other key-value pairs will be changed apart from those specified in the call. More...
class	UpdateCharacterDataResult
class	UpdateCharacterStatisticsRequest
	Enable this option with the 'Allow Client to Post Player Statistics' option in PlayFab GameManager for your title. However, this is not best practice, as this data will no longer be safely controlled by the server. This operation is additive. Character Statistics not currently defined will be added, while those already defined will be updated with the given values. All other user statistics will remain unchanged. Character statistics are used by the character-leaderboard apis, and accessible for custom game-logic. More...
class	UpdateCharacterStatisticsResult
class	UpdatePlayerStatisticsRequest
	Enable this option with the 'Allow Client to Post Player Statistics' option in PlayFab GameManager for your title. However, this is not best practice, as this data will no longer be safely controlled by the server. This operation is additive. Statistics not currently defined will be added, while those already defined will be updated with the given values. All other user statistics will remain unchanged. Note that if the statistic is intended to have a reset period, the UpdatePlayerStatisticDefinition API call can be used to define that reset period. Once a statistic has been versioned (reset), the now-previous version can still be written to for up a short, pre-defined period (currently 10 seconds), using the Version parameter in this call. More...
class	UpdatePlayerStatisticsResult
class	UpdateSharedGroupDataRequest
	Note that in the case of multiple calls to write to the same shared group data keys, the last write received by the PlayFab service will determine the value available to subsequent read operations. For scenarios requiring coordination of data updates, it is recommended that titles make use of user data with read permission set to public, or a combination of user data and shared group data. More...
class	UpdateSharedGroupDataResult
class	UpdateUserDataRequest
	This function performs an additive update of the arbitrary strings containing the custom data for the user. In updating the custom data object, keys which already exist in the object will have their values overwritten, while keys with null values will be removed. New keys will be added, with the given values. No other key-value pairs will be changed apart from those specified in the call. More...
class	UpdateUserDataResult
class	UpdateUserTitleDisplayNameRequest
	In addition to the PlayFab username, titles can make use of a DisplayName which is also a unique identifier, but specific to the title. This allows for unique names which more closely match the theme or genre of a title, for example. More...
class	UpdateUserTitleDisplayNameResult
class	UserAccountInfo
class	UserAndroidDeviceInfo
class	UserAppleIdInfo
class	UserCustomIdInfo
class	UserDataRecord
class	UserFacebookInfo
class	UserFacebookInstantGamesIdInfo
class	UserGameCenterInfo
class	UserGoogleInfo
class	UserIosDeviceInfo
class	UserKongregateInfo
class	UserNintendoSwitchAccountIdInfo
class	UserNintendoSwitchDeviceIdInfo
class	UserOpenIdInfo
class	UserPrivateAccountInfo
class	UserPsnInfo
class	UserSettings
class	UserSteamInfo
class	UserTitleInfo
class	UserTwitchInfo
class	UserXboxInfo
class	ValidateAmazonReceiptRequest
class	ValidateAmazonReceiptResult
	Once verified, the catalog item matching the Amazon item name will be added to the user's inventory. More...
class	ValidateGooglePlayPurchaseRequest
	The packageName and productId are defined in the GooglePlay store. The productId must match the ItemId of the inventory item in the PlayFab catalog for the title. This enables the PlayFab service to securely validate that the purchase is for the correct item, in order to prevent uses from passing valid receipts as being for more expensive items (passing a receipt for a 99-cent purchase as being for a $19.99 purchase, for example). Each receipt may be validated only once to avoid granting the same item over and over from a single purchase. More...
class	ValidateGooglePlayPurchaseResult
	Once verified, the catalog item (ItemId) matching the GooglePlay store item (productId) will be added to the user's inventory. More...
class	ValidateIOSReceiptRequest
	The CurrencyCode and PurchasePrice must match the price which was set up for the item in the Apple store. In addition, The ItemId of the inventory in the PlayFab Catalog must match the Product ID as it was set up in the Apple store. This enables the PlayFab service to securely validate that the purchase is for the correct item, in order to prevent uses from passing valid receipts as being for more expensive items (passing a receipt for a 99-cent purchase as being for a $19.99 purchase, for example). More...
class	ValidateIOSReceiptResult
	Once verified, the catalog item matching the iTunes item name will be added to the user's inventory. More...
class	ValidateWindowsReceiptRequest
class	ValidateWindowsReceiptResult
	Once verified, the catalog item matching the Product name will be added to the user's inventory. More...
class	ValueToDateModel
class	Variable
class	VirtualCurrencyRechargeTime
class	WriteClientCharacterEventRequest
	This API is designed to write a multitude of different client-defined events into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title and player. More...
class	WriteClientPlayerEventRequest
	This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any player-based event. The created event will be locked to the authenticated title and player. More...
class	WriteEventResponse
class	WriteTitleEventRequest
	This API is designed to write a multitude of different client-defined events into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any title-based event. The created event will be locked to the authenticated title. More...
class	XboxLiveAccountPlayFabIdPair

Enumerations
enum	AdActivity { Opened , Closed , Start , End }
enum	CloudScriptRevisionOption { Live , Latest , Specific }
enum	ContinentCode {   AF , AN , AS , EU ,   NA , OC , SA }
enum	CountryCode {   AF , AX , AL , DZ ,   AS , AD , AO , AI ,   AQ , AG , AR , AM ,   AW , AU , AT , AZ ,   BS , BH , BD , BB ,   BY , BE , BZ , BJ ,   BM , BT , BO , BQ ,   BA , BW , BV , BR ,   IO , BN , BG , BF ,   BI , KH , CM , CA ,   CV , KY , CF , TD ,   CL , CN , CX , CC ,   CO , KM , CG , CD ,   CK , CR , CI , HR ,   CU , CW , CY , CZ ,   DK , DJ , DM , DO ,   EC , EG , SV , GQ ,   ER , EE , ET , FK ,   FO , FJ , FI , FR ,   GF , PF , TF , GA ,   GM , GE , DE , GH ,   GI , GR , GL , GD ,   GP , GU , GT , GG ,   GN , GW , GY , HT ,   HM , VA , HN , HK ,   HU , IS , IN , ID ,   IR , IQ , IE , IM ,   IL , IT , JM , JP ,   JE , JO , KZ , KE ,   KI , KP , KR , KW ,   KG , LA , LV , LB ,   LS , LR , LY , LI ,   LT , LU , MO , MK ,   MG , MW , MY , MV ,   ML , MT , MH , MQ ,   MR , MU , YT , MX ,   FM , MD , MC , MN ,   ME , MS , MA , MZ ,   MM , NA , NR , NP ,   NL , NC , NZ , NI ,   NE , NG , NU , NF ,   MP , NO , OM , PK ,   PW , PS , PA , PG ,   PY , PE , PH , PN ,   PL , PT , PR , QA ,   RE , RO , RU , RW ,   BL , SH , KN , LC ,   MF , PM , VC , WS ,   SM , ST , SA , SN ,   RS , SC , SL , SG ,   SX , SK , SI , SB ,   SO , ZA , GS , SS ,   ES , LK , SD , SR ,   SJ , SZ , SE , CH ,   SY , TW , TJ , TZ ,   TH , TL , TG , TK ,   TO , TT , TN , TR ,   TM , TC , TV , UG ,   UA , AE , GB , US ,   UM , UY , UZ , VU ,   VE , VN , VG , VI ,   WF , EH , YE , ZM ,   ZW }
enum	Currency {   AED , AFN , ALL , AMD ,   ANG , AOA , ARS , AUD ,   AWG , AZN , BAM , BBD ,   BDT , BGN , BHD , BIF ,   BMD , BND , BOB , BRL ,   BSD , BTN , BWP , BYR ,   BZD , CAD , CDF , CHF ,   CLP , CNY , COP , CRC ,   CUC , CUP , CVE , CZK ,   DJF , DKK , DOP , DZD ,   EGP , ERN , ETB , EUR ,   FJD , FKP , GBP , GEL ,   GGP , GHS , GIP , GMD ,   GNF , GTQ , GYD , HKD ,   HNL , HRK , HTG , HUF ,   IDR , ILS , IMP , INR ,   IQD , IRR , ISK , JEP ,   JMD , JOD , JPY , KES ,   KGS , KHR , KMF , KPW ,   KRW , KWD , KYD , KZT ,   LAK , LBP , LKR , LRD ,   LSL , LYD , MAD , MDL ,   MGA , MKD , MMK , MNT ,   MOP , MRO , MUR , MVR ,   MWK , MXN , MYR , MZN ,   NAD , NGN , NIO , NOK ,   NPR , NZD , OMR , PAB ,   PEN , PGK , PHP , PKR ,   PLN , PYG , QAR , RON ,   RSD , RUB , RWF , SAR ,   SBD , SCR , SDG , SEK ,   SGD , SHP , SLL , SOS ,   SPL , SRD , STD , SVC ,   SYP , SZL , THB , TJS ,   TMT , TND , TOP , TRY ,   TTD , TVD , TWD , TZS ,   UAH , UGX , USD , UYU ,   UZS , VEF , VND , VUV ,   WST , XAF , XCD , XDR ,   XOF , XPF , YER , ZAR ,   ZMW , ZWD }
enum	EmailVerificationStatus { Unverified , Pending , Confirmed }
enum	GameInstanceState { Open , Closed }
enum	LoginIdentityProvider {   Unknown , PlayFab , Custom , GameCenter ,   GooglePlay , Steam , XBoxLive , PSN ,   Kongregate , Facebook , IOSDevice , AndroidDevice ,   Twitch , WindowsHello , GameServer , CustomServer ,   NintendoSwitch , FacebookInstantGames , OpenIdConnect , Apple ,   NintendoSwitchAccount }
enum	MatchmakeStatus {   Complete , Waiting , GameNotFound , NoAvailableSlots ,   SessionClosed }
enum	PushNotificationPlatform { ApplePushNotificationService , GoogleCloudMessaging }
enum	Region {   USCentral , USEast , EUWest , Singapore ,   Japan , Brazil , Australia }
enum	SourceType {   Admin , BackEnd , GameClient , GameServer ,   Partner , Custom , API }
enum	SubscriptionProviderStatus {   NoError , Cancelled , UnknownError , BillingError ,   ProductUnavailable , CustomerDidNotAcceptPriceChange , FreeTrial , PaymentPending }
enum	TitleActivationStatus {   None , ActivatedTitleKey , PendingSteam , ActivatedSteam ,   RevokedSteam }
enum	TradeStatus {   Invalid , Opening , Open , Accepting ,   Accepted , Filled , Cancelled }
enum	TransactionStatus {   CreateCart , Init , Approved , Succeeded ,   FailedByProvider , DisputePending , RefundPending , Refunded ,   RefundFailed , ChargedBack , FailedByUber , FailedByPlayFab ,   Revoked , TradePending , Traded , Upgraded ,   StackPending , Stacked , Other , Failed }
enum	UserDataPermission { Private , Public }
	Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.
enum	UserOrigination {   Organic , Steam , Google , Amazon ,   Facebook , Kongregate , GamersFirst , Unknown ,   IOS , LoadTest , Android , PSN ,   GameCenter , CustomId , XboxLive , Parse ,   Twitch , ServerCustomId , NintendoSwitchDeviceId , FacebookInstantGamesId ,   OpenIdConnect , Apple , NintendoSwitchAccount }