#if ENABLE_PLAYFABSERVER_API using System; using System.Collections.Generic; using PlayFab.SharedModels; namespace PlayFab.ServerModels { [Serializable] public class AdCampaignAttribution : PlayFabBaseModel { /// /// UTC time stamp of attribution /// public DateTime AttributedAt; /// /// Attribution campaign identifier /// public string CampaignId; /// /// Attribution network name /// public string Platform; } [Serializable] public class AdCampaignAttributionModel : PlayFabBaseModel { /// /// UTC time stamp of attribution /// public DateTime AttributedAt; /// /// Attribution campaign identifier /// public string CampaignId; /// /// Attribution network name /// public string Platform; } [Serializable] public class AddCharacterVirtualCurrencyRequest : PlayFabRequestCommon { /// /// Amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32 /// (2,147,483,647). Any increase over this value will be discarded. /// public int Amount; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// PlayFab unique identifier of the user whose virtual currency balance is to be incremented. /// public string PlayFabId; /// /// Name of the virtual currency which is to be incremented. /// public string VirtualCurrency; } [Serializable] public class AddFriendRequest : PlayFabRequestCommon { /// /// Email address of the user being added. /// public string FriendEmail; /// /// The PlayFab identifier of the user being added. /// public string FriendPlayFabId; /// /// Title-specific display name of the user to being added. /// public string FriendTitleDisplayName; /// /// The PlayFab username of the user being added /// public string FriendUsername; /// /// PlayFab identifier of the player to add a new friend. /// public string PlayFabId; } [Serializable] public class AddGenericIDRequest : PlayFabRequestCommon { /// /// Generic service identifier to add to the player account. /// public GenericServiceId GenericId; /// /// PlayFabId of the user to link. /// public string PlayFabId; } /// /// This API will trigger a player_tag_added event and add a tag with the given TagName and PlayFabID to the corresponding /// player profile. TagName can be used for segmentation and it is limited to 256 characters. Also there is a limit on the /// number of tags a title can have. /// [Serializable] public class AddPlayerTagRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Unique tag for player profile. /// public string TagName; } [Serializable] public class AddPlayerTagResult : PlayFabResultCommon { } [Serializable] public class AddSharedGroupMembersRequest : PlayFabRequestCommon { /// /// An array of unique PlayFab assigned ID of the user on whom the operation will be performed. /// public List PlayFabIds; /// /// Unique identifier for the shared group. /// public string SharedGroupId; } [Serializable] public class AddSharedGroupMembersResult : PlayFabResultCommon { } [Serializable] public class AddUserVirtualCurrencyRequest : PlayFabRequestCommon { /// /// Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). /// Any increase over this value will be discarded. /// public int Amount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// PlayFab unique identifier of the user whose virtual currency balance is to be increased. /// public string PlayFabId; /// /// Name of the virtual currency which is to be incremented. /// public string VirtualCurrency; } [Serializable] public class AdvancedPushPlatformMsg : PlayFabBaseModel { /// /// Stops GoogleCloudMessaging notifications from including both notification and data properties and instead only sends the /// data property. /// public bool? GCMDataOnly; /// /// The Json the platform should receive. /// public string Json; /// /// The platform that should receive the Json. /// public PushNotificationPlatform Platform; } /// /// 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. /// [Serializable] public class AuthenticateSessionTicketRequest : PlayFabRequestCommon { /// /// Session ticket as issued by a PlayFab client login API. /// public string SessionTicket; } [Serializable] public class AuthenticateSessionTicketResult : PlayFabResultCommon { /// /// Indicates if token was expired at request time. /// public bool? IsSessionTicketExpired; /// /// Account info for the user whose session ticket was supplied. /// public UserAccountInfo UserInfo; } [Serializable] public class AwardSteamAchievementItem : PlayFabBaseModel { /// /// Unique Steam achievement name. /// public string AchievementName; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Result of the award attempt (only valid on response, not on request). /// public bool Result; } [Serializable] public class AwardSteamAchievementRequest : PlayFabRequestCommon { /// /// Array of achievements to grant and the users to whom they are to be granted. /// public List Achievements; } [Serializable] public class AwardSteamAchievementResult : PlayFabResultCommon { /// /// Array of achievements granted. /// public List AchievementResults; } /// /// Contains information for a ban. /// [Serializable] public class BanInfo : PlayFabBaseModel { /// /// The active state of this ban. Expired bans may still have this value set to true but they will have no effect. /// public bool Active; /// /// The unique Ban Id associated with this ban. /// public string BanId; /// /// The time when this ban was applied. /// public DateTime? Created; /// /// The time when this ban expires. Permanent bans do not have expiration date. /// public DateTime? Expires; /// /// The IP address on which the ban was applied. May affect multiple players. /// public string IPAddress; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// The reason why this ban was applied. /// public string Reason; /// /// The family type of the suer that is included in the ban. /// public string UserFamilyType; } /// /// Represents a single ban request. /// [Serializable] public class BanRequest : PlayFabBaseModel { /// /// The duration in hours for the ban. Leave this blank for a permanent ban. /// public uint? DurationInHours; /// /// IP address to be banned. May affect multiple players. /// public string IPAddress; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// The reason for this ban. Maximum 140 characters. /// public string Reason; /// /// The family type of the user that should be included in the ban if applicable. May affect multiple players. /// public UserFamilyType? UserFamilyType; } /// /// The existence of each user will not be verified. When banning by IP or MAC address, multiple players may be affected, so /// use this feature with caution. Returns information about the new bans. /// [Serializable] public class BanUsersRequest : PlayFabRequestCommon { /// /// List of ban requests to be applied. Maximum 100. /// public List Bans; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; } [Serializable] public class BanUsersResult : PlayFabResultCommon { /// /// Information on the bans that were applied /// public List BanData; } /// /// A purchasable item from the item catalog /// [Serializable] public class CatalogItem : PlayFabBaseModel { /// /// defines the bundle properties for the item - bundles are items which contain other items, including random drop tables /// and virtual currencies /// public CatalogItemBundleInfo Bundle; /// /// if true, then an item instance of this type can be used to grant a character to a user. /// public bool CanBecomeCharacter; /// /// catalog version for this item /// public string CatalogVersion; /// /// defines the consumable properties (number of uses, timeout) for the item /// public CatalogItemConsumableInfo Consumable; /// /// defines the container properties for the item - what items it contains, including random drop tables and virtual /// currencies, and what item (if any) is required to open it via the UnlockContainerItem API /// public CatalogItemContainerInfo Container; /// /// game specific custom data /// public string CustomData; /// /// text description of item, to show in-game /// public string Description; /// /// text name for the item, to show in-game /// public string DisplayName; /// /// If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited /// edition item, this value determines the total number of instances to allocate for the title. Once this limit has been /// reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of /// false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less /// than zero, it will be ignored. /// public int InitialLimitedEditionCount; /// /// BETA: If true, then only a fixed number can ever be granted. /// public bool IsLimitedEdition; /// /// if true, then only one item instance of this type will exist and its remaininguses will be incremented instead. /// RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded /// public bool IsStackable; /// /// if true, then an item instance of this type can be traded between players using the trading APIs /// public bool IsTradable; /// /// class to which the item belongs /// public string ItemClass; /// /// unique identifier for this item /// public string ItemId; /// /// URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP /// URL. /// public string ItemImageUrl; /// /// override prices for this item for specific currencies /// public Dictionary RealCurrencyPrices; /// /// list of item tags /// public List Tags; /// /// price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) /// public Dictionary VirtualCurrencyPrices; } [Serializable] public class CatalogItemBundleInfo : PlayFabBaseModel { /// /// unique ItemId values for all items which will be added to the player inventory when the bundle is added /// public List BundledItems; /// /// unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and /// add the relevant items to the player inventory when the bundle is added) /// public List BundledResultTables; /// /// virtual currency types and balances which will be added to the player inventory when the bundle is added /// public Dictionary BundledVirtualCurrencies; } [Serializable] public class CatalogItemConsumableInfo : PlayFabBaseModel { /// /// number of times this object can be used, after which it will be removed from the player inventory /// public uint? UsageCount; /// /// duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed /// (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on /// this item's details have completed) /// public uint? UsagePeriod; /// /// all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values /// added together, and share the result - when that period has elapsed, all the items in the group will be removed /// public string UsagePeriodGroup; } /// /// 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. /// [Serializable] public class CatalogItemContainerInfo : PlayFabBaseModel { /// /// unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked /// public List ItemContents; /// /// ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will /// open the container, adding the contents to the player inventory and currency balances) /// public string KeyItemId; /// /// unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables /// will be resolved and add the relevant items to the player inventory) /// public List ResultTableContents; /// /// virtual currency types and balances which will be added to the player inventory when the container is unlocked /// public Dictionary VirtualCurrencyContents; } [Serializable] public class CharacterInventory : PlayFabBaseModel { /// /// The id of this character. /// public string CharacterId; /// /// The inventory of this character. /// public List Inventory; } [Serializable] public class CharacterLeaderboardEntry : PlayFabBaseModel { /// /// PlayFab unique identifier of the character that belongs to the user for this leaderboard entry. /// public string CharacterId; /// /// Title-specific display name of the character for this leaderboard entry. /// public string CharacterName; /// /// Name of the character class for this entry. /// public string CharacterType; /// /// Title-specific display name of the user for this leaderboard entry. /// public string DisplayName; /// /// PlayFab unique identifier of the user for this leaderboard entry. /// public string PlayFabId; /// /// User's overall position in the leaderboard. /// public int Position; /// /// Specific value of the user's statistic. /// public int StatValue; } [Serializable] public class CharacterResult : PlayFabBaseModel { /// /// The id for this character on this player. /// public string CharacterId; /// /// The name of this character. /// public string CharacterName; /// /// The type-string that was given to this character on creation. /// public string CharacterType; } public enum ChurnRiskLevel { NoData, LowRisk, MediumRisk, HighRisk } public enum CloudScriptRevisionOption { Live, Latest, Specific } [Serializable] public class ConsumeItemRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Number of uses to consume from the item. /// public int ConsumeCount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique instance identifier of the item to be consumed. /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class ConsumeItemResult : PlayFabResultCommon { /// /// Unique instance identifier of the item with uses consumed. /// public string ItemInstanceId; /// /// Number of uses remaining on the item. /// public int RemainingUses; } [Serializable] public class ContactEmailInfo : PlayFabBaseModel { /// /// The email address /// public string EmailAddress; /// /// The name of the email info data /// public string Name; /// /// The verification status of the email /// public EmailVerificationStatus? VerificationStatus; } [Serializable] public class ContactEmailInfoModel : PlayFabBaseModel { /// /// The email address /// public string EmailAddress; /// /// The name of the email info data /// public string Name; /// /// The verification status of the email /// public EmailVerificationStatus? VerificationStatus; } public enum ContinentCode { AF, AN, AS, EU, NA, OC, SA, Unknown } public 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, Unknown } /// /// 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. /// [Serializable] public class CreateSharedGroupRequest : PlayFabRequestCommon { /// /// Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). /// public string SharedGroupId; } [Serializable] public class CreateSharedGroupResult : PlayFabResultCommon { /// /// Unique identifier for the shared group. /// public string SharedGroupId; } public 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 } /// /// This function will delete the specified character from the list allowed by the user, and will also delete any inventory /// or VC currently held by that character. It will NOT delete any statistics associated for this character, in order to /// preserve leaderboard integrity. /// [Serializable] public class DeleteCharacterFromUserRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those /// items. /// public bool SaveCharacterInventory; } [Serializable] public class DeleteCharacterFromUserResult : PlayFabResultCommon { } /// /// Deletes all data associated with the player, including statistics, custom data, inventory, purchases, virtual currency /// balances, characters and shared group memberships. Removes the player from all leaderboards and player search indexes. /// Does not delete PlayStream event history associated with the player. Does not delete the publisher user account that /// created the player in the title nor associated data such as username, password, email address, account linkages, or /// friends list. Note, this API queues the player for deletion and returns immediately. It may take several minutes or more /// before all player data is fully deleted. Until the player data is fully deleted, attempts to recreate the player with /// the same user account in the same title will fail with the 'AccountDeleted' error. This API must be enabled for use as /// an option in the game manager website. It is disabled by default. /// [Serializable] public class DeletePlayerRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class DeletePlayerResult : PlayFabResultCommon { } /// /// Represents the request to delete a push notification template. /// [Serializable] public class DeletePushNotificationTemplateRequest : PlayFabRequestCommon { /// /// Id of the push notification template to be deleted. /// public string PushNotificationTemplateId; } [Serializable] public class DeletePushNotificationTemplateResult : PlayFabResultCommon { } [Serializable] public class DeleteSharedGroupRequest : PlayFabRequestCommon { /// /// Unique identifier for the shared group. /// public string SharedGroupId; } public enum EmailVerificationStatus { Unverified, Pending, Confirmed } [Serializable] public class EmptyResponse : PlayFabResultCommon { } [Serializable] public class EmptyResult : PlayFabResultCommon { } /// /// Combined entity type and ID structure which uniquely identifies a single entity. /// [Serializable] public class EntityKey : PlayFabBaseModel { /// /// Unique ID of the entity. /// public string Id; /// /// Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types /// public string Type; } [Serializable] public class EntityTokenResponse : PlayFabBaseModel { /// /// The entity id and type. /// public EntityKey Entity; /// /// The token used to set X-EntityToken for all entity based API calls. /// public string EntityToken; /// /// The time the token will expire, if it is an expiring token, in UTC. /// public DateTime? TokenExpiration; } [Serializable] public class EvaluateRandomResultTableRequest : PlayFabRequestCommon { /// /// Specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses /// default/primary catalog. /// public string CatalogVersion; /// /// The unique identifier of the Random Result Table to use. /// public string TableId; } /// /// Note that if the Random Result Table contains no entries, or does not exist for the catalog specified (the Primary /// catalog if one is not specified), an InvalidDropTable error will be returned. /// [Serializable] public class EvaluateRandomResultTableResult : PlayFabResultCommon { /// /// Unique identifier for the item returned from the Random Result Table evaluation, for the given catalog. /// public string ResultItemId; } [Serializable] public class ExecuteCloudScriptResult : PlayFabResultCommon { /// /// Number of PlayFab API requests issued by the CloudScript function /// public int APIRequestsIssued; /// /// Information about the error, if any, that occurred during execution /// public ScriptExecutionError Error; public double ExecutionTimeSeconds; /// /// The name of the function that executed /// public string FunctionName; /// /// The object returned from the CloudScript function, if any /// public object FunctionResult; /// /// Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if /// the total event size is larger than 350KB. /// public bool? FunctionResultTooLarge; /// /// Number of external HTTP requests issued by the CloudScript function /// public int HttpRequestsIssued; /// /// Entries logged during the function execution. These include both entries logged in the function code using log.info() /// and log.error() and error entries for API and HTTP request failures. /// public List Logs; /// /// Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total /// event size is larger than 350KB after the FunctionResult was removed. /// public bool? LogsTooLarge; public uint MemoryConsumedBytes; /// /// Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP /// requests. /// public double ProcessorTimeSeconds; /// /// The revision of the CloudScript that executed /// public int Revision; } [Serializable] public class ExecuteCloudScriptServerRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// The name of the CloudScript function to execute /// public string FunctionName; /// /// Object that is passed in to the function as the first argument /// public object FunctionParameter; /// /// Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other /// contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager. /// public bool? GeneratePlayStreamEvent; /// /// The unique user identifier for the player on whose behalf the script is being run /// public string PlayFabId; /// /// Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live' /// executes the current live, published revision, and 'Specific' executes the specified revision. The default value is /// 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'. /// public CloudScriptRevisionOption? RevisionSelection; /// /// The specivic revision to execute, when RevisionSelection is set to 'Specific' /// public int? SpecificRevision; } public enum ExternalFriendSources { None, Steam, Facebook, Xbox, Psn, All } [Serializable] public class FacebookInstantGamesPlayFabIdPair : PlayFabBaseModel { /// /// Unique Facebook Instant Games identifier for a user. /// public string FacebookInstantGamesId; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook Instant Games identifier. /// public string PlayFabId; } [Serializable] public class FacebookPlayFabIdPair : PlayFabBaseModel { /// /// Unique Facebook identifier for a user. /// public string FacebookId; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook identifier. /// public string PlayFabId; } [Serializable] public class FriendInfo : PlayFabBaseModel { /// /// Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). /// public UserFacebookInfo FacebookInfo; /// /// PlayFab unique identifier for this friend. /// public string FriendPlayFabId; /// /// Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same /// title). /// public UserGameCenterInfo GameCenterInfo; /// /// The profile of the user, if requested. /// public PlayerProfileModel Profile; /// /// Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab /// Accounts in the same title. /// public UserPsnInfo PSNInfo; /// /// Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). /// public UserSteamInfo SteamInfo; /// /// Tags which have been associated with this friend. /// public List Tags; /// /// Title-specific display name for this friend. /// public string TitleDisplayName; /// /// PlayFab unique username for this friend. /// public string Username; /// /// Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). /// public UserXboxInfo XboxInfo; } public enum GenericErrorCodes { Success, UnkownError, InvalidParams, AccountNotFound, AccountBanned, InvalidUsernameOrPassword, InvalidTitleId, InvalidEmailAddress, EmailAddressNotAvailable, InvalidUsername, InvalidPassword, UsernameNotAvailable, InvalidSteamTicket, AccountAlreadyLinked, LinkedAccountAlreadyClaimed, InvalidFacebookToken, AccountNotLinked, FailedByPaymentProvider, CouponCodeNotFound, InvalidContainerItem, ContainerNotOwned, KeyNotOwned, InvalidItemIdInTable, InvalidReceipt, ReceiptAlreadyUsed, ReceiptCancelled, GameNotFound, GameModeNotFound, InvalidGoogleToken, UserIsNotPartOfDeveloper, InvalidTitleForDeveloper, TitleNameConflicts, UserisNotValid, ValueAlreadyExists, BuildNotFound, PlayerNotInGame, InvalidTicket, InvalidDeveloper, InvalidOrderInfo, RegistrationIncomplete, InvalidPlatform, UnknownError, SteamApplicationNotOwned, WrongSteamAccount, TitleNotActivated, RegistrationSessionNotFound, NoSuchMod, FileNotFound, DuplicateEmail, ItemNotFound, ItemNotOwned, ItemNotRecycleable, ItemNotAffordable, InvalidVirtualCurrency, WrongVirtualCurrency, WrongPrice, NonPositiveValue, InvalidRegion, RegionAtCapacity, ServerFailedToStart, NameNotAvailable, InsufficientFunds, InvalidDeviceID, InvalidPushNotificationToken, NoRemainingUses, InvalidPaymentProvider, PurchaseInitializationFailure, DuplicateUsername, InvalidBuyerInfo, NoGameModeParamsSet, BodyTooLarge, ReservedWordInBody, InvalidTypeInBody, InvalidRequest, ReservedEventName, InvalidUserStatistics, NotAuthenticated, StreamAlreadyExists, ErrorCreatingStream, StreamNotFound, InvalidAccount, PurchaseDoesNotExist, InvalidPurchaseTransactionStatus, APINotEnabledForGameClientAccess, NoPushNotificationARNForTitle, BuildAlreadyExists, BuildPackageDoesNotExist, CustomAnalyticsEventsNotEnabledForTitle, InvalidSharedGroupId, NotAuthorized, MissingTitleGoogleProperties, InvalidItemProperties, InvalidPSNAuthCode, InvalidItemId, PushNotEnabledForAccount, PushServiceError, ReceiptDoesNotContainInAppItems, ReceiptContainsMultipleInAppItems, InvalidBundleID, JavascriptException, InvalidSessionTicket, UnableToConnectToDatabase, InternalServerError, InvalidReportDate, ReportNotAvailable, DatabaseThroughputExceeded, InvalidGameTicket, ExpiredGameTicket, GameTicketDoesNotMatchLobby, LinkedDeviceAlreadyClaimed, DeviceAlreadyLinked, DeviceNotLinked, PartialFailure, PublisherNotSet, ServiceUnavailable, VersionNotFound, RevisionNotFound, InvalidPublisherId, DownstreamServiceUnavailable, APINotIncludedInTitleUsageTier, DAULimitExceeded, APIRequestLimitExceeded, InvalidAPIEndpoint, BuildNotAvailable, ConcurrentEditError, ContentNotFound, CharacterNotFound, CloudScriptNotFound, ContentQuotaExceeded, InvalidCharacterStatistics, PhotonNotEnabledForTitle, PhotonApplicationNotFound, PhotonApplicationNotAssociatedWithTitle, InvalidEmailOrPassword, FacebookAPIError, InvalidContentType, KeyLengthExceeded, DataLengthExceeded, TooManyKeys, FreeTierCannotHaveVirtualCurrency, MissingAmazonSharedKey, AmazonValidationError, InvalidPSNIssuerId, PSNInaccessible, ExpiredAuthToken, FailedToGetEntitlements, FailedToConsumeEntitlement, TradeAcceptingUserNotAllowed, TradeInventoryItemIsAssignedToCharacter, TradeInventoryItemIsBundle, TradeStatusNotValidForCancelling, TradeStatusNotValidForAccepting, TradeDoesNotExist, TradeCancelled, TradeAlreadyFilled, TradeWaitForStatusTimeout, TradeInventoryItemExpired, TradeMissingOfferedAndAcceptedItems, TradeAcceptedItemIsBundle, TradeAcceptedItemIsStackable, TradeInventoryItemInvalidStatus, TradeAcceptedCatalogItemInvalid, TradeAllowedUsersInvalid, TradeInventoryItemDoesNotExist, TradeInventoryItemIsConsumed, TradeInventoryItemIsStackable, TradeAcceptedItemsMismatch, InvalidKongregateToken, FeatureNotConfiguredForTitle, NoMatchingCatalogItemForReceipt, InvalidCurrencyCode, NoRealMoneyPriceForCatalogItem, TradeInventoryItemIsNotTradable, TradeAcceptedCatalogItemIsNotTradable, UsersAlreadyFriends, LinkedIdentifierAlreadyClaimed, CustomIdNotLinked, TotalDataSizeExceeded, DeleteKeyConflict, InvalidXboxLiveToken, ExpiredXboxLiveToken, ResettableStatisticVersionRequired, NotAuthorizedByTitle, NoPartnerEnabled, InvalidPartnerResponse, APINotEnabledForGameServerAccess, StatisticNotFound, StatisticNameConflict, StatisticVersionClosedForWrites, StatisticVersionInvalid, APIClientRequestRateLimitExceeded, InvalidJSONContent, InvalidDropTable, StatisticVersionAlreadyIncrementedForScheduledInterval, StatisticCountLimitExceeded, StatisticVersionIncrementRateExceeded, ContainerKeyInvalid, CloudScriptExecutionTimeLimitExceeded, NoWritePermissionsForEvent, CloudScriptFunctionArgumentSizeExceeded, CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, CloudScriptHTTPRequestError, InsufficientGuildRole, GuildNotFound, OverLimit, EventNotFound, InvalidEventField, InvalidEventName, CatalogNotConfigured, OperationNotSupportedForPlatform, SegmentNotFound, StoreNotFound, InvalidStatisticName, TitleNotQualifiedForLimit, InvalidServiceLimitLevel, ServiceLimitLevelInTransition, CouponAlreadyRedeemed, GameServerBuildSizeLimitExceeded, GameServerBuildCountLimitExceeded, VirtualCurrencyCountLimitExceeded, VirtualCurrencyCodeExists, TitleNewsItemCountLimitExceeded, InvalidTwitchToken, TwitchResponseError, ProfaneDisplayName, UserAlreadyAdded, InvalidVirtualCurrencyCode, VirtualCurrencyCannotBeDeleted, IdentifierAlreadyClaimed, IdentifierNotLinked, InvalidContinuationToken, ExpiredContinuationToken, InvalidSegment, InvalidSessionId, SessionLogNotFound, InvalidSearchTerm, TwoFactorAuthenticationTokenRequired, GameServerHostCountLimitExceeded, PlayerTagCountLimitExceeded, RequestAlreadyRunning, ActionGroupNotFound, MaximumSegmentBulkActionJobsRunning, NoActionsOnPlayersInSegmentJob, DuplicateStatisticName, ScheduledTaskNameConflict, ScheduledTaskCreateConflict, InvalidScheduledTaskName, InvalidTaskSchedule, SteamNotEnabledForTitle, LimitNotAnUpgradeOption, NoSecretKeyEnabledForCloudScript, TaskNotFound, TaskInstanceNotFound, InvalidIdentityProviderId, MisconfiguredIdentityProvider, InvalidScheduledTaskType, BillingInformationRequired, LimitedEditionItemUnavailable, InvalidAdPlacementAndReward, AllAdPlacementViewsAlreadyConsumed, GoogleOAuthNotConfiguredForTitle, GoogleOAuthError, UserNotFriend, InvalidSignature, InvalidPublicKey, GoogleOAuthNoIdTokenIncludedInResponse, StatisticUpdateInProgress, LeaderboardVersionNotAvailable, StatisticAlreadyHasPrizeTable, PrizeTableHasOverlappingRanks, PrizeTableHasMissingRanks, PrizeTableRankStartsAtZero, InvalidStatistic, ExpressionParseFailure, ExpressionInvokeFailure, ExpressionTooLong, DataUpdateRateExceeded, RestrictedEmailDomain, EncryptionKeyDisabled, EncryptionKeyMissing, EncryptionKeyBroken, NoSharedSecretKeyConfigured, SecretKeyNotFound, PlayerSecretAlreadyConfigured, APIRequestsDisabledForTitle, InvalidSharedSecretKey, PrizeTableHasNoRanks, ProfileDoesNotExist, ContentS3OriginBucketNotConfigured, InvalidEnvironmentForReceipt, EncryptedRequestNotAllowed, SignedRequestNotAllowed, RequestViewConstraintParamsNotAllowed, BadPartnerConfiguration, XboxBPCertificateFailure, XboxXASSExchangeFailure, InvalidEntityId, StatisticValueAggregationOverflow, EmailMessageFromAddressIsMissing, EmailMessageToAddressIsMissing, SmtpServerAuthenticationError, SmtpServerLimitExceeded, SmtpServerInsufficientStorage, SmtpServerCommunicationError, SmtpServerGeneralFailure, EmailClientTimeout, EmailClientCanceledTask, EmailTemplateMissing, InvalidHostForTitleId, EmailConfirmationTokenDoesNotExist, EmailConfirmationTokenExpired, AccountDeleted, PlayerSecretNotConfigured, InvalidSignatureTime, NoContactEmailAddressFound, InvalidAuthToken, AuthTokenDoesNotExist, AuthTokenExpired, AuthTokenAlreadyUsedToResetPassword, MembershipNameTooLong, MembershipNotFound, GoogleServiceAccountInvalid, GoogleServiceAccountParseFailure, EntityTokenMissing, EntityTokenInvalid, EntityTokenExpired, EntityTokenRevoked, InvalidProductForSubscription, XboxInaccessible, SubscriptionAlreadyTaken, SmtpAddonNotEnabled, APIConcurrentRequestLimitExceeded, XboxRejectedXSTSExchangeRequest, VariableNotDefined, TemplateVersionNotDefined, FileTooLarge, TitleDeleted, TitleContainsUserAccounts, TitleDeletionPlayerCleanupFailure, EntityFileOperationPending, NoEntityFileOperationPending, EntityProfileVersionMismatch, TemplateVersionTooOld, MembershipDefinitionInUse, PaymentPageNotConfigured, FailedLoginAttemptRateLimitExceeded, EntityBlockedByGroup, RoleDoesNotExist, EntityIsAlreadyMember, DuplicateRoleId, GroupInvitationNotFound, GroupApplicationNotFound, OutstandingInvitationAcceptedInstead, OutstandingApplicationAcceptedInstead, RoleIsGroupDefaultMember, RoleIsGroupAdmin, RoleNameNotAvailable, GroupNameNotAvailable, EmailReportAlreadySent, EmailReportRecipientBlacklisted, EventNamespaceNotAllowed, EventEntityNotAllowed, InvalidEntityType, NullTokenResultFromAad, InvalidTokenResultFromAad, NoValidCertificateForAad, InvalidCertificateForAad, DuplicateDropTableId, MultiplayerServerError, MultiplayerServerTooManyRequests, MultiplayerServerNoContent, MultiplayerServerBadRequest, MultiplayerServerUnauthorized, MultiplayerServerForbidden, MultiplayerServerNotFound, MultiplayerServerConflict, MultiplayerServerInternalServerError, MultiplayerServerUnavailable, ExplicitContentDetected, PIIContentDetected, InvalidScheduledTaskParameter, PerEntityEventRateLimitExceeded, TitleDefaultLanguageNotSet, EmailTemplateMissingDefaultVersion, FacebookInstantGamesIdNotLinked, InvalidFacebookInstantGamesSignature, FacebookInstantGamesAuthNotConfiguredForTitle, EntityProfileConstraintValidationFailed, TelemetryIngestionKeyPending, TelemetryIngestionKeyNotFound, StatisticChildNameInvalid, DataIntegrityError, VirtualCurrencyCannotBeSetToOlderVersion, VirtualCurrencyMustBeWithinIntegerRange, EmailTemplateInvalidSyntax, EmailTemplateMissingCallback, PushNotificationTemplateInvalidPayload, InvalidLocalizedPushNotificationLanguage, MissingLocalizedPushNotificationMessage, PushNotificationTemplateMissingPlatformPayload, PushNotificationTemplatePayloadContainsInvalidJson, PushNotificationTemplateContainsInvalidIosPayload, PushNotificationTemplateContainsInvalidAndroidPayload, PushNotificationTemplateIosPayloadMissingNotificationBody, PushNotificationTemplateAndroidPayloadMissingNotificationBody, PushNotificationTemplateNotFound, PushNotificationTemplateMissingDefaultVersion, PushNotificationTemplateInvalidSyntax, PushNotificationTemplateNoCustomPayloadForV1, NoLeaderboardForStatistic, TitleNewsMissingDefaultLanguage, TitleNewsNotFound, TitleNewsDuplicateLanguage, TitleNewsMissingTitleOrBody, TitleNewsInvalidLanguage, EmailRecipientBlacklisted, InvalidGameCenterAuthRequest, GameCenterAuthenticationFailed, CannotEnablePartiesForTitle, PartyError, PartyRequests, PartyNoContent, PartyBadRequest, PartyUnauthorized, PartyForbidden, PartyNotFound, PartyConflict, PartyInternalServerError, PartyUnavailable, PartyTooManyRequests, PushNotificationTemplateMissingName, CannotEnableMultiplayerServersForTitle, WriteAttemptedDuringExport, MultiplayerServerTitleQuotaCoresExceeded, AutomationRuleNotFound, EntityAPIKeyLimitExceeded, EntityAPIKeyNotFound, EntityAPIKeyOrSecretInvalid, EconomyServiceUnavailable, EconomyServiceInternalError, QueryRateLimitExceeded, EntityAPIKeyCreationDisabledForEntity, ForbiddenByEntityPolicy, UpdateInventoryRateLimitExceeded, StudioCreationRateLimited, StudioCreationInProgress, DuplicateStudioName, StudioNotFound, StudioDeleted, StudioDeactivated, StudioActivated, TitleCreationRateLimited, TitleCreationInProgress, DuplicateTitleName, TitleActivationRateLimited, TitleActivationInProgress, TitleDeactivated, TitleActivated, CloudScriptAzureFunctionsExecutionTimeLimitExceeded, CloudScriptAzureFunctionsArgumentSizeExceeded, CloudScriptAzureFunctionsReturnSizeExceeded, CloudScriptAzureFunctionsHTTPRequestError, VirtualCurrencyBetaGetError, VirtualCurrencyBetaCreateError, VirtualCurrencyBetaInitialDepositSaveError, VirtualCurrencyBetaSaveError, VirtualCurrencyBetaDeleteError, VirtualCurrencyBetaRestoreError, VirtualCurrencyBetaSaveConflict, VirtualCurrencyBetaUpdateError, InsightsManagementDatabaseNotFound, InsightsManagementOperationNotFound, InsightsManagementErrorPendingOperationExists, InsightsManagementSetPerformanceLevelInvalidParameter, InsightsManagementSetStorageRetentionInvalidParameter, InsightsManagementGetStorageUsageInvalidParameter, InsightsManagementGetOperationStatusInvalidParameter, DuplicatePurchaseTransactionId, EvaluationModePlayerCountExceeded, GetPlayersInSegmentRateLimitExceeded, CloudScriptFunctionNameSizeExceeded, PaidInsightsFeaturesNotEnabled, CloudScriptAzureFunctionsQueueRequestError, EvaluationModeTitleCountExceeded, InsightsManagementTitleNotInFlight, LimitNotFound, LimitNotAvailableViaAPI, InsightsManagementSetStorageRetentionBelowMinimum, InsightsManagementSetStorageRetentionAboveMaximum, AppleNotEnabledForTitle, InsightsManagementNewActiveEventExportLimitInvalid, InsightsManagementSetPerformanceRateLimited, PartyRequestsThrottledFromRateLimiter, XboxServiceTooManyRequests, NintendoSwitchNotEnabledForTitle, RequestMultiplayerServersThrottledFromRateLimiter, TitleDataOverrideNotFound, DuplicateKeys, WasNotCreatedWithCloudRoot, LegacyMultiplayerServersDeprecated, VirtualCurrencyCurrentlyUnavailable, SteamUserNotFound, ElasticSearchOperationFailed, NotImplemented, PublisherNotFound, PublisherDeleted, ApiDisabledForMigration, ResourceNameUpdateNotAllowed, ApiNotEnabledForTitle, DuplicateTitleNameForPublisher, AzureTitleCreationInProgress, TitleConstraintsPublisherDeletion, InvalidPlayerAccountPoolId, PlayerAccountPoolNotFound, PlayerAccountPoolDeleted, TitleCleanupInProgress, AzureResourceConcurrentOperationInProgress, TitlePublisherUpdateNotAllowed, AzureResourceManagerNotSupportedInStamp, ApiNotIncludedInAzurePlayFabFeatureSet, GoogleServiceAccountFailedAuth, GoogleAPIServiceUnavailable, GoogleAPIServiceUnknownError, NoValidIdentityForAad, PlayerIdentityLinkNotFound, PhotonApplicationIdAlreadyInUse, CloudScriptUnableToDeleteProductionRevision, CustomIdNotFound, AutomationInvalidInput, AutomationInvalidRuleName, AutomationRuleAlreadyExists, AutomationRuleLimitExceeded, InvalidGooglePlayGamesServerAuthCode, PlayStreamConnectionFailed, InvalidEventContents, InsightsV1Deprecated, AnalysisSubscriptionNotFound, AnalysisSubscriptionFailed, AnalysisSubscriptionFoundAlready, AnalysisSubscriptionManagementInvalidInput, InvalidGameCenterId, InvalidNintendoSwitchAccountId, EntityAPIKeysNotSupported, IpAddressBanned, EntityLineageBanned, NamespaceMismatch, InvalidServiceConfiguration, InvalidNamespaceMismatch, LeaderboardColumnLengthMismatch, InvalidStatisticScore, LeaderboardColumnsNotSpecified, LeaderboardMaxSizeTooLarge, InvalidAttributeStatisticsSpecified, LeaderboardNotFound, TokenSigningKeyNotFound, LeaderboardNameConflict, LinkedStatisticColumnMismatch, NoLinkedStatisticToLeaderboard, StatDefinitionAlreadyLinkedToLeaderboard, LinkingStatsNotAllowedForEntityType, LeaderboardCountLimitExceeded, LeaderboardSizeLimitExceeded, LeaderboardDefinitionModificationNotAllowedWhileLinked, StatisticDefinitionModificationNotAllowedWhileLinked, LeaderboardUpdateNotAllowedWhileLinked, CloudScriptAzureFunctionsEventHubRequestError, ExternalEntityNotAllowedForTier, InvalidBaseTimeForInterval, EntityTypeMismatchWithStatDefinition, SpecifiedVersionLeaderboardNotFound, LeaderboardColumnLengthMismatchWithStatDefinition, DuplicateColumnNameFound, LinkedStatisticColumnNotFound, LinkedStatisticColumnRequired, MultipleLinkedStatisticsNotAllowed, DuplicateLinkedStatisticColumnNameFound, AggregationTypeNotAllowedForMultiColumnStatistic, MaxQueryableVersionsValueNotAllowedForTier, StatisticDefinitionHasNullOrEmptyVersionConfiguration, StatisticColumnLengthMismatch, MatchmakingEntityInvalid, MatchmakingPlayerAttributesInvalid, MatchmakingQueueNotFound, MatchmakingMatchNotFound, MatchmakingTicketNotFound, MatchmakingAlreadyJoinedTicket, MatchmakingTicketAlreadyCompleted, MatchmakingQueueConfigInvalid, MatchmakingMemberProfileInvalid, NintendoSwitchDeviceIdNotLinked, MatchmakingNotEnabled, MatchmakingPlayerAttributesTooLarge, MatchmakingNumberOfPlayersInTicketTooLarge, MatchmakingAttributeInvalid, MatchmakingPlayerHasNotJoinedTicket, MatchmakingRateLimitExceeded, MatchmakingTicketMembershipLimitExceeded, MatchmakingUnauthorized, MatchmakingQueueLimitExceeded, MatchmakingRequestTypeMismatch, MatchmakingBadRequest, PubSubFeatureNotEnabledForTitle, PubSubTooManyRequests, PubSubConnectionNotFoundForEntity, PubSubConnectionHandleInvalid, PubSubSubscriptionLimitExceeded, TitleConfigNotFound, TitleConfigUpdateConflict, TitleConfigSerializationError, CatalogApiNotImplemented, CatalogEntityInvalid, CatalogTitleIdMissing, CatalogPlayerIdMissing, CatalogClientIdentityInvalid, CatalogOneOrMoreFilesInvalid, CatalogItemMetadataInvalid, CatalogItemIdInvalid, CatalogSearchParameterInvalid, CatalogFeatureDisabled, CatalogConfigInvalid, CatalogItemTypeInvalid, CatalogBadRequest, CatalogTooManyRequests, InvalidCatalogItemConfiguration, ExportInvalidStatusUpdate, ExportInvalidPrefix, ExportBlobContainerDoesNotExist, ExportNotFound, ExportCouldNotUpdate, ExportInvalidStorageType, ExportAmazonBucketDoesNotExist, ExportInvalidBlobStorage, ExportKustoException, ExportKustoConnectionFailed, ExportUnknownError, ExportCantEditPendingExport, ExportLimitExports, ExportLimitEvents, ExportInvalidPartitionStatusModification, ExportCouldNotCreate, ExportNoBackingDatabaseFound, ExportCouldNotDelete, ExportCannotDetermineEventQuery, ExportInvalidQuerySchemaModification, ExportQuerySchemaMissingRequiredColumns, ExportCannotParseQuery, ExportControlCommandsNotAllowed, ExportQueryMissingTableReference, ExportInsightsV1Deprecated, ExplorerBasicInvalidQueryName, ExplorerBasicInvalidQueryDescription, ExplorerBasicInvalidQueryConditions, ExplorerBasicInvalidQueryStartDate, ExplorerBasicInvalidQueryEndDate, ExplorerBasicInvalidQueryGroupBy, ExplorerBasicInvalidQueryAggregateType, ExplorerBasicInvalidQueryAggregateProperty, ExplorerBasicLoadQueriesError, ExplorerBasicLoadQueryError, ExplorerBasicCreateQueryError, ExplorerBasicDeleteQueryError, ExplorerBasicUpdateQueryError, ExplorerBasicSavedQueriesLimit, ExplorerBasicSavedQueryNotFound, TenantShardMapperShardNotFound, TitleNotEnabledForParty, PartyVersionNotFound, MultiplayerServerBuildReferencedByMatchmakingQueue, MultiplayerServerBuildReferencedByBuildAlias, MultiplayerServerBuildAliasReferencedByMatchmakingQueue, PartySerializationError, ExperimentationExperimentStopped, ExperimentationExperimentRunning, ExperimentationExperimentNotFound, ExperimentationExperimentNeverStarted, ExperimentationExperimentDeleted, ExperimentationClientTimeout, ExperimentationInvalidVariantConfiguration, ExperimentationInvalidVariableConfiguration, ExperimentInvalidId, ExperimentationNoScorecard, ExperimentationTreatmentAssignmentFailed, ExperimentationTreatmentAssignmentDisabled, ExperimentationInvalidDuration, ExperimentationMaxExperimentsReached, ExperimentationExperimentSchedulingInProgress, ExperimentationInvalidEndDate, ExperimentationInvalidStartDate, ExperimentationMaxDurationExceeded, ExperimentationExclusionGroupNotFound, ExperimentationExclusionGroupInsufficientCapacity, ExperimentationExclusionGroupCannotDelete, ExperimentationExclusionGroupInvalidTrafficAllocation, ExperimentationExclusionGroupInvalidName, MaxActionDepthExceeded, TitleNotOnUpdatedPricingPlan, SegmentManagementTitleNotInFlight, SegmentManagementNoExpressionTree, SegmentManagementTriggerActionCountOverLimit, SegmentManagementSegmentCountOverLimit, SegmentManagementInvalidSegmentId, SegmentManagementInvalidInput, SegmentManagementInvalidSegmentName, DeleteSegmentRateLimitExceeded, CreateSegmentRateLimitExceeded, UpdateSegmentRateLimitExceeded, GetSegmentsRateLimitExceeded, AsyncExportNotInFlight, AsyncExportNotFound, AsyncExportRateLimitExceeded, AnalyticsSegmentCountOverLimit, SnapshotNotFound, InventoryApiNotImplemented, LobbyDoesNotExist, LobbyRateLimitExceeded, LobbyPlayerAlreadyJoined, LobbyNotJoinable, LobbyMemberCannotRejoin, LobbyCurrentPlayersMoreThanMaxPlayers, LobbyPlayerNotPresent, LobbyBadRequest, LobbyPlayerMaxLobbyLimitExceeded, LobbyNewOwnerMustBeConnected, LobbyCurrentOwnerStillConnected, LobbyMemberIsNotOwner, LobbyServerMismatch, LobbyServerNotFound, LobbyDifferentServerAlreadyJoined, LobbyServerAlreadyJoined, LobbyIsNotClientOwned, LobbyDoesNotUseConnections, EventSamplingInvalidRatio, EventSamplingInvalidEventNamespace, EventSamplingInvalidEventName, EventSamplingRatioNotFound, TelemetryKeyNotFound, TelemetryKeyInvalidName, TelemetryKeyAlreadyExists, TelemetryKeyInvalid, TelemetryKeyCountOverLimit, TelemetryKeyDeactivated, TelemetryKeyLongInsightsRetentionNotAllowed, EventSinkConnectionInvalid, EventSinkConnectionUnauthorized, EventSinkRegionInvalid, EventSinkLimitExceeded, EventSinkSasTokenInvalid, EventSinkNotFound, EventSinkNameInvalid, EventSinkSasTokenPermissionInvalid, EventSinkSecretInvalid, EventSinkTenantNotFound, EventSinkAadNotFound, EventSinkDatabaseNotFound, EventSinkTitleUnauthorized, EventSinkInsufficientRoleAssignment, EventSinkContainerNotFound, EventSinkTenantIdInvalid, OperationCanceled, InvalidDisplayNameRandomSuffixLength, AllowNonUniquePlayerDisplayNamesDisableNotAllowed, PartitionedEventInvalid, PartitionedEventCountOverLimit, ManageEventNamespaceInvalid, ManageEventNameInvalid, ManagedEventNotFound, ManageEventsInvalidRatio, ManagedEventInvalid, PlayerCustomPropertiesPropertyNameTooLong, PlayerCustomPropertiesPropertyNameIsInvalid, PlayerCustomPropertiesStringPropertyValueTooLong, PlayerCustomPropertiesValueIsInvalidType, PlayerCustomPropertiesVersionMismatch, PlayerCustomPropertiesPropertyCountTooHigh, PlayerCustomPropertiesDuplicatePropertyName, PlayerCustomPropertiesPropertyDoesNotExist, AddonAlreadyExists, AddonDoesntExist, CopilotDisabled, CopilotInvalidRequest, TrueSkillUnauthorized, TrueSkillInvalidTitleId, TrueSkillInvalidScenarioId, TrueSkillInvalidModelId, TrueSkillInvalidModelName, TrueSkillInvalidPlayerIds, TrueSkillInvalidEntityKey, TrueSkillInvalidConditionKey, TrueSkillInvalidConditionValue, TrueSkillInvalidConditionAffinityWeight, TrueSkillInvalidEventName, TrueSkillMatchResultCreated, TrueSkillMatchResultAlreadySubmitted, TrueSkillBadPlayerIdInMatchResult, TrueSkillInvalidBotIdInMatchResult, TrueSkillDuplicatePlayerInMatchResult, TrueSkillNoPlayerInMatchResultTeam, TrueSkillPlayersInMatchResultExceedingLimit, TrueSkillInvalidPreMatchPartyInMatchResult, TrueSkillInvalidTimestampInMatchResult, TrueSkillStartTimeMissingInMatchResult, TrueSkillEndTimeMissingInMatchResult, TrueSkillInvalidPlayerSecondsPlayedInMatchResult, TrueSkillNoTeamInMatchResult, TrueSkillNotEnoughTeamsInMatchResult, TrueSkillInvalidRanksInMatchResult, TrueSkillNoWinnerInMatchResult, TrueSkillMissingRequiredCondition, TrueSkillMissingRequiredEvent, TrueSkillUnknownEventName, TrueSkillInvalidEventCount, TrueSkillUnknownConditionKey, TrueSkillUnknownConditionValue, TrueSkillScenarioConfigDoesNotExist, TrueSkillUnknownModelId, TrueSkillNoModelInScenario, TrueSkillNotSupportedForTitle, TrueSkillModelIsNotActive, TrueSkillUnauthorizedToQueryOtherPlayerSkills, TrueSkillInvalidMaxIterations, TrueSkillEndTimeBeforeStartTime, TrueSkillInvalidJobId, TrueSkillInvalidMetadataId, TrueSkillMissingBuildVerison, TrueSkillJobAlreadyExists, TrueSkillJobNotFound, TrueSkillOperationCanceled, TrueSkillActiveModelLimitExceeded, TrueSkillTotalModelLimitExceeded, TrueSkillUnknownInitialModelId, TrueSkillUnauthorizedForJob, TrueSkillInvalidScenarioName, TrueSkillConditionStateIsRequired, TrueSkillEventStateIsRequired, TrueSkillDuplicateEvent, TrueSkillDuplicateCondition, TrueSkillInvalidAnomalyThreshold, TrueSkillConditionKeyLimitExceeded, TrueSkillConditionValuePerKeyLimitExceeded, TrueSkillInvalidTimestamp, TrueSkillEventLimitExceeded, TrueSkillInvalidPlayers, TrueSkillTrueSkillPlayerNull, TrueSkillInvalidPlayerId, TrueSkillInvalidSquadSize, TrueSkillConditionSetNotInModel, TrueSkillModelStateInvalidForOperation, TrueSkillScenarioContainsActiveModel, GameSaveManifestNotFound, GameSaveManifestVersionAlreadyExists, GameSaveConflictUpdatingManifest, GameSaveManifestUpdatesNotAllowed, GameSaveFileAlreadyExists, GameSaveManifestVersionNotFinalized, GameSaveUnknownFileInManifest, GameSaveFileExceededReportedSize, GameSaveFileNotUploaded, GameSaveBadRequest, GameSaveOperationNotAllowed, StateShareForbidden, StateShareTitleNotInFlight, StateShareStateNotFound, StateShareLinkNotFound, StateShareStateRedemptionLimitExceeded, StateShareStateRedemptionLimitNotUpdated, StateShareCreatedStatesLimitExceeded, StateShareIdMissingOrMalformed } [Serializable] public class GenericPlayFabIdPair : PlayFabBaseModel { /// /// Unique generic service identifier for a user. /// public GenericServiceId GenericId; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the given generic identifier. /// public string PlayFabId; } [Serializable] public class GenericServiceId : PlayFabBaseModel { /// /// Name of the service for which the player has a unique identifier. /// public string ServiceName; /// /// Unique identifier of the player in that service. /// public string UserId; } /// /// Request has no paramaters. /// [Serializable] public class GetAllSegmentsRequest : PlayFabRequestCommon { } [Serializable] public class GetAllSegmentsResult : PlayFabResultCommon { /// /// Array of segments for this title. /// public List Segments; } [Serializable] public class GetCatalogItemsRequest : PlayFabRequestCommon { /// /// Which catalog is being requested. If null, uses the default catalog. /// public string CatalogVersion; } [Serializable] public class GetCatalogItemsResult : PlayFabResultCommon { /// /// Array of items which can be purchased. /// public List Catalog; } /// /// 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 user data will be returned. /// [Serializable] public class GetCharacterDataRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The version that currently exists according to the caller. The call will return the data for all of the keys if the /// version in the system is greater than this. /// public uint? IfChangedFromDataVersion; /// /// Specific keys to search for in the custom user data. /// public List Keys; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetCharacterDataResult : PlayFabResultCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// User specific data for this title. /// public Dictionary Data; /// /// Indicates the current version of the data that has been set. This is incremented with every set call for that type of /// data (read-only, internal, etc). This version can be provided in Get calls to find updated data. /// public uint DataVersion; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// 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. /// [Serializable] public class GetCharacterInventoryRequest : PlayFabRequestCommon { /// /// Used to limit results to only those from a specific catalog version. /// public string CatalogVersion; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetCharacterInventoryResult : PlayFabResultCommon { /// /// Unique identifier of the character for this inventory. /// public string CharacterId; /// /// Array of inventory items belonging to the character. /// public List Inventory; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Array of virtual currency balance(s) belonging to the character. /// public Dictionary VirtualCurrency; /// /// Array of remaining times and timestamps for virtual currencies. /// public Dictionary VirtualCurrencyRechargeTimes; } [Serializable] public class GetCharacterLeaderboardRequest : PlayFabRequestCommon { /// /// Maximum number of entries to retrieve. /// public int MaxResultsCount; /// /// First entry in the leaderboard to be retrieved. /// public int StartPosition; /// /// Unique identifier for the title-specific statistic for the leaderboard. /// public string StatisticName; } /// /// Note that the Position of the character in the results is for the overall leaderboard. /// [Serializable] public class GetCharacterLeaderboardResult : PlayFabResultCommon { /// /// Ordered list of leaderboard entries. /// public List Leaderboard; } /// /// Character statistics are similar to user statistics in that they are numeric values which may only be updated by a /// server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use /// by the title, the statistics are used for all leaderboard operations in PlayFab. /// [Serializable] public class GetCharacterStatisticsRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetCharacterStatisticsResult : PlayFabResultCommon { /// /// Unique identifier of the character for the statistics. /// public string CharacterId; /// /// Character statistics for the requested user. /// public Dictionary CharacterStatistics; /// /// PlayFab unique identifier of the user whose character statistics are being returned. /// public string PlayFabId; } [Serializable] public class GetContentDownloadUrlRequest : PlayFabRequestCommon { /// /// HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET. /// public string HttpMethod; /// /// Key of the content item to fetch, usually formatted as a path, e.g. images/a.png /// public string Key; /// /// True to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest, /// non-cached version of the content during development, set this to false. Default is true. /// public bool? ThruCDN; } [Serializable] public class GetContentDownloadUrlResult : PlayFabResultCommon { /// /// URL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour. /// public string URL; } [Serializable] public class GetFriendLeaderboardRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a /// comma-separated list of platforms. /// public ExternalFriendSources? ExternalPlatformFriends; /// /// Maximum number of entries to retrieve. /// public int MaxResultsCount; /// /// The player whose friend leaderboard to get /// public string PlayFabId; /// /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, /// only the allowed client profile properties for the title may be requested. These allowed properties are configured in /// the Game Manager "Client Profile Options" tab in the "Settings" section. /// public PlayerProfileViewConstraints ProfileConstraints; /// /// Position in the leaderboard to start this listing (defaults to the first entry). /// public int StartPosition; /// /// Statistic used to rank friends for this leaderboard. /// public string StatisticName; /// /// The version of the leaderboard to get. /// public int? Version; /// /// Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. /// public string XboxToken; } [Serializable] public class GetFriendsListRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a /// comma-separated list of platforms. /// public ExternalFriendSources? ExternalPlatformFriends; /// /// PlayFab identifier of the player whose friend list to get. /// public string PlayFabId; /// /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, /// only the allowed client profile properties for the title may be requested. These allowed properties are configured in /// the Game Manager "Client Profile Options" tab in the "Settings" section. /// public PlayerProfileViewConstraints ProfileConstraints; /// /// Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. /// public string XboxToken; } /// /// 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. /// [Serializable] public class GetFriendsListResult : PlayFabResultCommon { /// /// Array of friends found. /// public List Friends; } [Serializable] public class GetLeaderboardAroundCharacterRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Maximum number of entries to retrieve. /// public int MaxResultsCount; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Unique identifier for the title-specific statistic for the leaderboard. /// public string StatisticName; } /// /// Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does /// not have the corresponding statistic. /// [Serializable] public class GetLeaderboardAroundCharacterResult : PlayFabResultCommon { /// /// Ordered list of leaderboard entries. /// public List Leaderboard; } [Serializable] public class GetLeaderboardAroundUserRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Maximum number of entries to retrieve. /// public int MaxResultsCount; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, /// only the allowed client profile properties for the title may be requested. These allowed properties are configured in /// the Game Manager "Client Profile Options" tab in the "Settings" section. /// public PlayerProfileViewConstraints ProfileConstraints; /// /// Unique identifier for the title-specific statistic for the leaderboard. /// public string StatisticName; /// /// The version of the leaderboard to get. /// public int? Version; } /// /// Note: When calling 'GetLeaderboardAround...' APIs, the position of the user defaults to 0 when the user does not have /// the corresponding statistic. /// [Serializable] public class GetLeaderboardAroundUserResult : PlayFabResultCommon { /// /// Ordered listing of users and their positions in the requested leaderboard. /// public List Leaderboard; /// /// The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. /// public DateTime? NextReset; /// /// The version of the leaderboard returned. /// public int Version; } [Serializable] public class GetLeaderboardForUsersCharactersRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Unique identifier for the title-specific statistic for the leaderboard. /// public string StatisticName; } /// /// 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. /// [Serializable] public class GetLeaderboardForUsersCharactersResult : PlayFabResultCommon { /// /// Ordered list of leaderboard entries. /// public List Leaderboard; } [Serializable] public class GetLeaderboardRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Maximum number of entries to retrieve. /// public int MaxResultsCount; /// /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, /// only the allowed client profile properties for the title may be requested. These allowed properties are configured in /// the Game Manager "Client Profile Options" tab in the "Settings" section. /// public PlayerProfileViewConstraints ProfileConstraints; /// /// First entry in the leaderboard to be retrieved. /// public int StartPosition; /// /// Unique identifier for the title-specific statistic for the leaderboard. /// public string StatisticName; /// /// The version of the leaderboard to get. /// public int? Version; } /// /// Note that the Position of the user in the results is for the overall leaderboard. /// [Serializable] public class GetLeaderboardResult : PlayFabResultCommon { /// /// Ordered listing of users and their positions in the requested leaderboard. /// public List Leaderboard; /// /// The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. /// public DateTime? NextReset; /// /// The version of the leaderboard returned. /// public int Version; } [Serializable] public class GetPlayerCombinedInfoRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// PlayFabId of the user whose data will be returned /// public string PlayFabId; } [Serializable] public class GetPlayerCombinedInfoRequestParams : PlayFabBaseModel { /// /// Whether to get character inventories. Defaults to false. /// public bool GetCharacterInventories; /// /// Whether to get the list of characters. Defaults to false. /// public bool GetCharacterList; /// /// Whether to get player profile. Defaults to false. Has no effect for a new player. /// public bool GetPlayerProfile; /// /// Whether to get player statistics. Defaults to false. /// public bool GetPlayerStatistics; /// /// Whether to get title data. Defaults to false. /// public bool GetTitleData; /// /// Whether to get the player's account Info. Defaults to false /// public bool GetUserAccountInfo; /// /// Whether to get the player's custom data. Defaults to false /// public bool GetUserData; /// /// Whether to get the player's inventory. Defaults to false /// public bool GetUserInventory; /// /// Whether to get the player's read only data. Defaults to false /// public bool GetUserReadOnlyData; /// /// Whether to get the player's virtual currency balances. Defaults to false /// public bool GetUserVirtualCurrency; /// /// Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false /// public List PlayerStatisticNames; /// /// Specifies the properties to return from the player profile. Defaults to returning the player's display name. /// public PlayerProfileViewConstraints ProfileConstraints; /// /// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false /// public List TitleDataKeys; /// /// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false /// public List UserDataKeys; /// /// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is /// false /// public List UserReadOnlyDataKeys; } [Serializable] public class GetPlayerCombinedInfoResult : PlayFabResultCommon { /// /// Results for requested info. /// public GetPlayerCombinedInfoResultPayload InfoResultPayload; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetPlayerCombinedInfoResultPayload : PlayFabBaseModel { /// /// Account information for the user. This is always retrieved. /// public UserAccountInfo AccountInfo; /// /// Inventories for each character for the user. /// public List CharacterInventories; /// /// List of characters for the user. /// public List CharacterList; /// /// The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not /// exist. /// public PlayerProfileModel PlayerProfile; /// /// List of statistics for this player. /// public List PlayerStatistics; /// /// Title data for this title. /// public Dictionary TitleData; /// /// User specific custom data. /// public Dictionary UserData; /// /// The version of the UserData that was returned. /// public uint UserDataVersion; /// /// Array of inventory items in the user's current inventory. /// public List UserInventory; /// /// User specific read-only data. /// public Dictionary UserReadOnlyData; /// /// The version of the Read-Only UserData that was returned. /// public uint UserReadOnlyDataVersion; /// /// Dictionary of virtual currency balance(s) belonging to the user. /// public Dictionary UserVirtualCurrency; /// /// Dictionary of remaining times and timestamps for virtual currencies. /// public Dictionary UserVirtualCurrencyRechargeTimes; } /// /// 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. /// [Serializable] public class GetPlayerProfileRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, /// only the allowed client profile properties for the title may be requested. These allowed properties are configured in /// the Game Manager "Client Profile Options" tab in the "Settings" section. /// public PlayerProfileViewConstraints ProfileConstraints; } [Serializable] public class GetPlayerProfileResult : PlayFabResultCommon { /// /// The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not /// exist. /// public PlayerProfileModel PlayerProfile; } [Serializable] public class GetPlayerSegmentsResult : PlayFabResultCommon { /// /// Array of segments the requested player currently belongs to. /// public List Segments; } /// /// Initial request must contain at least a Segment ID. Subsequent requests must contain the Segment ID as well as the /// Continuation Token. Failure to send the Continuation Token will result in a new player segment list being generated. /// Each time the Continuation Token is passed in the length of the Total Seconds to Live is refreshed. If too much time /// passes between requests to the point that a subsequent request is past the Total Seconds to Live an error will be /// returned and paging will be terminated. This API is resource intensive and should not be used in scenarios which might /// generate high request volumes. Only one request to this API at a time should be made per title. Concurrent requests to /// the API may be rejected with the APIConcurrentRequestLimitExceeded error. /// [Serializable] public class GetPlayersInSegmentRequest : PlayFabRequestCommon { /// /// Continuation token if retrieving subsequent pages of results. /// public string ContinuationToken; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If set to true, the profiles are loaded asynchronously and the response will include a continuation token and /// approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network /// timeouts. /// public bool? GetProfilesAsync; /// /// Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this /// segment. /// public uint? MaxBatchSize; /// /// Number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging /// results. Default is 300 (5 minutes). Maximum is 5,400 (90 minutes). /// public uint? SecondsToLive; /// /// Unique identifier for this segment. /// public string SegmentId; } [Serializable] public class GetPlayersInSegmentResult : PlayFabResultCommon { /// /// Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. /// public string ContinuationToken; /// /// Array of player profiles in this segment. /// public List PlayerProfiles; /// /// Count of profiles matching this segment. /// public int ProfilesInSegment; } [Serializable] public class GetPlayersSegmentsRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetPlayerStatisticsRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// user for whom statistics are being requested /// public string PlayFabId; /// /// statistics to return /// public List StatisticNames; /// /// statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be /// returned) /// public List StatisticNameVersions; } /// /// In addition to being available for use by the title, the statistics are used for all leaderboard operations in PlayFab. /// [Serializable] public class GetPlayerStatisticsResult : PlayFabResultCommon { /// /// PlayFab unique identifier of the user whose statistics are being returned /// public string PlayFabId; /// /// User statistics for the requested user. /// public List Statistics; } [Serializable] public class GetPlayerStatisticVersionsRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// unique name of the statistic /// public string StatisticName; } [Serializable] public class GetPlayerStatisticVersionsResult : PlayFabResultCommon { /// /// version change history of the statistic /// public List StatisticVersions; } /// /// 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. /// [Serializable] public class GetPlayerTagsRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Optional namespace to filter results by /// public string Namespace; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetPlayerTagsResult : PlayFabResultCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Canonical tags (including namespace and tag's name) for the requested user /// public List Tags; } [Serializable] public class GetPlayFabIDsFromFacebookIDsRequest : PlayFabRequestCommon { /// /// Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 /// in length. /// public List FacebookIDs; } /// /// For Facebook identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromFacebookIDsResult : PlayFabResultCommon { /// /// Mapping of Facebook identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromFacebookInstantGamesIdsRequest : PlayFabRequestCommon { /// /// Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array /// cannot exceed 25 in length. /// public List FacebookInstantGamesIds; } /// /// For Facebook Instant Games identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromFacebookInstantGamesIdsResult : PlayFabResultCommon { /// /// Mapping of Facebook Instant Games identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromGenericIDsRequest : PlayFabRequestCommon { /// /// Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a /// maximum of 10 in a single request. /// public List GenericIDs; } /// /// For generic service identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromGenericIDsResult : PlayFabResultCommon { /// /// Mapping of generic service identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromNintendoServiceAccountIdsRequest : PlayFabRequestCommon { /// /// Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array /// cannot exceed 2,000 in length. /// public List NintendoAccountIds; } /// /// For Nintendo Service Account identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromNintendoServiceAccountIdsResult : PlayFabResultCommon { /// /// Mapping of Nintendo Switch Service Account identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest : PlayFabRequestCommon { /// /// Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array /// cannot exceed 2,000 in length. /// public List NintendoSwitchDeviceIds; } /// /// For Nintendo Switch Device identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromNintendoSwitchDeviceIdsResult : PlayFabResultCommon { /// /// Mapping of Nintendo Switch Device identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromPSNAccountIDsRequest : PlayFabRequestCommon { /// /// Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. /// public int? IssuerId; /// /// Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array /// cannot exceed 2,000 in length. /// public List PSNAccountIDs; } /// /// For PlayStation :tm: Network identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromPSNAccountIDsResult : PlayFabResultCommon { /// /// Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromPSNOnlineIDsRequest : PlayFabRequestCommon { /// /// Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. /// public int? IssuerId; /// /// Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array /// cannot exceed 2,000 in length. /// public List PSNOnlineIDs; } /// /// For PlayStation :tm: Network identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromPSNOnlineIDsResult : PlayFabResultCommon { /// /// Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromSteamIDsRequest : PlayFabRequestCommon { /// /// Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array /// cannot exceed 2,000 in length. /// public List SteamStringIDs; } /// /// For Steam identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromSteamIDsResult : PlayFabResultCommon { /// /// Mapping of Steam identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromTwitchIDsRequest : PlayFabRequestCommon { /// /// Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot /// exceed 2,000 in length. /// public List TwitchIds; } /// /// For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromTwitchIDsResult : PlayFabResultCommon { /// /// Mapping of Twitch identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetPlayFabIDsFromXboxLiveIDsRequest : PlayFabRequestCommon { /// /// The ID of Xbox Live sandbox. /// public string Sandbox; /// /// Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot /// exceed 2,000 in length. /// public List XboxLiveAccountIDs; } /// /// For XboxLive identifiers which have not been linked to PlayFab accounts, null will be returned. /// [Serializable] public class GetPlayFabIDsFromXboxLiveIDsResult : PlayFabResultCommon { /// /// Mapping of Xbox Live identifiers to PlayFab identifiers. /// public List Data; } /// /// 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 helloplayfab@microsoft.com. Note that there may up /// to a minute delay in between updating title data and this API call returning the newest value. /// [Serializable] public class GetPublisherDataRequest : PlayFabRequestCommon { /// /// array of keys to get back data from the Publisher data blob, set by the admin tools /// public List Keys; } [Serializable] public class GetPublisherDataResult : PlayFabResultCommon { /// /// a dictionary object of key / value pairs /// public Dictionary Data; } [Serializable] public class GetRandomResultTablesRequest : PlayFabRequestCommon { /// /// Specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses /// default/primary catalog. /// public string CatalogVersion; /// /// The unique identifier of the Random Result Table to use. /// public List TableIDs; } /// /// Note that if a specified Random Result Table contains no entries, or does not exist in the catalog, an InvalidDropTable /// error will be returned. /// [Serializable] public class GetRandomResultTablesResult : PlayFabResultCommon { /// /// array of random result tables currently available /// public Dictionary Tables; } [Serializable] public class GetSegmentResult : PlayFabBaseModel { /// /// Identifier of the segments AB Test, if it is attached to one. /// public string ABTestParent; /// /// Unique identifier for this segment. /// public string Id; /// /// Segment name. /// public string Name; } [Serializable] public class GetServerCustomIDsFromPlayFabIDsRequest : PlayFabRequestCommon { /// /// Array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain /// more than 25 identifiers. /// public List PlayFabIDs; } /// /// For a PlayFab account that isn't associated with a server custom identity, ServerCustomId will be null. /// [Serializable] public class GetServerCustomIDsFromPlayFabIDsResult : PlayFabResultCommon { /// /// Mapping of server custom player identifiers to PlayFab identifiers. /// public List Data; } [Serializable] public class GetSharedGroupDataRequest : PlayFabRequestCommon { /// /// If true, return the list of all members of the shared group. /// public bool? GetMembers; /// /// Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array /// indicates that no keys should be returned). /// public List Keys; /// /// Unique identifier for the shared group. /// public string SharedGroupId; } [Serializable] public class GetSharedGroupDataResult : PlayFabResultCommon { /// /// Data for the requested keys. /// public Dictionary Data; /// /// List of PlayFabId identifiers for the members of this group, if requested. /// public List Members; } [Serializable] public class GetStoreItemsResult : PlayFabResultCommon { /// /// The base catalog that this store is a part of. /// public string CatalogVersion; /// /// Additional data about the store. /// public StoreMarketingModel MarketingData; /// /// How the store was last updated (Admin or a third party). /// public SourceType? Source; /// /// Array of items which can be purchased from this store. /// public List Store; /// /// The ID of this store. /// public string StoreId; } /// /// 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. /// [Serializable] public class GetStoreItemsServerRequest : PlayFabRequestCommon { /// /// Catalog version to store items from. Use default catalog version if null /// public string CatalogVersion; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Optional identifier for the player to use in requesting the store information - if used, segment overrides will be /// applied /// public string PlayFabId; /// /// Unqiue identifier for the store which is being requested /// public string StoreId; } /// /// 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. /// [Serializable] public class GetTimeRequest : PlayFabRequestCommon { } /// /// Time is always returned as Coordinated Universal Time (UTC). /// [Serializable] public class GetTimeResult : PlayFabResultCommon { /// /// Current server time when the request was received, in UTC /// public DateTime Time; } /// /// 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 an override label is specified in the request, 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. /// [Serializable] public class GetTitleDataRequest : PlayFabRequestCommon { /// /// Specific keys to search for in the title data (leave null to get all keys) /// public List Keys; /// /// Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, /// the overrides are applied automatically to the title data. /// public string OverrideLabel; } [Serializable] public class GetTitleDataResult : PlayFabResultCommon { /// /// a dictionary object of key / value pairs /// public Dictionary Data; } [Serializable] public class GetTitleNewsRequest : PlayFabRequestCommon { /// /// Limits the results to the last n entries. Defaults to 10 if not set. /// public int? Count; } [Serializable] public class GetTitleNewsResult : PlayFabResultCommon { /// /// Array of localized news items. /// public List News; } /// /// 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. /// [Serializable] public class GetUserAccountInfoRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetUserAccountInfoResult : PlayFabResultCommon { /// /// Account details for the user whose information was requested. /// public UserAccountInfo UserInfo; } /// /// Get all bans for a user, including inactive and expired bans. /// [Serializable] public class GetUserBansRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetUserBansResult : PlayFabResultCommon { /// /// Information about the bans /// public List BanData; } /// /// 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 user data will be returned. /// [Serializable] public class GetUserDataRequest : PlayFabRequestCommon { /// /// The version that currently exists according to the caller. The call will return the data for all of the keys if the /// version in the system is greater than this. /// public uint? IfChangedFromDataVersion; /// /// Specific keys to search for in the custom user data. /// public List Keys; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetUserDataResult : PlayFabResultCommon { /// /// User specific data for this title. /// public Dictionary Data; /// /// Indicates the current version of the data that has been set. This is incremented with every set call for that type of /// data (read-only, internal, etc). This version can be provided in Get calls to find updated data. /// public uint DataVersion; /// /// PlayFab unique identifier of the user whose custom data is being returned. /// public string PlayFabId; } /// /// 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. /// [Serializable] public class GetUserInventoryRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GetUserInventoryResult : PlayFabResultCommon { /// /// Array of inventory items belonging to the user. /// public List Inventory; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Array of virtual currency balance(s) belonging to the user. /// public Dictionary VirtualCurrency; /// /// Array of remaining times and timestamps for virtual currencies. /// public Dictionary VirtualCurrencyRechargeTimes; } /// /// Grants a character to the user of the type and name specified in the request. /// [Serializable] public class GrantCharacterToUserRequest : PlayFabRequestCommon { /// /// Non-unique display name of the character being granted (1-40 characters in length). /// public string CharacterName; /// /// Type of the character being granted; statistics can be sliced based on this value. /// public string CharacterType; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GrantCharacterToUserResult : PlayFabResultCommon { /// /// Unique identifier tagged to this character. /// public string CharacterId; } /// /// Result of granting an item to a user. 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. /// [Serializable] public class GrantedItemInstance : PlayFabBaseModel { /// /// Game specific comment associated with this instance when it was added to the user inventory. /// public string Annotation; /// /// Array of unique items that were awarded when this catalog item was purchased. /// public List BundleContents; /// /// Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or /// container. /// public string BundleParent; /// /// Catalog version for the inventory item, when this instance was created. /// public string CatalogVersion; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog /// item's custom data. /// public Dictionary CustomData; /// /// CatalogItem.DisplayName at the time this item was purchased. /// public string DisplayName; /// /// Timestamp for when this instance will expire. /// public DateTime? Expiration; /// /// Class name for the inventory item, as defined in the catalog. /// public string ItemClass; /// /// Unique identifier for the inventory item, as defined in the catalog. /// public string ItemId; /// /// Unique item identifier for this specific instance of the item. /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Timestamp for when this instance was purchased. /// public DateTime? PurchaseDate; /// /// Total number of remaining uses, if this is a consumable item. /// public int? RemainingUses; /// /// Result of this operation. /// public bool Result; /// /// Currency type for the cost of the catalog item. Not available when granting items. /// public string UnitCurrency; /// /// Cost of the catalog item in the given currency. Not available when granting items. /// public uint UnitPrice; /// /// The number of uses that were added or removed to this item in this call. /// public int? UsesIncrementedBy; } /// /// This function directly adds inventory items to the character's inventories. As a result of this operations, the user /// will not be charged any transaction fee, regardless of the inventory item catalog definition. 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. /// [Serializable] public class GrantItemsToCharacterRequest : PlayFabRequestCommon { /// /// String detailing any additional information concerning this operation. /// public string Annotation; /// /// Catalog version from which items are to be granted. /// public string CatalogVersion; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Array of itemIds to grant to the user. /// public List ItemIds; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class GrantItemsToCharacterResult : PlayFabResultCommon { /// /// Array of items granted to users. /// public List ItemGrantResults; } /// /// This function directly adds inventory items to the user's inventories. As a result of this operations, the user will not /// be charged any transaction fee, regardless of the inventory item catalog definition. 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. /// [Serializable] public class GrantItemsToUserRequest : PlayFabRequestCommon { /// /// String detailing any additional information concerning this operation. /// public string Annotation; /// /// Catalog version from which items are to be granted. /// public string CatalogVersion; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Array of itemIds to grant to the user. /// public List ItemIds; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// Please note that the order of the items in the response may not match the order of items in the request. /// [Serializable] public class GrantItemsToUserResult : PlayFabResultCommon { /// /// Array of items granted to users. /// public List ItemGrantResults; } /// /// This function directly adds inventory items to user inventories. As a result of this operations, the user will not be /// charged any transaction fee, regardless of the inventory item catalog definition. 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. /// [Serializable] public class GrantItemsToUsersRequest : PlayFabRequestCommon { /// /// Catalog version from which items are to be granted. /// public string CatalogVersion; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Array of items to grant and the users to whom the items are to be granted. /// public List ItemGrants; } /// /// Please note that the order of the items in the response may not match the order of items in the request. /// [Serializable] public class GrantItemsToUsersResult : PlayFabResultCommon { /// /// Array of items granted to users. /// public List ItemGrantResults; } [Serializable] public class ItemGrant : PlayFabBaseModel { /// /// String detailing any additional information concerning this operation. /// public string Annotation; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Unique identifier of the catalog item to be granted to the user. /// public string ItemId; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// 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. /// [Serializable] public class ItemInstance : PlayFabBaseModel { /// /// Game specific comment associated with this instance when it was added to the user inventory. /// public string Annotation; /// /// Array of unique items that were awarded when this catalog item was purchased. /// public List BundleContents; /// /// Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or /// container. /// public string BundleParent; /// /// Catalog version for the inventory item, when this instance was created. /// public string CatalogVersion; /// /// A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog /// item's custom data. /// public Dictionary CustomData; /// /// CatalogItem.DisplayName at the time this item was purchased. /// public string DisplayName; /// /// Timestamp for when this instance will expire. /// public DateTime? Expiration; /// /// Class name for the inventory item, as defined in the catalog. /// public string ItemClass; /// /// Unique identifier for the inventory item, as defined in the catalog. /// public string ItemId; /// /// Unique item identifier for this specific instance of the item. /// public string ItemInstanceId; /// /// Timestamp for when this instance was purchased. /// public DateTime? PurchaseDate; /// /// Total number of remaining uses, if this is a consumable item. /// public int? RemainingUses; /// /// Currency type for the cost of the catalog item. Not available when granting items. /// public string UnitCurrency; /// /// Cost of the catalog item in the given currency. Not available when granting items. /// public uint UnitPrice; /// /// The number of uses that were added or removed to this item in this call. /// public int? UsesIncrementedBy; } [Serializable] public class LinkedPlatformAccountModel : PlayFabBaseModel { /// /// Linked account email of the user on the platform, if available /// public string Email; /// /// Authentication platform /// public LoginIdentityProvider? Platform; /// /// Unique account identifier of the user on the platform /// public string PlatformUserId; /// /// Linked account username of the user on the platform, if available /// public string Username; } [Serializable] public class LinkNintendoServiceAccountRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link. /// public bool? ForceLink; /// /// The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo /// Switch subject) to link with. /// public string IdentityToken; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class LinkNintendoServiceAccountSubjectRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to a specific Nintendo Service Account, unlink the other user and re-link. /// public bool? ForceLink; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// The Nintendo Service Account subject or id to link to the PlayFab user. /// public string Subject; } [Serializable] public class LinkNintendoSwitchDeviceIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. /// public bool? ForceLink; /// /// Nintendo Switch unique identifier for the user's device. /// public string NintendoSwitchDeviceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class LinkNintendoSwitchDeviceIdResult : PlayFabResultCommon { } [Serializable] public class LinkPSNAccountRequest : PlayFabRequestCommon { /// /// Authentication code provided by the PlayStation :tm: Network. /// public string AuthCode; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the account, unlink the other user and re-link. /// public bool? ForceLink; /// /// Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. /// public int? IssuerId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Redirect URI supplied to PlayStation :tm: Network when requesting an auth code /// public string RedirectUri; } [Serializable] public class LinkPSNAccountResult : PlayFabResultCommon { } [Serializable] public class LinkPSNIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the account, unlink the other user and re-link. /// public bool? ForceLink; /// /// Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. /// public int? IssuerId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Id of the PlayStation :tm: Network user. Also known as the PSN Account Id. /// public string PSNUserId; } [Serializable] public class LinkPSNIdResponse : PlayFabResultCommon { } [Serializable] public class LinkServerCustomIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the custom ID, unlink the other user and re-link. /// public bool? ForceLink; /// /// Unique PlayFab identifier. /// public string PlayFabId; /// /// Unique server custom identifier for this player. /// public string ServerCustomId; } [Serializable] public class LinkServerCustomIdResult : PlayFabResultCommon { } [Serializable] public class LinkSteamIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the account, unlink the other user and re-link. /// public bool? ForceLink; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. /// public string PlayFabId; /// /// Unique Steam identifier for a user. /// public string SteamId; } [Serializable] public class LinkSteamIdResult : PlayFabResultCommon { } [Serializable] public class LinkXboxAccountRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// If another user is already linked to the account, unlink the other user and re-link. /// public bool? ForceLink; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. /// public string PlayFabId; /// /// Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). /// public string XboxToken; } [Serializable] public class LinkXboxAccountResult : PlayFabResultCommon { } /// /// Returns a list of every character that currently belongs to a user. /// [Serializable] public class ListUsersCharactersRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class ListUsersCharactersResult : PlayFabResultCommon { /// /// The requested list of characters. /// public List Characters; } /// /// Contains the localized push notification content. /// [Serializable] public class LocalizedPushNotificationProperties : PlayFabBaseModel { /// /// Message of the localized push notification template. /// public string Message; /// /// Subject of the localized push notification template. /// public string Subject; } [Serializable] public class LocationModel : PlayFabBaseModel { /// /// City name. /// public string City; /// /// The two-character continent code for this location /// public ContinentCode? ContinentCode; /// /// The two-character ISO 3166-1 country code for the country associated with the location /// public CountryCode? CountryCode; /// /// Latitude coordinate of the geographic location. /// public double? Latitude; /// /// Longitude coordinate of the geographic location. /// public double? Longitude; } public enum LoginIdentityProvider { Unknown, PlayFab, Custom, GameCenter, GooglePlay, Steam, XBoxLive, PSN, Kongregate, Facebook, IOSDevice, AndroidDevice, Twitch, WindowsHello, GameServer, CustomServer, NintendoSwitch, FacebookInstantGames, OpenIdConnect, Apple, NintendoSwitchAccount, GooglePlayGames, XboxMobileStore, King } /// /// If this is the first time a user has signed in with the PlayStation :tm: Network account and CreateAccount is set to /// true, a new PlayFab account will be created and linked to the PlayStation :tm: Network account. In this case, no email /// or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the PlayStation /// :tm: Network account, an error indicating this will be returned, so that the title can guide the user through creation /// of a PlayFab account. /// [Serializable] public class LoginWithPSNRequest : PlayFabRequestCommon { /// /// Auth code provided by the PlayStation :tm: Network OAuth provider. /// public string AuthCode; /// /// Automatically create a PlayFab account if one is not currently linked to this ID. /// public bool? CreateAccount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. /// public int? IssuerId; /// /// Redirect URI supplied to PlayStation :tm: Network when requesting an auth code /// public string RedirectUri; } [Serializable] public class LoginWithServerCustomIdRequest : PlayFabRequestCommon { /// /// Automatically create a PlayFab account if one is not currently linked to this ID. /// public bool? CreateAccount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// Player secret that is used to verify API request signatures (Enterprise Only). /// public string PlayerSecret; /// /// The backend server identifier for this player. /// public string ServerCustomId; } /// /// If this is the first time a user has signed in with the Steam ID and CreateAccount is set to true, a new PlayFab account /// will be created and linked to the Steam account. 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. Steam users that are not logged into the Steam /// Client app will only have their Steam username synced, other data, such as currency and country will not be available /// until they login while the Client is open. /// [Serializable] public class LoginWithSteamIdRequest : PlayFabRequestCommon { /// /// Automatically create a PlayFab account if one is not currently linked to this ID. /// public bool? CreateAccount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// Unique Steam identifier for a user. /// public string SteamId; } /// /// If this is the first time a user has signed in with the Xbox ID 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. /// [Serializable] public class LoginWithXboxIdRequest : PlayFabRequestCommon { /// /// Automatically create a PlayFab account if one is not currently linked to this ID. /// public bool? CreateAccount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// The id of Xbox Live sandbox. /// public string Sandbox; /// /// Unique Xbox identifier for a user. /// public string XboxId; } /// /// 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. /// [Serializable] public class LoginWithXboxRequest : PlayFabRequestCommon { /// /// Automatically create a PlayFab account if one is not currently linked to this ID. /// public bool? CreateAccount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Flags for which pieces of info to return for the user. /// public GetPlayerCombinedInfoRequestParams InfoRequestParameters; /// /// Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). /// public string XboxToken; } [Serializable] public class LogStatement : PlayFabBaseModel { /// /// Optional object accompanying the message as contextual information /// public object Data; /// /// 'Debug', 'Info', or 'Error' /// public string Level; public string Message; } [Serializable] public class MembershipModel : PlayFabBaseModel { /// /// Whether this membership is active. That is, whether the MembershipExpiration time has been reached. /// public bool IsActive; /// /// The time this membership expires /// public DateTime MembershipExpiration; /// /// The id of the membership /// public string MembershipId; /// /// Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been /// overridden, this will be the new expiration time. /// public DateTime? OverrideExpiration; /// /// The list of subscriptions that this player has for this membership /// public List Subscriptions; } [Serializable] public class ModifyCharacterVirtualCurrencyResult : PlayFabResultCommon { /// /// Balance of the virtual currency after modification. /// public int Balance; /// /// Name of the virtual currency which was modified. /// public string VirtualCurrency; } /// /// This function can both add and remove uses of an inventory item. If the number of uses drops below zero, the item will /// be removed from active inventory. /// [Serializable] public class ModifyItemUsesRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique instance identifier of the item to be modified. /// public string ItemInstanceId; /// /// PlayFab unique identifier of the user whose item is being modified. /// public string PlayFabId; /// /// Number of uses to add to the item. Can be negative to remove uses. /// public int UsesToAdd; } [Serializable] public class ModifyItemUsesResult : PlayFabResultCommon { /// /// Unique instance identifier of the item with uses consumed. /// public string ItemInstanceId; /// /// Number of uses remaining on the item. /// public int RemainingUses; } [Serializable] public class ModifyUserVirtualCurrencyResult : PlayFabResultCommon { /// /// Balance of the virtual currency after modification. /// public int Balance; /// /// Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase /// over this value will be discarded. /// public int BalanceChange; /// /// User currency was subtracted from. /// public string PlayFabId; /// /// Name of the virtual currency which was modified. /// public string VirtualCurrency; } /// /// Transfers an item from a character to another character that is owned by the same user. This will remove the item from /// the character's inventory (until and unless it is moved back), and will enable the other character to make use of the /// item instead. /// [Serializable] public class MoveItemToCharacterFromCharacterRequest : PlayFabRequestCommon { /// /// Unique identifier of the character that currently has the item. /// public string GivingCharacterId; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Unique identifier of the character that will be receiving the item. /// public string ReceivingCharacterId; } [Serializable] public class MoveItemToCharacterFromCharacterResult : PlayFabResultCommon { } /// /// Transfers an item from a user to a character she owns. This will remove the item from the user's inventory (until and /// unless it is moved back), and will enable the character to make use of the item instead. /// [Serializable] public class MoveItemToCharacterFromUserRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class MoveItemToCharacterFromUserResult : PlayFabResultCommon { } /// /// Transfers an item from a character to the owning user. This will remove the item from the character's inventory (until /// and unless it is moved back), and will enable the user to make use of the item instead. /// [Serializable] public class MoveItemToUserFromCharacterRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class MoveItemToUserFromCharacterResult : PlayFabResultCommon { } [Serializable] public class NintendoServiceAccountPlayFabIdPair : PlayFabBaseModel { /// /// Unique Nintendo Switch Service Account identifier for a user. /// public string NintendoServiceAccountId; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Service Account /// identifier. /// public string PlayFabId; } [Serializable] public class NintendoSwitchPlayFabIdPair : PlayFabBaseModel { /// /// Unique Nintendo Switch Device identifier for a user. /// public string NintendoSwitchDeviceId; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier. /// public string PlayFabId; } [Serializable] public class PlayerLeaderboardEntry : PlayFabBaseModel { /// /// Title-specific display name of the user for this leaderboard entry. /// public string DisplayName; /// /// PlayFab unique identifier of the user for this leaderboard entry. /// public string PlayFabId; /// /// User's overall position in the leaderboard. /// public int Position; /// /// The profile of the user, if requested. /// public PlayerProfileModel Profile; /// /// Specific value of the user's statistic. /// public int StatValue; } [Serializable] public class PlayerLinkedAccount : PlayFabBaseModel { /// /// Linked account's email /// public string Email; /// /// Authentication platform /// public LoginIdentityProvider? Platform; /// /// Platform user identifier /// public string PlatformUserId; /// /// Linked account's username /// public string Username; } [Serializable] public class PlayerLocation : PlayFabBaseModel { /// /// City of the player's geographic location. /// public string City; /// /// The two-character continent code for this location /// public ContinentCode ContinentCode; /// /// The two-character ISO 3166-1 country code for the country associated with the location /// public CountryCode CountryCode; /// /// Latitude coordinate of the player's geographic location. /// public double? Latitude; /// /// Longitude coordinate of the player's geographic location. /// public double? Longitude; } [Serializable] public class PlayerProfile : PlayFabBaseModel { /// /// Array of ad campaigns player has been attributed to /// public List AdCampaignAttributions; /// /// Image URL of the player's avatar. /// public string AvatarUrl; /// /// Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. /// public DateTime? BannedUntil; /// /// The prediction of the player to churn within the next seven days. /// public ChurnRiskLevel? ChurnPrediction; /// /// Array of contact email addresses associated with the player /// public List ContactEmailAddresses; /// /// Player record created /// public DateTime? Created; /// /// Player Display Name /// public string DisplayName; /// /// Last login /// public DateTime? LastLogin; /// /// Array of third party accounts linked to this player /// public List LinkedAccounts; /// /// Dictionary of player's locations by type. /// public Dictionary Locations; /// /// Player account origination /// public LoginIdentityProvider? Origination; /// /// List of player variants for experimentation /// public List PlayerExperimentVariants; /// /// PlayFab Player ID /// public string PlayerId; /// /// Array of player statistics /// public List PlayerStatistics; /// /// Publisher this player belongs to /// public string PublisherId; /// /// Array of configured push notification end points /// public List PushNotificationRegistrations; /// /// Dictionary of player's statistics using only the latest version's value /// public Dictionary Statistics; /// /// List of player's tags for segmentation. /// public List Tags; /// /// Title ID this profile applies to /// public string TitleId; /// /// A sum of player's total purchases in USD across all currencies. /// public uint? TotalValueToDateInUSD; /// /// Dictionary of player's total purchases by currency. /// public Dictionary ValuesToDate; /// /// Dictionary of player's virtual currency balances /// public Dictionary VirtualCurrencyBalances; } [Serializable] public class PlayerProfileModel : PlayFabBaseModel { /// /// List of advertising campaigns the player has been attributed to /// public List AdCampaignAttributions; /// /// URL of the player's avatar image /// public string AvatarUrl; /// /// If the player is currently banned, the UTC Date when the ban expires /// public DateTime? BannedUntil; /// /// List of all contact email info associated with the player account /// public List ContactEmailAddresses; /// /// Player record created /// public DateTime? Created; /// /// Player display name /// public string DisplayName; /// /// List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned /// during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment /// property during login to get the correct variants and variables. /// public List ExperimentVariants; /// /// UTC time when the player most recently logged in to the title /// public DateTime? LastLogin; /// /// List of all authentication systems linked to this player account /// public List LinkedAccounts; /// /// List of geographic locations from which the player has logged in to the title /// public List Locations; /// /// List of memberships for the player, along with whether are expired. /// public List Memberships; /// /// Player account origination /// public LoginIdentityProvider? Origination; /// /// PlayFab player account unique identifier /// public string PlayerId; /// /// Publisher this player belongs to /// public string PublisherId; /// /// List of configured end points registered for sending the player push notifications /// public List PushNotificationRegistrations; /// /// List of leaderboard statistic values for the player /// public List Statistics; /// /// List of player's tags for segmentation /// public List Tags; /// /// Title ID this player profile applies to /// public string TitleId; /// /// Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a /// whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents. /// public uint? TotalValueToDateInUSD; /// /// List of the player's lifetime purchase totals, summed by real-money currency /// public List ValuesToDate; } [Serializable] public class PlayerProfileViewConstraints : PlayFabBaseModel { /// /// Whether to show player's avatar URL. Defaults to false /// public bool ShowAvatarUrl; /// /// Whether to show the banned until time. Defaults to false /// public bool ShowBannedUntil; /// /// Whether to show campaign attributions. Defaults to false /// public bool ShowCampaignAttributions; /// /// Whether to show contact email addresses. Defaults to false /// public bool ShowContactEmailAddresses; /// /// Whether to show the created date. Defaults to false /// public bool ShowCreated; /// /// Whether to show the display name. Defaults to false /// public bool ShowDisplayName; /// /// Whether to show player's experiment variants. Defaults to false /// public bool ShowExperimentVariants; /// /// Whether to show the last login time. Defaults to false /// public bool ShowLastLogin; /// /// Whether to show the linked accounts. Defaults to false /// public bool ShowLinkedAccounts; /// /// Whether to show player's locations. Defaults to false /// public bool ShowLocations; /// /// Whether to show player's membership information. Defaults to false /// public bool ShowMemberships; /// /// Whether to show origination. Defaults to false /// public bool ShowOrigination; /// /// Whether to show push notification registrations. Defaults to false /// public bool ShowPushNotificationRegistrations; /// /// Reserved for future development /// public bool ShowStatistics; /// /// Whether to show tags. Defaults to false /// public bool ShowTags; /// /// Whether to show the total value to date in usd. Defaults to false /// public bool ShowTotalValueToDateInUsd; /// /// Whether to show the values to date. Defaults to false /// public bool ShowValuesToDate; } [Serializable] public class PlayerStatistic : PlayFabBaseModel { /// /// Statistic ID /// public string Id; /// /// Statistic name /// public string Name; /// /// Current statistic value /// public int StatisticValue; /// /// Statistic version (0 if not a versioned statistic) /// public int StatisticVersion; } [Serializable] public class PlayerStatisticVersion : PlayFabBaseModel { /// /// time when the statistic version became active /// public DateTime ActivationTime; /// /// time when the statistic version became inactive due to statistic version incrementing /// public DateTime? DeactivationTime; /// /// time at which the statistic version was scheduled to become active, based on the configured ResetInterval /// public DateTime? ScheduledActivationTime; /// /// time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval /// public DateTime? ScheduledDeactivationTime; /// /// name of the statistic when the version became active /// public string StatisticName; /// /// version of the statistic /// public uint Version; } [Serializable] public class PSNAccountPlayFabIdPair : PlayFabBaseModel { /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network /// identifier. /// public string PlayFabId; /// /// Unique PlayStation :tm: Network identifier for a user. /// public string PSNAccountId; } [Serializable] public class PSNOnlinePlayFabIdPair : PlayFabBaseModel { /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network /// identifier. /// public string PlayFabId; /// /// Unique PlayStation :tm: Network identifier for a user. /// public string PSNOnlineId; } [Serializable] public class PushNotificationPackage : PlayFabBaseModel { /// /// Numerical badge to display on App icon (iOS only) /// public int Badge; /// /// This must be a JSON formatted object. For use with developer-created custom Push Notification plugins /// public string CustomData; /// /// Icon file to display with the message (Not supported for iOS) /// public string Icon; /// /// Content of the message (all platforms) /// public string Message; /// /// Sound file to play with the message (all platforms) /// public string Sound; /// /// Title/Subject of the message. Not supported for iOS /// public string Title; } public enum PushNotificationPlatform { ApplePushNotificationService, GoogleCloudMessaging } [Serializable] public class PushNotificationRegistration : PlayFabBaseModel { /// /// Notification configured endpoint /// public string NotificationEndpointARN; /// /// Push notification platform /// public PushNotificationPlatform? Platform; } [Serializable] public class PushNotificationRegistrationModel : PlayFabBaseModel { /// /// Notification configured endpoint /// public string NotificationEndpointARN; /// /// Push notification platform /// public PushNotificationPlatform? Platform; } [Serializable] public class RandomResultTableListing : PlayFabBaseModel { /// /// Catalog version this table is associated with /// public string CatalogVersion; /// /// Child nodes that indicate what kind of drop table item this actually is. /// public List Nodes; /// /// Unique name for this drop table /// public string TableId; } /// /// 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. /// [Serializable] public class RedeemCouponRequest : PlayFabRequestCommon { /// /// Catalog version of the coupon. /// public string CatalogVersion; /// /// Optional identifier for the Character that should receive the item. If null, item is added to the player /// public string CharacterId; /// /// Generated coupon code to redeem. /// public string CouponCode; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class RedeemCouponResult : PlayFabResultCommon { /// /// Items granted to the player as a result of redeeming the coupon. /// public List GrantedItems; } [Serializable] public class RemoveFriendRequest : PlayFabRequestCommon { /// /// PlayFab identifier of the friend account which is to be removed. /// public string FriendPlayFabId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class RemoveGenericIDRequest : PlayFabRequestCommon { /// /// Generic service identifier to be removed from the player. /// public GenericServiceId GenericId; /// /// PlayFabId of the user to remove. /// public string PlayFabId; } /// /// This API will trigger a player_tag_removed event and remove a tag with the given TagName and PlayFabID from the /// corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters /// [Serializable] public class RemovePlayerTagRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Unique tag for player profile. /// public string TagName; } [Serializable] public class RemovePlayerTagResult : PlayFabResultCommon { } [Serializable] public class RemoveSharedGroupMembersRequest : PlayFabRequestCommon { /// /// An array of unique PlayFab assigned ID of the user on whom the operation will be performed. /// public List PlayFabIds; /// /// Unique identifier for the shared group. /// public string SharedGroupId; } [Serializable] public class RemoveSharedGroupMembersResult : PlayFabResultCommon { } [Serializable] public class ReportPlayerServerRequest : PlayFabRequestCommon { /// /// Optional additional comment by reporting player. /// public string Comment; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab identifier of the reported player. /// public string ReporteeId; /// /// PlayFabId of the reporting player. /// public string ReporterId; } /// /// 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. /// [Serializable] public class ReportPlayerServerResult : PlayFabResultCommon { /// /// The number of remaining reports which may be filed today by this reporting player. /// public int SubmissionsRemaining; } [Serializable] public class ResultTableNode : PlayFabBaseModel { /// /// Either an ItemId, or the TableId of another random result table /// public string ResultItem; /// /// Whether this entry in the table is an item or a link to another table /// public ResultTableNodeType ResultItemType; /// /// How likely this is to be rolled - larger numbers add more weight /// public int Weight; } public enum ResultTableNodeType { ItemId, TableId } /// /// Setting the active state of all non-expired bans for a user to Inactive. Expired bans with an Active state will be /// ignored, however. Returns information about applied updates only. /// [Serializable] public class RevokeAllBansForUserRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class RevokeAllBansForUserResult : PlayFabResultCommon { /// /// Information on the bans that were revoked. /// public List BanData; } /// /// Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds /// that do not exist will be skipped. Returns information about applied updates only. /// [Serializable] public class RevokeBansRequest : PlayFabRequestCommon { /// /// Ids of the bans to be revoked. Maximum 100. /// public List BanIds; } [Serializable] public class RevokeBansResult : PlayFabResultCommon { /// /// Information on the bans that were revoked /// public List BanData; } [Serializable] public class RevokeInventoryItem : PlayFabBaseModel { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// In cases where the inventory item in question is a "crate", and the items it contained have already been dispensed, this /// will not revoke access or otherwise remove the items which were dispensed. /// [Serializable] public class RevokeInventoryItemRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// In cases where the inventory item in question is a "crate", and the items it contained have already been dispensed, this /// will not revoke access or otherwise remove the items which were dispensed. /// [Serializable] public class RevokeInventoryItemsRequest : PlayFabRequestCommon { /// /// Array of player items to revoke, between 1 and 25 items. /// public List Items; } [Serializable] public class RevokeInventoryItemsResult : PlayFabResultCommon { /// /// Collection of any errors that occurred during processing. /// public List Errors; } [Serializable] public class RevokeInventoryResult : PlayFabResultCommon { } [Serializable] public class RevokeItemError : PlayFabBaseModel { /// /// Specific error that was encountered. /// public GenericErrorCodes? Error; /// /// Item information that failed to be revoked. /// public RevokeInventoryItem Item; } /// /// Represents the save push notification template request. /// [Serializable] public class SavePushNotificationTemplateRequest : PlayFabRequestCommon { /// /// Android JSON for the notification template. /// public string AndroidPayload; /// /// Id of the push notification template. /// public string Id; /// /// IOS JSON for the notification template. /// public string IOSPayload; /// /// Dictionary of localized push notification templates with the language as the key. /// public Dictionary LocalizedPushNotificationTemplates; /// /// Name of the push notification template. /// public string Name; } /// /// Represents the save push notification template result. /// [Serializable] public class SavePushNotificationTemplateResult : PlayFabResultCommon { /// /// Id of the push notification template that was saved. /// public string PushNotificationTemplateId; } [Serializable] public class ScriptExecutionError : PlayFabBaseModel { /// /// Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded, /// CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError /// public string Error; /// /// Details about the error /// public string Message; /// /// Point during the execution of the script at which the error occurred, if any /// public string StackTrace; } /// /// PlayFab accounts which have valid email address or username will be able to receive a password reset email using this /// API.The email sent must be an account recovery email template. The username or email can be passed in to send the email /// [Serializable] public class SendCustomAccountRecoveryEmailRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// User email address attached to their account /// public string Email; /// /// The email template id of the account recovery email template to send. /// public string EmailTemplateId; /// /// The user's username requesting an account recovery. /// public string Username; } [Serializable] public class SendCustomAccountRecoveryEmailResult : PlayFabResultCommon { } /// /// Sends an email for only players that have contact emails associated with them. Takes in an email template ID /// specifyingthe email template to send. /// [Serializable] public class SendEmailFromTemplateRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// The email template id of the email template to send. /// public string EmailTemplateId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class SendEmailFromTemplateResult : PlayFabResultCommon { } /// /// Represents the request for sending a push notification template to a recipient. /// [Serializable] public class SendPushNotificationFromTemplateRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Id of the push notification template. /// public string PushNotificationTemplateId; /// /// PlayFabId of the push notification recipient. /// public string Recipient; } [Serializable] public class SendPushNotificationRequest : PlayFabRequestCommon { /// /// Allows you to provide precisely formatted json to target devices. This is an advanced feature, allowing you to deliver /// to custom plugin logic, fields, or functionality not natively supported by PlayFab. /// public List AdvancedPlatformDelivery; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Text of message to send. /// public string Message; /// /// Defines all possible push attributes like message, title, icon, etc. Some parameters are device specific - please see /// the PushNotificationPackage documentation for details. /// public PushNotificationPackage Package; /// /// PlayFabId of the recipient of the push notification. /// public string Recipient; /// /// Subject of message to send (may not be displayed in all platforms) /// public string Subject; /// /// Target Platforms that should receive the Message or Package. If omitted, we will send to all available platforms. /// public List TargetPlatforms; } [Serializable] public class SendPushNotificationResult : PlayFabResultCommon { } [Serializable] public class ServerCustomIDPlayFabIDPair : PlayFabBaseModel { /// /// Unique PlayFab identifier. /// public string PlayFabId; /// /// Unique server custom identifier for this player. /// public string ServerCustomId; } [Serializable] public class ServerLoginResult : PlayFabResultCommon { /// /// If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and /// returned. /// public EntityTokenResponse EntityToken; /// /// Results for requested info. /// public GetPlayerCombinedInfoResultPayload InfoResultPayload; /// /// The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue /// public DateTime? LastLoginTime; /// /// True if the account was newly created on this login. /// public bool NewlyCreated; /// /// Player's unique PlayFabId. /// public string PlayFabId; /// /// Unique token authorizing the user and game at the server level, for the current session. /// public string SessionTicket; /// /// Settings specific to this user. /// public UserSettings SettingsForUser; /// /// The experimentation treatments for this user at the time of login. /// public TreatmentAssignment TreatmentAssignment; } /// /// 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. /// [Serializable] public class SetFriendTagsRequest : PlayFabRequestCommon { /// /// PlayFab identifier of the friend account to which the tag(s) should be applied. /// public string FriendPlayFabId; /// /// PlayFab identifier of the player whose friend is to be updated. /// public string PlayFabId; /// /// Array of tags to set on the friend account. /// public List Tags; } /// /// 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. /// [Serializable] public class SetPlayerSecretRequest : PlayFabRequestCommon { /// /// Player secret that is used to verify API request signatures (Enterprise Only). /// public string PlayerSecret; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class SetPlayerSecretResult : PlayFabResultCommon { } /// /// This API is designed to store 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. This operation is additive. If a Key does not exist in the current dataset, it /// will be added with the specified Value. If it already exists, the Value for that key will be overwritten with the new /// Value. For more information email helloplayfab@microsoft.com /// [Serializable] public class SetPublisherDataRequest : PlayFabRequestCommon { /// /// key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same /// name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character. /// public string Key; /// /// new value to set. Set to null to remove a value /// public string Value; } [Serializable] public class SetPublisherDataResult : PlayFabResultCommon { } /// /// This API is designed to store 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. This operation is additive. If a Key does not exist in the current dataset, it will be added with the specified /// Value. If it already exists, the Value for that key will be overwritten with the new Value. /// [Serializable] public class SetTitleDataRequest : PlayFabRequestCommon { /// /// key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same /// name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character. /// public string Key; /// /// new value to set. Set to null to remove a value /// public string Value; } [Serializable] public class SetTitleDataResult : PlayFabResultCommon { } [Serializable] public class SharedGroupDataRecord : PlayFabBaseModel { /// /// Timestamp for when this data was last updated. /// public DateTime LastUpdated; /// /// PlayFabId of the user to last update this value. /// public string LastUpdatedBy; /// /// Indicates whether this data can be read by all users (public) or only members of the group (private). /// public UserDataPermission? Permission; /// /// Data stored for the specified group data key. /// public string Value; } public enum SourceType { Admin, BackEnd, GameClient, GameServer, Partner, Custom, API } [Serializable] public class StatisticModel : PlayFabBaseModel { /// /// Statistic name /// public string Name; /// /// Statistic value /// public int Value; /// /// Statistic version (0 if not a versioned statistic) /// public int Version; } [Serializable] public class StatisticNameVersion : PlayFabBaseModel { /// /// unique name of the statistic /// public string StatisticName; /// /// the version of the statistic to be returned /// public uint Version; } [Serializable] public class StatisticUpdate : PlayFabBaseModel { /// /// unique name of the statistic /// public string StatisticName; /// /// statistic value for the player /// public int Value; /// /// for updates to an existing statistic value for a player, the version of the statistic when it was loaded. Null when /// setting the statistic value for the first time. /// public uint? Version; } [Serializable] public class StatisticValue : PlayFabBaseModel { /// /// unique name of the statistic /// public string StatisticName; /// /// statistic value for the player /// public int Value; /// /// for updates to an existing statistic value for a player, the version of the statistic when it was loaded /// public uint Version; } [Serializable] public class SteamPlayFabIdPair : PlayFabBaseModel { /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. /// public string PlayFabId; /// /// Unique Steam identifier for a user. /// public string SteamStringId; } /// /// A store entry that list a catalog item at a particular price /// [Serializable] public class StoreItem : PlayFabBaseModel { /// /// Store specific custom data. The data only exists as part of this store; it is not transferred to item instances /// public object CustomData; /// /// Intended display position for this item. Note that 0 is the first position /// public uint? DisplayPosition; /// /// Unique identifier of the item as it exists in the catalog - note that this must exactly match the ItemId from the /// catalog /// public string ItemId; /// /// Override prices for this item for specific currencies /// public Dictionary RealCurrencyPrices; /// /// Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) /// public Dictionary VirtualCurrencyPrices; } /// /// Marketing data about a specific store /// [Serializable] public class StoreMarketingModel : PlayFabBaseModel { /// /// Tagline for a store. /// public string Description; /// /// Display name of a store as it will appear to users. /// public string DisplayName; /// /// Custom data about a store. /// public object Metadata; } [Serializable] public class SubscriptionModel : PlayFabBaseModel { /// /// When this subscription expires. /// public DateTime Expiration; /// /// The time the subscription was orignially purchased /// public DateTime InitialSubscriptionTime; /// /// Whether this subscription is currently active. That is, if Expiration > now. /// public bool IsActive; /// /// The status of this subscription, according to the subscription provider. /// public SubscriptionProviderStatus? Status; /// /// The id for this subscription /// public string SubscriptionId; /// /// The item id for this subscription from the primary catalog /// public string SubscriptionItemId; /// /// The provider for this subscription. Apple or Google Play are supported today. /// public string SubscriptionProvider; } public enum SubscriptionProviderStatus { NoError, Cancelled, UnknownError, BillingError, ProductUnavailable, CustomerDidNotAcceptPriceChange, FreeTrial, PaymentPending } [Serializable] public class SubtractCharacterVirtualCurrencyRequest : PlayFabRequestCommon { /// /// Amount to be subtracted from the user balance of the specified virtual currency. /// public int Amount; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Name of the virtual currency which is to be decremented. /// public string VirtualCurrency; } [Serializable] public class SubtractUserVirtualCurrencyRequest : PlayFabRequestCommon { /// /// Amount to be subtracted from the user balance of the specified virtual currency. /// public int Amount; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// PlayFab unique identifier of the user whose virtual currency balance is to be decreased. /// public string PlayFabId; /// /// Name of the virtual currency which is to be decremented. /// public string VirtualCurrency; } [Serializable] public class TagModel : PlayFabBaseModel { /// /// Full value of the tag, including namespace /// public string TagValue; } public enum TitleActivationStatus { None, ActivatedTitleKey, PendingSteam, ActivatedSteam, RevokedSteam } [Serializable] public class TitleNewsItem : PlayFabBaseModel { /// /// News item body. /// public string Body; /// /// Unique identifier of news item. /// public string NewsId; /// /// Date and time when the news item was posted. /// public DateTime Timestamp; /// /// Title of the news item. /// public string Title; } [Serializable] public class TreatmentAssignment : PlayFabBaseModel { /// /// List of the experiment variables. /// public List Variables; /// /// List of the experiment variants. /// public List Variants; } [Serializable] public class TwitchPlayFabIdPair : PlayFabBaseModel { /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Twitch identifier. /// public string PlayFabId; /// /// Unique Twitch identifier for a user. /// public string TwitchId; } [Serializable] public class UnlinkNintendoServiceAccountRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UnlinkNintendoSwitchDeviceIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Nintendo Switch Device identifier for the user. If not specified, the most recently signed in device ID will be used. /// public string NintendoSwitchDeviceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UnlinkNintendoSwitchDeviceIdResult : PlayFabResultCommon { } [Serializable] public class UnlinkPSNAccountRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UnlinkPSNAccountResult : PlayFabResultCommon { } [Serializable] public class UnlinkServerCustomIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab identifier. /// public string PlayFabId; /// /// Unique server custom identifier for this player. /// public string ServerCustomId; } [Serializable] public class UnlinkServerCustomIdResult : PlayFabResultCommon { } [Serializable] public class UnlinkSteamIdRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam account. /// public string PlayFabId; } [Serializable] public class UnlinkSteamIdResult : PlayFabResultCommon { } [Serializable] public class UnlinkXboxAccountRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. /// public string PlayFabId; } [Serializable] public class UnlinkXboxAccountResult : PlayFabResultCommon { } /// /// Specify the container and optionally the catalogVersion for the container to open /// [Serializable] public class UnlockContainerInstanceRequest : PlayFabRequestCommon { /// /// Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog /// associated with the item instance. /// public string CatalogVersion; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// ItemInstanceId of the container to unlock. /// public string ContainerItemInstanceId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this /// parameter is required. /// public string KeyItemInstanceId; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// Specify the type of container to open and optionally the catalogVersion for the container to open /// [Serializable] public class UnlockContainerItemRequest : PlayFabRequestCommon { /// /// Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary /// catalog. /// public string CatalogVersion; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Catalog ItemId of the container type to unlock. /// public string ContainerItemId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// The items and vc found within the container. These will be added and stacked in your inventory as appropriate. /// [Serializable] public class UnlockContainerItemResult : PlayFabResultCommon { /// /// Items granted to the player as a result of unlocking the container. /// public List GrantedItems; /// /// Unique instance identifier of the container unlocked. /// public string UnlockedItemInstanceId; /// /// Unique instance identifier of the key used to unlock the container, if applicable. /// public string UnlockedWithItemInstanceId; /// /// Virtual currency granted to the player as a result of unlocking the container. /// public Dictionary VirtualCurrency; } [Serializable] public class UpdateAvatarUrlRequest : PlayFabRequestCommon { /// /// URL of the avatar image. If empty, it removes the existing avatar URL. /// public string ImageUrl; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// Represents a single update ban request. /// [Serializable] public class UpdateBanRequest : PlayFabBaseModel { /// /// The updated active state for the ban. Null for no change. /// public bool? Active; /// /// The id of the ban to be updated. /// public string BanId; /// /// The updated expiration date for the ban. Null for no change. /// public DateTime? Expires; /// /// The updated IP address for the ban. Null for no change. /// public string IPAddress; /// /// Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. /// public bool? Permanent; /// /// The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. /// public string Reason; /// /// The updated family type of the user that should be included in the ban. Null for no change. /// public UserFamilyType? UserFamilyType; } /// /// For each ban, only updates the values that are set. Leave any value to null for no change. If a ban could not be found, /// the rest are still applied. Returns information about applied updates only. /// [Serializable] public class UpdateBansRequest : PlayFabRequestCommon { /// /// List of bans to be updated. Maximum 100. /// public List Bans; } [Serializable] public class UpdateBansResult : PlayFabResultCommon { /// /// Information on the bans that were updated /// public List BanData; } /// /// This function performs an additive update of the arbitrary JSON object 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. No other key-value pairs will be changed apart from those specified in the call. /// [Serializable] public class UpdateCharacterDataRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. /// public UserDataPermission? Permission; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UpdateCharacterDataResult : PlayFabResultCommon { /// /// Indicates the current version of the data that has been set. This is incremented with every set call for that type of /// data (read-only, internal, etc). This version can be provided in Get calls to find updated data. /// public uint DataVersion; } /// /// Character statistics are similar to user statistics in that they are numeric values which may only be updated by a /// server operation, in order to minimize the opportunity for unauthorized changes. In addition to being available for use /// by the title, the statistics are used for all leaderboard operations in PlayFab. /// [Serializable] public class UpdateCharacterStatisticsRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// Statistics to be updated with the provided values. /// public Dictionary CharacterStatistics; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UpdateCharacterStatisticsResult : PlayFabResultCommon { } /// /// 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. /// [Serializable] public class UpdatePlayerStatisticsRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Indicates whether the statistics provided should be set, regardless of the aggregation method set on the statistic. /// Default is false. /// public bool? ForceUpdate; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// Statistics to be updated with the provided values /// public List Statistics; } [Serializable] public class UpdatePlayerStatisticsResult : PlayFabResultCommon { } /// /// 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. /// [Serializable] public class UpdateSharedGroupDataRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Permission to be applied to all user data keys in this request. /// public UserDataPermission? Permission; /// /// Unique identifier for the shared group. /// public string SharedGroupId; } [Serializable] public class UpdateSharedGroupDataResult : PlayFabResultCommon { } /// /// This function performs an additive update of the arbitrary JSON object 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. No other key-value pairs will be changed apart from those specified in the call. /// [Serializable] public class UpdateUserDataRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. /// public UserDataPermission? Permission; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UpdateUserDataResult : PlayFabResultCommon { /// /// Indicates the current version of the data that has been set. This is incremented with every set call for that type of /// data (read-only, internal, etc). This version can be provided in Get calls to find updated data. /// public uint DataVersion; } /// /// This function performs an additive update of the arbitrary JSON object 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, keys with /// null values will be removed. No other key-value pairs will be changed apart from those specified in the call. /// [Serializable] public class UpdateUserInternalDataRequest : PlayFabRequestCommon { /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } /// /// This function performs an additive update of the arbitrary JSON object containing the custom data for the item instance /// which belongs to the specified 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. No other key-value pairs will be changed /// apart from those specified in the call. /// [Serializable] public class UpdateUserInventoryItemDataRequest : PlayFabRequestCommon { /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may /// not begin with a '!' character or be null. /// public Dictionary Data; /// /// Unique PlayFab assigned instance identifier of the item /// public string ItemInstanceId; /// /// Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language /// constraints. Use this to delete the keys directly. /// public List KeysToRemove; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; } [Serializable] public class UserAccountInfo : PlayFabBaseModel { /// /// User Android device information, if an Android device has been linked /// public UserAndroidDeviceInfo AndroidDeviceInfo; /// /// Sign in with Apple account information, if an Apple account has been linked /// public UserAppleIdInfo AppleAccountInfo; /// /// Timestamp indicating when the user account was created /// public DateTime Created; /// /// Custom ID information, if a custom ID has been assigned /// public UserCustomIdInfo CustomIdInfo; /// /// User Facebook information, if a Facebook account has been linked /// public UserFacebookInfo FacebookInfo; /// /// Facebook Instant Games account information, if a Facebook Instant Games account has been linked /// public UserFacebookInstantGamesIdInfo FacebookInstantGamesIdInfo; /// /// User Gamecenter information, if a Gamecenter account has been linked /// public UserGameCenterInfo GameCenterInfo; /// /// User Google account information, if a Google account has been linked /// public UserGoogleInfo GoogleInfo; /// /// User Google Play Games account information, if a Google Play Games account has been linked /// public UserGooglePlayGamesInfo GooglePlayGamesInfo; /// /// User iOS device information, if an iOS device has been linked /// public UserIosDeviceInfo IosDeviceInfo; /// /// User Kongregate account information, if a Kongregate account has been linked /// public UserKongregateInfo KongregateInfo; /// /// Nintendo Switch account information, if a Nintendo Switch account has been linked /// public UserNintendoSwitchAccountIdInfo NintendoSwitchAccountInfo; /// /// Nintendo Switch device information, if a Nintendo Switch device has been linked /// public UserNintendoSwitchDeviceIdInfo NintendoSwitchDeviceIdInfo; /// /// OpenID Connect information, if any OpenID Connect accounts have been linked /// public List OpenIdInfo; /// /// Unique identifier for the user account /// public string PlayFabId; /// /// Personal information for the user which is considered more sensitive /// public UserPrivateAccountInfo PrivateInfo; /// /// User PlayStation :tm: Network account information, if a PlayStation :tm: Network account has been linked /// public UserPsnInfo PsnInfo; /// /// Server Custom ID information, if a server custom ID has been assigned /// public UserServerCustomIdInfo ServerCustomIdInfo; /// /// User Steam information, if a Steam account has been linked /// public UserSteamInfo SteamInfo; /// /// Title-specific information for the user account /// public UserTitleInfo TitleInfo; /// /// User Twitch account information, if a Twitch account has been linked /// public UserTwitchInfo TwitchInfo; /// /// User account name in the PlayFab service /// public string Username; /// /// User XBox account information, if a XBox account has been linked /// public UserXboxInfo XboxInfo; } [Serializable] public class UserAndroidDeviceInfo : PlayFabBaseModel { /// /// Android device ID /// public string AndroidDeviceId; } [Serializable] public class UserAppleIdInfo : PlayFabBaseModel { /// /// Apple subject ID /// public string AppleSubjectId; } [Serializable] public class UserCustomIdInfo : PlayFabBaseModel { /// /// Custom ID /// public string CustomId; } /// /// 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. /// public enum UserDataPermission { Private, Public } [Serializable] public class UserDataRecord : PlayFabBaseModel { /// /// Timestamp for when this data was last updated. /// public DateTime LastUpdated; /// /// Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData /// requests being made by one player about another player. /// public UserDataPermission? Permission; /// /// Data stored for the specified user data key. /// public string Value; } [Serializable] public class UserFacebookInfo : PlayFabBaseModel { /// /// Facebook identifier /// public string FacebookId; /// /// Facebook full name /// public string FullName; } [Serializable] public class UserFacebookInstantGamesIdInfo : PlayFabBaseModel { /// /// Facebook Instant Games ID /// public string FacebookInstantGamesId; } public enum UserFamilyType { None, Xbox, Steam } [Serializable] public class UserGameCenterInfo : PlayFabBaseModel { /// /// Gamecenter identifier /// public string GameCenterId; } [Serializable] public class UserGoogleInfo : PlayFabBaseModel { /// /// Email address of the Google account /// public string GoogleEmail; /// /// Gender information of the Google account /// public string GoogleGender; /// /// Google ID /// public string GoogleId; /// /// Locale of the Google account /// public string GoogleLocale; /// /// Name of the Google account user /// public string GoogleName; } [Serializable] public class UserGooglePlayGamesInfo : PlayFabBaseModel { /// /// Avatar image url of the Google Play Games player /// public string GooglePlayGamesPlayerAvatarImageUrl; /// /// Display name of the Google Play Games player /// public string GooglePlayGamesPlayerDisplayName; /// /// Google Play Games player ID /// public string GooglePlayGamesPlayerId; } [Serializable] public class UserIosDeviceInfo : PlayFabBaseModel { /// /// iOS device ID /// public string IosDeviceId; } [Serializable] public class UserKongregateInfo : PlayFabBaseModel { /// /// Kongregate ID /// public string KongregateId; /// /// Kongregate Username /// public string KongregateName; } [Serializable] public class UserNintendoSwitchAccountIdInfo : PlayFabBaseModel { /// /// Nintendo Switch account subject ID /// public string NintendoSwitchAccountSubjectId; } [Serializable] public class UserNintendoSwitchDeviceIdInfo : PlayFabBaseModel { /// /// Nintendo Switch Device ID /// public string NintendoSwitchDeviceId; } [Serializable] public class UserOpenIdInfo : PlayFabBaseModel { /// /// OpenID Connection ID /// public string ConnectionId; /// /// OpenID Issuer /// public string Issuer; /// /// OpenID Subject /// public string Subject; } public 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, GooglePlayGames, XboxMobileStore, King } [Serializable] public class UserPrivateAccountInfo : PlayFabBaseModel { /// /// user email address /// public string Email; } [Serializable] public class UserPsnInfo : PlayFabBaseModel { /// /// PlayStation :tm: Network account ID /// public string PsnAccountId; /// /// PlayStation :tm: Network online ID /// public string PsnOnlineId; } [Serializable] public class UserServerCustomIdInfo : PlayFabBaseModel { /// /// Custom ID /// public string CustomId; } [Serializable] public class UserSettings : PlayFabBaseModel { /// /// Boolean for whether this player is eligible for gathering device info. /// public bool GatherDeviceInfo; /// /// Boolean for whether this player should report OnFocus play-time tracking. /// public bool GatherFocusInfo; /// /// Boolean for whether this player is eligible for ad tracking. /// public bool NeedsAttribution; } [Serializable] public class UserSteamInfo : PlayFabBaseModel { /// /// what stage of game ownership the user is listed as being in, from Steam /// public TitleActivationStatus? SteamActivationStatus; /// /// the country in which the player resides, from Steam data /// public string SteamCountry; /// /// currency type set in the user Steam account /// public Currency? SteamCurrency; /// /// Steam identifier /// public string SteamId; /// /// Steam display name /// public string SteamName; } [Serializable] public class UserTitleInfo : PlayFabBaseModel { /// /// URL to the player's avatar. /// public string AvatarUrl; /// /// timestamp indicating when the user was first associated with this game (this can differ significantly from when the user /// first registered with PlayFab) /// public DateTime Created; /// /// name of the user, as it is displayed in-game /// public string DisplayName; /// /// timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other /// events, such as issuing a beta key to the user, can associate the title to the user) /// public DateTime? FirstLogin; /// /// boolean indicating whether or not the user is currently banned for a title /// public bool? isBanned; /// /// timestamp for the last user login for this title /// public DateTime? LastLogin; /// /// source by which the user first joined the game, if known /// public UserOrigination? Origination; /// /// Title player account entity for this user /// public EntityKey TitlePlayerAccount; } [Serializable] public class UserTwitchInfo : PlayFabBaseModel { /// /// Twitch ID /// public string TwitchId; /// /// Twitch Username /// public string TwitchUserName; } [Serializable] public class UserXboxInfo : PlayFabBaseModel { /// /// XBox user ID /// public string XboxUserId; /// /// XBox user sandbox /// public string XboxUserSandbox; } [Serializable] public class ValueToDateModel : PlayFabBaseModel { /// /// ISO 4217 code of the currency used in the purchases /// public string Currency; /// /// Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and /// ninety-nine cents when Currency is 'USD') /// public uint TotalValue; /// /// Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine /// dollars and ninety-nine cents when Currency is 'USD'. /// public string TotalValueAsDecimal; } [Serializable] public class Variable : PlayFabBaseModel { /// /// Name of the variable. /// public string Name; /// /// Value of the variable. /// public string Value; } [Serializable] public class VirtualCurrencyRechargeTime : PlayFabBaseModel { /// /// Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value /// through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen /// below this value. /// public int RechargeMax; /// /// Server timestamp in UTC indicating the next time the virtual currency will be incremented. /// public DateTime RechargeTime; /// /// Time remaining (in seconds) before the next recharge increment of the virtual currency. /// public int SecondsToRecharge; } [Serializable] public class WriteEventResponse : PlayFabResultCommon { /// /// The unique identifier of the event. The values of this identifier consist of ASCII characters and are not constrained to /// any particular format. /// public string EventId; } /// /// 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 character-based event. The created event will be locked to the /// authenticated title. /// [Serializable] public class WriteServerCharacterEventRequest : PlayFabRequestCommon { /// /// Custom event properties. Each property consists of a name (string) and a value (JSON object). /// public Dictionary Body; /// /// Unique PlayFab assigned ID for a specific character owned by a user /// public string CharacterId; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it /// commonly follows the subject_verb_object pattern (e.g. player_logged_in). /// public string EventName; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// The time (in UTC) associated with this event. The value defaults to the current time. /// public DateTime? Timestamp; } /// /// 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. /// [Serializable] public class WriteServerPlayerEventRequest : PlayFabRequestCommon { /// /// Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object). /// public Dictionary Body; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it /// commonly follows the subject_verb_object pattern (e.g. player_logged_in). /// public string EventName; /// /// Unique PlayFab assigned ID of the user on whom the operation will be performed. /// public string PlayFabId; /// /// The time (in UTC) associated with this event. The value defaults to the current time. /// public DateTime? Timestamp; } /// /// 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 title-based event. The created event will be locked to the /// authenticated title. /// [Serializable] public class WriteTitleEventRequest : PlayFabRequestCommon { /// /// Custom event properties. Each property consists of a name (string) and a value (JSON object). /// public Dictionary Body; /// /// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). /// public Dictionary CustomTags; /// /// The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it /// commonly follows the subject_verb_object pattern (e.g. player_logged_in). /// public string EventName; /// /// The time (in UTC) associated with this event. The value defaults to the current time. /// public DateTime? Timestamp; } [Serializable] public class XboxLiveAccountPlayFabIdPair : PlayFabBaseModel { /// /// Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. /// public string PlayFabId; /// /// Unique Xbox Live identifier for a user. /// public string XboxLiveAccountId; } } #endif