diff --git a/Legacy/PlayFab/Addon.api.json b/Legacy/PlayFab/Addon.api.json index 92edad9c..2c94b59f 100644 --- a/Legacy/PlayFab/Addon.api.json +++ b/Legacy/PlayFab/Addon.api.json @@ -4326,6 +4326,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -5442,6 +5450,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -6059,6 +6075,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -6338,6 +6356,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Admin.api.json b/Legacy/PlayFab/Admin.api.json index 45cb2914..484a5970 100644 --- a/Legacy/PlayFab/Admin.api.json +++ b/Legacy/PlayFab/Admin.api.json @@ -6589,6 +6589,12 @@ { "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + { + "name": "TransactionAlreadyApplied" + }, + { + "name": "ReportDataNotRetrievedSuccessfully" + }, { "name": "MatchmakingEntityInvalid" }, @@ -7426,6 +7432,12 @@ { "name": "GameSaveOperationNotAllowed" }, + { + "name": "GameSaveDataStorageQuotaExceeded" + }, + { + "name": "GameSaveNewerManifestExists" + }, { "name": "StateShareForbidden" }, @@ -17718,6 +17730,10 @@ "requestExample": "{\n \"PlayFabId\": \"10931252888739651331\",\n \"TagName\": \"MostKilled\"\n}", "result": "AddPlayerTagResult", "resultExample": "", + "seeAlso": [ + "Admin/GetPlayerTags", + "Admin/RemovePlayerTag" + ], "errors": [ "PlayerTagCountLimitExceeded" ] @@ -17769,6 +17785,9 @@ "requestExample": "{\n \"PlayFabId\": \"20394883\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}", "result": "ModifyUserVirtualCurrencyResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"B456AE0\",\n \"VirtualCurrency\": \"GC\",\n \"BalanceChange\": 10,\n \"Balance\": 1500\n }\n}", + "seeAlso": [ + "Admin/SubtractUserVirtualCurrency" + ], "errors": [ "InvalidVirtualCurrency", "VirtualCurrencyCurrentlyUnavailable" @@ -17787,6 +17806,10 @@ "requestExample": "{\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\",\n \"DisplayName\": \"Chump Coins\",\n \"InitialDeposit\": 100,\n \"RechargeRate\": 1000,\n \"RechargeMax\": 1000\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n}", "result": "BlankResult", "resultExample": "", + "seeAlso": [ + "Admin/ListVirtualCurrencyTypes", + "Admin/RemoveVirtualCurrencyTypes" + ], "errors": [ "InvalidVirtualCurrencyCode", "VirtualCurrencyCodeExists", @@ -17806,6 +17829,12 @@ "requestExample": "{\n \"Bans\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"IPAddress\": \"192.168.1.1\",\n \"Reason\": \"You cheated!\",\n \"DurationInHours\": 7\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"Reason\": \"Caught you using speed hack!\"\n }\n ]\n}", "result": "BanUsersResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": true\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/GetUserBans", + "Admin/RevokeAllBansForUser", + "Admin/RevokeBans", + "Admin/UpdateBans" + ], "errors": [ "UserisNotValid" ] @@ -17981,7 +18010,11 @@ "request": "CreatePlayerSharedSecretRequest", "requestExample": "{\n \"FriendlyName\": \"iOS Users\"\n}", "result": "CreatePlayerSharedSecretResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"SecretKey\": \"keysaresecret\"\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"SecretKey\": \"keysaresecret\"\n }\n}", + "seeAlso": [ + "Admin/GetPlayerSharedSecrets", + "Admin/UpdatePlayerSharedSecret" + ] }, { "name": "CreatePlayerStatisticDefinition", @@ -17996,6 +18029,15 @@ "requestExample": "{\n \"StatisticName\": \"headshots\",\n \"VersionChangeInterval\": \"Never\",\n \"ShouldProvisionLeaderboard\": false\n}", "result": "CreatePlayerStatisticDefinitionResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Statistic\": {\n \"StatisticName\": \"headshots\",\n \"CurrentVersion\": 2,\n \"DeletionInProgress\": false,\n \"VersionChangeInterval\": \"Day\",\n \"AggregationMethod\": \"Last\"\n }\n }\n}", + "seeAlso": [ + "Admin/GetPlayerStatisticDefinitions", + "Client/GetPlayerStatistics", + "Server/GetPlayerStatistics", + "Admin/GetPlayerStatisticVersions", + "Admin/UpdatePlayerStatisticDefinition", + "Client/UpdatePlayerStatistics", + "Server/UpdatePlayerStatistics" + ], "errors": [ "StatisticCountLimitExceeded", "StatisticNameConflict" @@ -18037,7 +18079,13 @@ "request": "DeleteContentRequest", "requestExample": "{\n \"Key\": \"images/sword_icon.png\"\n}", "result": "BlankResult", - "resultExample": "" + "resultExample": "", + "seeAlso": [ + "Client/GetContentDownloadUrl", + "Server/GetContentDownloadUrl", + "Admin/GetContentList", + "Admin/GetContentUploadUrl" + ] }, { "name": "DeleteEventSink", @@ -18076,7 +18124,10 @@ "request": "DeleteMasterPlayerAccountRequest", "requestExample": "{\n \"PlayFabId\": \"A68C908B66C23C5\",\n \"MetaData\": \"Identifying info\"\n}", "result": "DeleteMasterPlayerAccountResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"JobReceiptId\": \"A101202A2CD049A0A93C9531DFB37DE8\",\n \"TitleIds\": [\n \"A248\",\n \"19B0\"\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"JobReceiptId\": \"A101202A2CD049A0A93C9531DFB37DE8\",\n \"TitleIds\": [\n \"A248\",\n \"19B0\"\n ]\n }\n}", + "seeAlso": [ + "Admin/GetPlayedTitleList" + ] }, { "name": "DeleteMasterPlayerEventData", @@ -18120,7 +18171,12 @@ "request": "DeleteOpenIdConnectionRequest", "requestExample": "{\n \"ConnectionId\": \"oidconnection1\"\n}", "result": "EmptyResponse", - "resultExample": "" + "resultExample": "", + "seeAlso": [ + "Admin/CreateOpenIdConnection", + "Admin/ListOpenIdConnection", + "Admin/UpdateOpenIdConnection" + ] }, { "name": "DeletePlayer", @@ -18152,6 +18208,11 @@ "AnyInclusiveFlags": [ "Beta" ], + "seeAlso": [ + "Admin/GetPlayerCustomProperty", + "Admin/ListPlayerCustomProperties", + "Admin/UpdatePlayerCustomProperties" + ], "errors": [ "PlayerCustomPropertiesVersionMismatch" ] @@ -18206,6 +18267,11 @@ "requestExample": "{\n \"StoreId\": \"BonusStore\"\n}", "result": "DeleteStoreResult", "resultExample": "", + "seeAlso": [ + "Admin/GetStoreItems", + "Admin/SetStoreItems", + "Admin/UpdateStoreItems" + ], "errors": [ "CatalogNotConfigured", "StoreNotFound" @@ -18373,7 +18439,10 @@ "request": "GetAllActionGroupsRequest", "requestExample": "{}", "result": "GetAllActionGroupsResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ActionGroups\": [\n {\n \"Name\": \"Grant beta items\",\n \"Id\": \"12389170481\"\n }\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ActionGroups\": [\n {\n \"Name\": \"Grant beta items\",\n \"Id\": \"12389170481\"\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/GetAllSegments" + ] }, { "name": "GetAllSegments", @@ -18403,7 +18472,11 @@ "request": "GetCatalogItemsRequest", "requestExample": "{\n \"CatalogVersion\": \"1\"\n}", "result": "GetCatalogItemsResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"CatalogVersion\": \"5\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/SetCatalogItems", + "Admin/UpdateCatalogItems" + ] }, { "name": "GetCloudScriptAzureFunctionsTaskInstance", @@ -18421,6 +18494,13 @@ "AnyInclusiveFlags": [ "Beta" ], + "seeAlso": [ + "Admin/AbortTaskInstance", + "Admin/GetActionsOnPlayersInSegmentTaskInstance", + "Admin/GetCloudScriptTaskInstance", + "Admin/GetTaskInstances", + "Admin/RunTask" + ], "errors": [ "TaskInstanceNotFound" ] @@ -18513,6 +18593,12 @@ "requestExample": "{\n \"Key\": \"images/sword_icon.png\",\n \"ContentType\": \"image/png\"\n}", "result": "GetContentUploadUrlResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"URL\": \"https://...\"\n }\n}", + "seeAlso": [ + "Admin/DeleteContent", + "Client/GetContentDownloadUrl", + "Server/GetContentDownloadUrl", + "Admin/GetContentList" + ], "errors": [ "BillingInformationRequired", "ContentQuotaExceeded", @@ -18534,6 +18620,7 @@ "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DownloadUrl\": \"https://data-reports-dev.s3-us-west-1.amazonaws.com/2730/PurchaseDataReport/2014/12/5/data.json\"\n }\n}", "errors": [ "InvalidReportDate", + "ReportDataNotRetrievedSuccessfully", "ReportNotAvailable" ] }, @@ -18552,6 +18639,9 @@ "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Sinks\": [\n {\n \"Name\": \"MyStorage\",\n \"DestinationType\": \"AzureBlobStorage\",\n \"IsEnabled\": false,\n \"SinkSettings\": {\n \"AccountName\": \"mystorageaccount\",\n \"ContainerName\": \"mycontainername\",\n \"TenantId\": null,\n \"Credentials\": null\n }\n }\n ]\n }\n}", "AnyInclusiveFlags": [ "Beta" + ], + "seeAlso": [ + "Admin/SetEventSink" ] }, { @@ -18572,6 +18662,10 @@ "requestExample": "{\n \"LobbyId\": \"2938488\"\n}", "result": "GetMatchmakerGameInfoResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"LobbyId\": \"2938488\",\n \"TitleId\": \"2084\",\n \"StartTime\": \"2016-04-20T10:32:58Z\",\n \"EndTime\": \"2016-04-20T21:08:14Z\",\n \"Mode\": \"0\",\n \"BuildVersion\": \"5.0.1\",\n \"Region\": \"USCentral\",\n \"ServerAddress\": \"10.250.24.54\",\n \"ServerPort\": 1243\n }\n}", + "seeAlso": [ + "Admin/GetMatchmakerGameModes", + "Admin/ModifyMatchmakerGameModes" + ], "errors": [ "GameNotFound" ] @@ -18612,7 +18706,10 @@ "request": "GetPlayedTitleListRequest", "requestExample": "{\n \"PlayFabId\": \"A68C908B66C23C5\"\n}", "result": "GetPlayedTitleListResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"TitleIds\": [\n \"A248\",\n \"19B0\"\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"TitleIds\": [\n \"A248\",\n \"19B0\"\n ]\n }\n}", + "seeAlso": [ + "Admin/DeleteMasterPlayerAccount" + ] }, { "name": "GetPlayerCustomProperty", @@ -18684,6 +18781,9 @@ "requestExample": "{\n \"PlayFabId\": \"1337AA00\"\n}", "result": "GetPlayerSegmentsResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Segments\": [\n {\n \"Id\": \"1337AA00\",\n \"Name\": \"Fast Players\"\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/GetAllSegments" + ], "errors": [ "SegmentNotFound" ] @@ -18719,6 +18819,9 @@ "requestExample": "{\n \"SegmentId\": \"1337AA00\",\n \"SecondsToLive\": 5,\n \"MaxBatchSize\": 500\n}", "result": "GetPlayersInSegmentResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ProfilesInSegment\": 15,\n \"ContinuationToken\": \"asd981if0aiojiud\",\n \"PlayerProfiles\": []\n }\n}", + "seeAlso": [ + "Admin/GetAllSegments" + ], "errors": [ "ExpiredContinuationToken", "GetPlayersInSegmentRateLimitExceeded", @@ -18789,7 +18892,11 @@ "request": "GetPlayerTagsRequest", "requestExample": "{\n \"PlayFabId\": \"10931252888739651331\",\n \"Namespace\": \"title.AAA\"\n}", "result": "GetPlayerTagsResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"10931252888739651331\",\n \"Tags\": [\n \"title.AAA.MostKilled\",\n \"title.AAA.MostPlayed\",\n \"title.AAA.MostBanned\"\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"10931252888739651331\",\n \"Tags\": [\n \"title.AAA.MostKilled\",\n \"title.AAA.MostPlayed\",\n \"title.AAA.MostBanned\"\n ]\n }\n}", + "seeAlso": [ + "Admin/AddPlayerTag", + "Admin/RemovePlayerTag" + ] }, { "name": "GetPolicy", @@ -18927,6 +19034,11 @@ "requestExample": "{\n \"StoreId\": \"BonusStore\"\n}", "result": "GetStoreItemsResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Store\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 180,\n \"GV\": 20\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 100\n }\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 250,\n \"GV\": 30\n }\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 399\n }\n }\n ],\n \"Source\": \"Admin\",\n \"CatalogVersion\": \"1\",\n \"StoreId\": \"BonusStore\",\n \"MarketingData\": {\n \"DisplayName\": \"Amazing Bonus Store\",\n \"Description\": \"Elite tier bonuses available here\"\n }\n }\n}", + "seeAlso": [ + "Admin/DeleteStore", + "Admin/SetStoreItems", + "Admin/UpdateStoreItems" + ], "errors": [ "CatalogNotConfigured", "StoreNotFound" @@ -19006,7 +19118,10 @@ "request": "GetTitleDataRequest", "requestExample": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}", "result": "GetTitleDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": {\n \"color\": \"blue\",\n \"propertyA\": \"xyz123\"\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": {\n \"color\": \"blue\",\n \"propertyA\": \"xyz123\"\n }\n }\n}", + "seeAlso": [ + "Admin/SetTitleInternalData" + ] }, { "name": "GetUserAccountInfo", @@ -19021,6 +19136,9 @@ "requestExample": "{\n \"PlayFabId\": \"293753934\",\n \"IgnoreMissingTitleActivation\": false\n}", "result": "LookupUserAccountInfoResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"UserInfo\": {\n \"PlayFabId\": \"10931252888739651331\",\n \"Created\": \"2013-04-07T09:04:28Z\",\n \"Username\": \"accountname\",\n \"TitleInfo\": {\n \"DisplayName\": \"User title-specific name\",\n \"Origination\": \"IOS\",\n \"Created\": \"2014-01-08T11:03:18Z\",\n \"LastLogin\": \"2014-04-07T09:04:28Z\",\n \"FirstLogin\": \"2014-01-08T11:03:18Z\",\n \"TitlePlayerAccount\": {\n \"Id\": \"174812abf712\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n },\n \"FacebookInfo\": {\n \"FacebookId\": \"23525445454\"\n },\n \"SteamInfo\": {\n \"SteamCountry\": \"US\",\n \"SteamCurrency\": \"USD\"\n },\n \"GameCenterInfo\": {\n \"GameCenterId\": \"someone\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserInventory" + ], "errors": [ "TitleNotActivated" ] @@ -19038,6 +19156,12 @@ "requestExample": "{\n \"PlayFabId\": \"1679AF5CD04BD838\"\n}", "result": "GetUserBansResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": true\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/BanUsers", + "Admin/RevokeAllBansForUser", + "Admin/RevokeBans", + "Admin/UpdateBans" + ], "errors": [ "UserisNotValid" ] @@ -19054,7 +19178,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserInternalData", + "Admin/GetUserReadOnlyData", + "Admin/UpdateUserData", + "Admin/UpdateUserInternalData", + "Admin/UpdateUserReadOnlyData" + ] }, { "name": "GetUserInternalData", @@ -19068,7 +19199,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserData", + "Admin/GetUserReadOnlyData", + "Admin/UpdateUserData", + "Admin/UpdateUserInternalData", + "Admin/UpdateUserReadOnlyData" + ] }, { "name": "GetUserInventory", @@ -19082,7 +19220,10 @@ "request": "GetUserInventoryRequest", "requestExample": "{\n \"PlayFabId\": \"204883457\"\n}", "result": "GetUserInventoryResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"204883457\",\n \"Inventory\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemInstanceId\": \"9879843\",\n \"ItemClass\": \"shields\",\n \"CatalogVersion\": \"5\",\n \"UnitPrice\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemInstanceId\": \"3854637\",\n \"ItemClass\": \"boosts\",\n \"RemainingUses\": 4,\n \"CatalogVersion\": \"5\",\n \"UnitPrice\": 0\n }\n ],\n \"VirtualCurrency\": {\n \"GC\": 15\n },\n \"VirtualCurrencyRechargeTimes\": {\n \"GC\": {\n \"SecondsToRecharge\": 3600,\n \"RechargeTime\": \"2014-01-01T12:00:00Z\",\n \"RechargeMax\": 50\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"204883457\",\n \"Inventory\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemInstanceId\": \"9879843\",\n \"ItemClass\": \"shields\",\n \"CatalogVersion\": \"5\",\n \"UnitPrice\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemInstanceId\": \"3854637\",\n \"ItemClass\": \"boosts\",\n \"RemainingUses\": 4,\n \"CatalogVersion\": \"5\",\n \"UnitPrice\": 0\n }\n ],\n \"VirtualCurrency\": {\n \"GC\": 15\n },\n \"VirtualCurrencyRechargeTimes\": {\n \"GC\": {\n \"SecondsToRecharge\": 3600,\n \"RechargeTime\": \"2014-01-01T12:00:00Z\",\n \"RechargeMax\": 50\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserAccountInfo" + ] }, { "name": "GetUserPublisherData", @@ -19096,7 +19237,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherInternalData", + "Admin/GetUserPublisherReadOnlyData", + "Admin/UpdateUserPublisherData", + "Admin/UpdateUserPublisherInternalData", + "Admin/UpdateUserPublisherReadOnlyData" + ] }, { "name": "GetUserPublisherInternalData", @@ -19110,7 +19258,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherData", + "Admin/GetUserPublisherReadOnlyData", + "Admin/UpdateUserPublisherData", + "Admin/UpdateUserPublisherInternalData", + "Admin/UpdateUserPublisherReadOnlyData" + ] }, { "name": "GetUserPublisherReadOnlyData", @@ -19124,7 +19279,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherData", + "Admin/GetUserPublisherInternalData", + "Admin/UpdateUserPublisherData", + "Admin/UpdateUserPublisherInternalData", + "Admin/UpdateUserPublisherReadOnlyData" + ] }, { "name": "GetUserReadOnlyData", @@ -19138,7 +19300,14 @@ "request": "GetUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}", "result": "GetUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"2039475\",\n \"DataVersion\": 12,\n \"Data\": {\n \"preferences\": {\n \"Value\": \"alpha\",\n \"LastUpdated\": \"2014-08-20T12:30:45Z\",\n \"Permission\": \"Public\"\n },\n \"progress\": {\n \"Value\": \"level_twenty\",\n \"LastUpdated\": \"2014-09-01T10:12:30Z\",\n \"Permission\": \"Private\"\n }\n }\n }\n}", + "seeAlso": [ + "Admin/GetUserData", + "Admin/GetUserInternalData", + "Admin/UpdateUserData", + "Admin/UpdateUserInternalData", + "Admin/UpdateUserReadOnlyData" + ] }, { "name": "GrantItemsToUsers", @@ -19172,6 +19341,9 @@ "requestExample": "{\n \"CatalogVersion\": \"Rares\",\n \"ItemId\": \"FreeHoodie\",\n \"Amount\": 50\n}", "result": "IncrementLimitedEditionItemAvailabilityResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {}\n}", + "seeAlso": [ + "Admin/CheckLimitedEditionItemAvailability" + ], "errors": [ "RequestAlreadyRunning" ] @@ -19281,7 +19453,11 @@ "request": "ListVirtualCurrencyTypesRequest", "requestExample": "{}", "result": "ListVirtualCurrencyTypesResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\",\n \"DisplayName\": \"Chump Coins\",\n \"InitialDeposit\": 100,\n \"RechargeRate\": 1000,\n \"RechargeMax\": 1000\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\",\n \"DisplayName\": \"Chump Coins\",\n \"InitialDeposit\": 100,\n \"RechargeRate\": 1000,\n \"RechargeMax\": 1000\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/AddVirtualCurrencyTypes", + "Admin/RemoveVirtualCurrencyTypes" + ] }, { "name": "ModifyMatchmakerGameModes", @@ -19301,7 +19477,11 @@ "request": "ModifyMatchmakerGameModesRequest", "requestExample": "{\n \"BuildVersion\": \"5.0.1\",\n \"GameModes\": [\n {\n \"Gamemode\": \"0\",\n \"MinPlayerCount\": 2,\n \"MaxPlayerCount\": 25\n },\n {\n \"Gamemode\": \"1\",\n \"MinPlayerCount\": 4,\n \"MaxPlayerCount\": 35,\n \"StartOpen\": false\n }\n ]\n}", "result": "ModifyMatchmakerGameModesResult", - "resultExample": "" + "resultExample": "", + "seeAlso": [ + "Admin/GetMatchmakerGameInfo", + "Admin/GetMatchmakerGameModes" + ] }, { "name": "ModifyServerBuild", @@ -19321,6 +19501,12 @@ "requestExample": "{\n \"BuildId\": \"5.0.1\",\n \"Timestamp\": \"2014-03-24T00:00:00Z\",\n \"ActiveRegions\": [\n \"USCentral\",\n \"EUWest\"\n ],\n \"MaxGamesPerHost\": 5,\n \"MinFreeGameSlots\": 2,\n \"ExecutablePath\": \"\\\\ShooterGame\\\\Binaries\\\\Win64\\\\ShooterGameServer.exe\",\n \"Comment\": \"Testing new IAP methods\"\n}", "result": "ModifyServerBuildResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BuildId\": \"5.0.1\",\n \"ActiveRegions\": [\n \"USCentral\",\n \"EUWest\"\n ],\n \"MaxGamesPerHost\": 5,\n \"MinFreeGameSlots\": 2,\n \"ExecutablePath\": \"gameserver.exe\",\n \"Comment\": \"Testing new IAP methods\",\n \"Timestamp\": \"2014-03-24T00:00:00Z\",\n \"TitleId\": \"2074\",\n \"Status\": \"Available\"\n }\n}", + "seeAlso": [ + "Admin/AddServerBuild", + "Admin/GetServerBuildInfo", + "Admin/ListServerBuilds", + "Admin/RemoveServerBuild" + ], "errors": [ "BuildNotAvailable", "BuildNotFound", @@ -19352,7 +19538,11 @@ "request": "RemovePlayerTagRequest", "requestExample": "{\n \"PlayFabId\": \"10931252888739651331\",\n \"TagName\": \"MostKilled\"\n}", "result": "RemovePlayerTagResult", - "resultExample": "" + "resultExample": "", + "seeAlso": [ + "Admin/AddPlayerTag", + "Admin/GetPlayerTags" + ] }, { "name": "RemoveServerBuild", @@ -19393,6 +19583,10 @@ "requestExample": "{\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\"\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n}", "result": "BlankResult", "resultExample": "", + "seeAlso": [ + "Admin/AddVirtualCurrencyTypes", + "Admin/ListVirtualCurrencyTypes" + ], "errors": [ "InvalidVirtualCurrencyCode", "VirtualCurrencyCannotBeDeleted" @@ -19496,6 +19690,12 @@ "requestExample": "{\n \"PlayFabId\": \"1679AF5CD04BD838\"\n}", "result": "RevokeAllBansForUserResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": false\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/BanUsers", + "Admin/GetUserBans", + "Admin/RevokeBans", + "Admin/UpdateBans" + ], "errors": [ "UserisNotValid" ] @@ -19512,7 +19712,13 @@ "request": "RevokeBansRequest", "requestExample": "{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}", "result": "RevokeBansResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": false\n }\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": false\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/BanUsers", + "Admin/GetUserBans", + "Admin/RevokeAllBansForUser", + "Admin/UpdateBans" + ] }, { "name": "RevokeInventoryItem", @@ -19612,6 +19818,10 @@ "requestExample": "{\n \"CatalogVersion\": \"5\",\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n}", "result": "UpdateCatalogItemsResult", "resultExample": "", + "seeAlso": [ + "Admin/GetCatalogItems", + "Admin/UpdateCatalogItems" + ], "errors": [ "InvalidDropTable", "InvalidItemId", @@ -19735,6 +19945,11 @@ "requestExample": "{\n \"StoreId\": \"BonusStore\",\n \"Store\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 180,\n \"GV\": 20\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 100\n }\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 250,\n \"GV\": 30\n }\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 399\n }\n }\n ]\n}", "result": "UpdateStoreItemsResult", "resultExample": "", + "seeAlso": [ + "Admin/DeleteStore", + "Admin/GetStoreItems", + "Admin/UpdateStoreItems" + ], "errors": [ "CatalogNotConfigured", "InvalidItemId", @@ -19754,6 +19969,9 @@ "requestExample": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}", "result": "SetTitleDataResult", "resultExample": "", + "seeAlso": [ + "Admin/GetTitleData" + ], "errors": [ "DataLengthExceeded", "TooManyKeys" @@ -19772,6 +19990,9 @@ "requestExample": "{\n \"OverrideLabel\": \"Holiday title data\",\n \"TitleId\": \"8FF3A797\",\n \"KeyValues\": [\n {\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n },\n {\n \"Key\": \"Walking Speed\",\n \"Value\": \"0.05\"\n }\n ]\n}", "result": "SetTitleDataAndOverridesResult", "resultExample": "", + "seeAlso": [ + "Admin/GetTitleData" + ], "errors": [ "DataLengthExceeded", "DuplicateKeys", @@ -19792,6 +20013,9 @@ "requestExample": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}", "result": "SetTitleDataResult", "resultExample": "", + "seeAlso": [ + "Admin/GetTitleInternalData" + ], "errors": [ "DataLengthExceeded", "TooManyKeys" @@ -19827,6 +20051,9 @@ "requestExample": "{\n \"PlayFabId\": \"20394883\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}", "result": "ModifyUserVirtualCurrencyResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"PlayFabId\": \"B456AE0\",\n \"VirtualCurrency\": \"GC\",\n \"BalanceChange\": 10,\n \"Balance\": 1500\n }\n}", + "seeAlso": [ + "Admin/AddUserVirtualCurrency" + ], "errors": [ "InvalidVirtualCurrency", "VirtualCurrencyCurrentlyUnavailable" @@ -19844,7 +20071,13 @@ "request": "UpdateBansRequest", "requestExample": "{\n \"Bans\": [\n {\n \"BanId\": \"E0B5FF89542D413C\",\n \"Permanent\": true,\n \"Active\": true\n },\n {\n \"BanId\": \"EF43FF89542G1546\",\n \"Reason\": \"Royal pardon\",\n \"Expires\": \"2016-07-04T00:00:00Z\"\n }\n ]\n}", "result": "UpdateBansResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": true\n }\n ]\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"BanData\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"BanId\": \"E0B5FF89542D413C\",\n \"IPAddress\": \"192.111.11.1\",\n \"Created\": \"2016-08-13T05:04:03Z\",\n \"Reason\": \"You cheated!\",\n \"Active\": false\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"BanId\": \"EF43FF89542G1546\",\n \"Created\": \"2016-05-13T05:04:03Z\",\n \"Expires\": \"2016-09-13T05:04:03Z\",\n \"Reason\": \"You used speed hack!\",\n \"Active\": true\n }\n ]\n }\n}", + "seeAlso": [ + "Admin/BanUsers", + "Admin/GetUserBans", + "Admin/RevokeAllBansForUser", + "Admin/RevokeBans" + ] }, { "name": "UpdateCatalogItems", @@ -19859,6 +20092,10 @@ "requestExample": "{\n \"CatalogVersion\": \"5\",\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n}", "result": "UpdateCatalogItemsResult", "resultExample": "", + "seeAlso": [ + "Admin/GetCatalogItems", + "Admin/SetCatalogItems" + ], "errors": [ "InvalidDropTable", "InvalidItemProperties", @@ -19943,7 +20180,11 @@ "request": "UpdatePlayerSharedSecretRequest", "requestExample": "{\n \"SecretKey\": \"keysaresecret\",\n \"FriendlyName\": \"XBox Users\",\n \"Disabled\": false\n}", "result": "UpdatePlayerSharedSecretResult", - "resultExample": "" + "resultExample": "", + "seeAlso": [ + "Admin/CreatePlayerSharedSecret", + "Admin/GetPlayerSharedSecrets" + ] }, { "name": "UpdatePlayerStatisticDefinition", @@ -20002,6 +20243,9 @@ "requestExample": "{\n \"Tables\": [\n {\n \"TableId\": \"DropTable 1\",\n \"Nodes\": [\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Gold Crown 1\",\n \"Weight\": 20\n },\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Magic Sword 3\",\n \"Weight\": 50\n },\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Clear Shield 3\",\n \"Weight\": 70\n }\n ]\n }\n ]\n}", "result": "UpdateRandomResultTablesResult", "resultExample": "", + "seeAlso": [ + "Admin/GetRandomResultTables" + ], "errors": [ "InvalidDropTable", "InvalidJSONContent" @@ -20046,6 +20290,11 @@ "requestExample": "{\n \"StoreId\": \"BonusStore\",\n \"Store\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 180,\n \"GV\": 20\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 100\n }\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 250,\n \"GV\": 30\n }\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 399\n }\n }\n ]\n}", "result": "UpdateStoreItemsResult", "resultExample": "", + "seeAlso": [ + "Admin/DeleteStore", + "Admin/GetStoreItems", + "Admin/SetStoreItems" + ], "errors": [ "CatalogNotConfigured", "InvalidItemId", @@ -20103,7 +20352,14 @@ "request": "UpdateUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}", "result": "UpdateUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserData", + "Admin/GetUserInternalData", + "Admin/GetUserReadOnlyData", + "Admin/UpdateUserInternalData", + "Admin/UpdateUserReadOnlyData" + ] }, { "name": "UpdateUserInternalData", @@ -20117,7 +20373,14 @@ "request": "UpdateUserInternalDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}", "result": "UpdateUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserData", + "Admin/GetUserInternalData", + "Admin/GetUserReadOnlyData", + "Admin/UpdateUserData", + "Admin/UpdateUserReadOnlyData" + ] }, { "name": "UpdateUserPublisherData", @@ -20132,6 +20395,13 @@ "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}", "result": "UpdateUserDataResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherData", + "Admin/GetUserPublisherInternalData", + "Admin/GetUserPublisherReadOnlyData", + "Admin/UpdateUserPublisherInternalData", + "Admin/UpdateUserPublisherReadOnlyData" + ], "errors": [ "PublisherNotSet" ] @@ -20149,6 +20419,13 @@ "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}", "result": "UpdateUserDataResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherData", + "Admin/GetUserPublisherInternalData", + "Admin/GetUserPublisherReadOnlyData", + "Admin/UpdateUserPublisherData", + "Admin/UpdateUserPublisherReadOnlyData" + ], "errors": [ "PublisherNotSet" ] @@ -20166,6 +20443,13 @@ "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}", "result": "UpdateUserDataResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserPublisherData", + "Admin/GetUserPublisherInternalData", + "Admin/GetUserPublisherReadOnlyData", + "Admin/UpdateUserPublisherData", + "Admin/UpdateUserPublisherInternalData" + ], "errors": [ "PublisherNotSet" ] @@ -20182,7 +20466,14 @@ "request": "UpdateUserDataRequest", "requestExample": "{\n \"PlayFabId\": \"2039475\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}", "result": "UpdateUserDataResult", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}" + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"DataVersion\": 8\n }\n}", + "seeAlso": [ + "Admin/GetUserData", + "Admin/GetUserInternalData", + "Admin/GetUserReadOnlyData", + "Admin/UpdateUserData", + "Admin/UpdateUserInternalData" + ] }, { "name": "UpdateUserTitleDisplayName", @@ -22536,6 +22827,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -23652,6 +23951,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -24269,6 +24576,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -24548,6 +24857,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Authentication.api.json b/Legacy/PlayFab/Authentication.api.json index 22d85429..b84ce5f4 100644 --- a/Legacy/PlayFab/Authentication.api.json +++ b/Legacy/PlayFab/Authentication.api.json @@ -2863,6 +2863,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3979,6 +3987,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4596,6 +4612,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -4875,6 +4893,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Client.api.json b/Legacy/PlayFab/Client.api.json index eacabb46..5fe726a5 100644 --- a/Legacy/PlayFab/Client.api.json +++ b/Legacy/PlayFab/Client.api.json @@ -6119,6 +6119,42 @@ } ] }, + "GetPlayFabIDsFromSteamNamesRequest": { + "name": "GetPlayFabIDsFromSteamNamesRequest", + "className": "GetPlayFabIDsFromSteamNamesRequest", + "classNameSpace": "PlayFab.Client.Models", + "assembly": "PlayFab.Client.Models", + "isRequest": true, + "properties": [ + { + "name": "SteamNames", + "description": "Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.", + "collection": "array", + "jsontype": "String", + "actualtype": "String", + "optional": false + } + ] + }, + "GetPlayFabIDsFromSteamNamesResult": { + "name": "GetPlayFabIDsFromSteamNamesResult", + "className": "GetPlayFabIDsFromSteamNamesResult", + "classNameSpace": "PlayFab.Client.Models", + "assembly": "PlayFab.Client.Models", + "description": "For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.", + "isResult": true, + "properties": [ + { + "name": "Data", + "description": "Mapping of Steam identifiers to PlayFab identifiers.", + "collection": "array", + "jsontype": "Object", + "actualtype": "SteamNamePlayFabIdPair", + "isclass": true, + "optional": true + } + ] + }, "GetPlayFabIDsFromTwitchIDsRequest": { "name": "GetPlayFabIDsFromTwitchIDsRequest", "className": "GetPlayFabIDsFromTwitchIDsRequest", @@ -12545,6 +12581,28 @@ } ] }, + "SteamNamePlayFabIdPair": { + "name": "SteamNamePlayFabIdPair", + "className": "SteamNamePlayFabIdPair", + "classNameSpace": "PlayFab.Client.Models", + "assembly": "PlayFab.Client.Models", + "properties": [ + { + "name": "PlayFabId", + "description": "Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.", + "jsontype": "String", + "actualtype": "String", + "optional": true + }, + { + "name": "SteamName", + "description": "Unique Steam identifier for a user, also known as Steam persona name.", + "jsontype": "String", + "actualtype": "String", + "optional": true + } + ] + }, "SteamPlayFabIdPair": { "name": "SteamPlayFabIdPair", "className": "SteamPlayFabIdPair", @@ -15500,6 +15558,7 @@ "GetPlayFabIDsFromPSNAccountIDs", "GetPlayFabIDsFromPSNOnlineIDs", "GetPlayFabIDsFromSteamIDs", + "GetPlayFabIDsFromSteamNames", "GetPlayFabIDsFromTwitchIDs", "GetPlayFabIDsFromXboxLiveIDs", "GetUserCombinedInfo", @@ -17002,6 +17061,20 @@ "result": "GetPlayFabIDsFromSteamIDsResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": [\n {\n \"SteamStringId\": \"857498576495\",\n \"PlayFabId\": \"5a446c83645201\"\n },\n {\n \"SteamStringId\": \"759374651209\",\n \"PlayFabId\": \"6345cd25a6c7cc\"\n }\n ]\n }\n}" }, + { + "name": "GetPlayFabIDsFromSteamNames", + "summary": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.", + "resultDetails": "For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.", + "subgroup": "Account Management", + "titleTiers": null, + "url": "/Client/GetPlayFabIDsFromSteamNames", + "auth": "SessionTicket", + "method": "POST", + "request": "GetPlayFabIDsFromSteamNamesRequest", + "requestExample": "{\n \"SteamNames\": [\n \"steamPersonaName1\",\n \"steamPersonaName2\"\n ]\n}", + "result": "GetPlayFabIDsFromSteamNamesResult", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": [\n {\n \"SteamName\": \"steamPersonaName1\",\n \"PlayFabId\": \"18727374849283\"\n },\n {\n \"SteamName\": \"steamPersonaName2\",\n \"PlayFabId\": \"18727374849284\"\n }\n ]\n }\n}" + }, { "name": "GetPlayFabIDsFromTwitchIDs", "summary": "Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).", @@ -18199,6 +18272,7 @@ "errors": [ "EncryptionKeyMissing", "EvaluationModePlayerCountExceeded", + "FeatureNotConfiguredForTitle", "InvalidPSNAuthCode", "InvalidPSNIssuerId", "PlayerSecretAlreadyConfigured", @@ -21922,6 +21996,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -23038,6 +23120,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -23655,6 +23745,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -23934,6 +24026,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/CloudScript.api.json b/Legacy/PlayFab/CloudScript.api.json index a9ba3613..ed9279bf 100644 --- a/Legacy/PlayFab/CloudScript.api.json +++ b/Legacy/PlayFab/CloudScript.api.json @@ -2598,13 +2598,6 @@ "requestExample": "{\n \"FunctionName\": \"LevelCompleted\"\n}", "result": "GetFunctionResult", "resultExample": "", - "seeAlso": [ - "CloudScript/ListFunctions", - "CloudScript/ListHttpFunctions", - "CloudScript/ListQueuedFunctions", - "CloudScript/RegisterHttpFunction", - "CloudScript/RegisterQueuedFunction" - ], "errors": [ "CloudScriptNotFound" ] @@ -2680,13 +2673,7 @@ "request": "ListFunctionsRequest", "requestExample": "{}", "result": "ListQueuedFunctionsResult", - "resultExample": "", - "seeAlso": [ - "CloudScript/ListEventHubFunctions", - "CloudScript/ListFunctions", - "CloudScript/ListHttpFunctions", - "CloudScript/RegisterQueuedFunction" - ] + "resultExample": "" }, { "name": "PostFunctionResultForEntityTriggeredAction", @@ -2699,12 +2686,7 @@ "request": "PostFunctionResultForEntityTriggeredActionRequest", "requestExample": "{\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n },\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}", "result": "EmptyResult", - "resultExample": "", - "seeAlso": [ - "CloudScript/PostFunctionResultForFunctionExecution", - "CloudScript/PostFunctionResultForPlayerTriggeredAction", - "CloudScript/PostFunctionResultForScheduledTask" - ] + "resultExample": "" }, { "name": "PostFunctionResultForFunctionExecution", @@ -2735,12 +2717,7 @@ "request": "PostFunctionResultForPlayerTriggeredActionRequest", "requestExample": "{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\",\n \"EventToBeDropped\": false\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05Z\",\n \"LastLogin\": \"2020-02-11T20:23:05Z\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n }\n}", "result": "EmptyResult", - "resultExample": "", - "seeAlso": [ - "CloudScript/PostFunctionResultForEntityTriggeredAction", - "CloudScript/PostFunctionResultForFunctionExecution", - "CloudScript/PostFunctionResultForScheduledTask" - ] + "resultExample": "" }, { "name": "PostFunctionResultForScheduledTask", @@ -2844,10 +2821,6 @@ "requestExample": "{\n \"FunctionName\": \"functionName\"\n}", "result": "EmptyResult", "resultExample": "", - "seeAlso": [ - "CloudScript/RegisterHttpFunction", - "CloudScript/RegisterQueuedFunction" - ], "errors": [ "CloudScriptNotFound" ] @@ -5186,6 +5159,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -6302,6 +6283,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -6919,6 +6908,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -7198,6 +7189,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Data.api.json b/Legacy/PlayFab/Data.api.json index ca735ac6..2a25b7b4 100644 --- a/Legacy/PlayFab/Data.api.json +++ b/Legacy/PlayFab/Data.api.json @@ -3200,6 +3200,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4316,6 +4324,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4933,6 +4949,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5212,6 +5230,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Economy.api.json b/Legacy/PlayFab/Economy.api.json index f836094b..ee32d3d0 100644 --- a/Legacy/PlayFab/Economy.api.json +++ b/Legacy/PlayFab/Economy.api.json @@ -13455,6 +13455,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -14571,6 +14579,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -15188,6 +15204,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -15467,6 +15485,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Events.api.json b/Legacy/PlayFab/Events.api.json index 119ca117..0a6f7e91 100644 --- a/Legacy/PlayFab/Events.api.json +++ b/Legacy/PlayFab/Events.api.json @@ -3243,6 +3243,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4359,6 +4367,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4976,6 +4992,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5255,6 +5273,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Experimentation.api.json b/Legacy/PlayFab/Experimentation.api.json index e04b3cef..d0d040a7 100644 --- a/Legacy/PlayFab/Experimentation.api.json +++ b/Legacy/PlayFab/Experimentation.api.json @@ -3818,6 +3818,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4934,6 +4942,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -5551,6 +5567,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5830,6 +5848,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Groups.api.json b/Legacy/PlayFab/Groups.api.json index aaffd6b6..4cd42e0c 100644 --- a/Legacy/PlayFab/Groups.api.json +++ b/Legacy/PlayFab/Groups.api.json @@ -4502,6 +4502,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -5618,6 +5626,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -6235,6 +6251,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -6514,6 +6532,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Insights.api.json b/Legacy/PlayFab/Insights.api.json index 764ab9f7..9194e9f2 100644 --- a/Legacy/PlayFab/Insights.api.json +++ b/Legacy/PlayFab/Insights.api.json @@ -2849,6 +2849,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3965,6 +3973,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4582,6 +4598,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -4861,6 +4879,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Localization.api.json b/Legacy/PlayFab/Localization.api.json index 7253b9d0..37102c98 100644 --- a/Legacy/PlayFab/Localization.api.json +++ b/Legacy/PlayFab/Localization.api.json @@ -2397,6 +2397,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3513,6 +3521,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4130,6 +4146,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -4409,6 +4427,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Matchmaker.api.json b/Legacy/PlayFab/Matchmaker.api.json index 4f045486..401bd4a5 100644 --- a/Legacy/PlayFab/Matchmaker.api.json +++ b/Legacy/PlayFab/Matchmaker.api.json @@ -831,6 +831,10 @@ "resultExample": "", "AnyInclusiveFlags": [ "Beta" + ], + "seeAlso": [ + "Server/DeregisterGame", + "Server/RegisterGame" ] }, { @@ -904,6 +908,10 @@ "AnyInclusiveFlags": [ "Beta" ], + "seeAlso": [ + "Server/DeregisterGame", + "Server/RegisterGame" + ], "errors": [ "BuildNotFound" ] @@ -3295,6 +3303,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4411,6 +4427,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -5028,6 +5052,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5307,6 +5333,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Multiplayer.api.json b/Legacy/PlayFab/Multiplayer.api.json index cfe04768..48ee9448 100644 --- a/Legacy/PlayFab/Multiplayer.api.json +++ b/Legacy/PlayFab/Multiplayer.api.json @@ -229,6 +229,12 @@ }, { "name": "SwedenCentral" + }, + { + "name": "CanadaCentral" + }, + { + "name": "MexicoCentral" } ] }, @@ -9046,6 +9052,13 @@ "actualtype": "double", "optional": false }, + { + "name": "SkillQuantileRank", + "description": "A double between 0 and 1 denoting the approximate percentage of players that have lower skill than the given player. SkillQuantileRank is only supported for batch models. Note: The percentage is based on quantiles of player skill obtained when the model was created, and those quantiles could become less accurate over time.", + "jsontype": "Number", + "actualtype": "double", + "optional": true + }, { "name": "SkillValue", "description": "The given player's individual skill computed by TrueSkill.", @@ -12284,7 +12297,7 @@ "auth": "EntityToken", "method": "POST", "request": "CreateBatchModelRequest", - "requestExample": "{\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"ModelName\": \"Test Batch Model\",\n \"Conditions\": [\n {\n \"Key\": \"Platform\",\n \"ConditionAffinityWeight\": 1\n },\n {\n \"Key\": \"GameMode\",\n \"ConditionAffinityWeight\": 2\n }\n ],\n \"Events\": [\n \"Kills\",\n \"Deaths\"\n ],\n \"InitialSettingsModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"MatchResultStartTimeUtc\": \"2024-11-08T13:30:37.009Z\",\n \"MatchResultEndTimeUtc\": \"2024-11-08T14:00:37.009Z\",\n \"MaxIterations\": 100,\n \"AnomalousMatchResultIgnoreThreshold\": -20.0\n}", + "requestExample": "{\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"ModelName\": \"Test Batch Model\",\n \"Conditions\": [\n {\n \"Key\": \"Platform\",\n \"ConditionAffinityWeight\": 1\n },\n {\n \"Key\": \"GameMode\",\n \"ConditionAffinityWeight\": 2\n }\n ],\n \"Events\": [\n \"Kills\",\n \"Deaths\"\n ],\n \"InitialSettingsModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"MatchResultStartTimeUtc\": \"2024-11-22T13:30:59.816Z\",\n \"MatchResultEndTimeUtc\": \"2024-11-22T14:00:59.816Z\",\n \"MaxIterations\": 100,\n \"AnomalousMatchResultIgnoreThreshold\": -20.0\n}", "result": "CreateBatchModelResponse", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\"\n }\n}", "AnyInclusiveFlags": [ @@ -13315,7 +13328,7 @@ "request": "GetModelDetailsRequest", "requestExample": "{\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\"\n}", "result": "GetModelDetailsResponse", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ModelDetails\": {\n \"ModelCreationMethod\": \"Batch\",\n \"Conditions\": [\n {\n \"Key\": \"Platform\",\n \"ConditionAffinityWeight\": 1\n },\n {\n \"Key\": \"GameMode\",\n \"ConditionAffinityWeight\": 2\n }\n ],\n \"Events\": [\n \"Kills\",\n \"Deaths\"\n ],\n \"BatchParameters\": {\n \"ParentModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"MatchResultStartDateTime\": \"2024-11-08T13:30:37.044Z\",\n \"MatchResultEndDateTime\": \"2024-11-08T14:00:37.044Z\",\n \"MaxIterations\": 100\n },\n \"EstimatedTimeRemainingInSeconds\": 0,\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"ModelName\": \"Test Batch Model\",\n \"ModelState\": \"Active\",\n \"IsPrimary\": true,\n \"CreationDateTime\": \"2024-11-08T14:00:37.044Z\"\n }\n }\n}", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"ModelDetails\": {\n \"ModelCreationMethod\": \"Batch\",\n \"Conditions\": [\n {\n \"Key\": \"Platform\",\n \"ConditionAffinityWeight\": 1\n },\n {\n \"Key\": \"GameMode\",\n \"ConditionAffinityWeight\": 2\n }\n ],\n \"Events\": [\n \"Kills\",\n \"Deaths\"\n ],\n \"BatchParameters\": {\n \"ParentModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"MatchResultStartDateTime\": \"2024-11-22T13:30:59.851Z\",\n \"MatchResultEndDateTime\": \"2024-11-22T14:00:59.851Z\",\n \"MaxIterations\": 100\n },\n \"EstimatedTimeRemainingInSeconds\": 0,\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"ModelName\": \"Test Batch Model\",\n \"ModelState\": \"Active\",\n \"IsPrimary\": true,\n \"CreationDateTime\": \"2024-11-22T14:00:59.851Z\"\n }\n }\n}", "AnyInclusiveFlags": [ "Beta" ], @@ -13341,7 +13354,7 @@ "request": "GetModelsByScenarioRequest", "requestExample": "{\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\"\n}", "result": "GetModelsByScenarioResponse", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Models\": [\n {\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"ModelName\": \"Test Batch Model\",\n \"ModelState\": \"Active\",\n \"IsPrimary\": true,\n \"CreationDateTime\": \"2024-11-08T14:00:37.025Z\"\n }\n ]\n }\n}", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Models\": [\n {\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"ModelName\": \"Test Batch Model\",\n \"ModelState\": \"Active\",\n \"IsPrimary\": true,\n \"CreationDateTime\": \"2024-11-22T14:00:59.833Z\"\n }\n ]\n }\n}", "AnyInclusiveFlags": [ "Beta" ], @@ -13477,7 +13490,7 @@ "request": "GetPlayerSkillRequest", "requestExample": "{\n \"Players\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SquadSize\": 2\n }\n ],\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n }\n}", "result": "GetPlayerSkillResponse", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Skills\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 1.0,\n \"MatchmakingSkillValue\": 0.9,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-08T14:00:36.993Z\"\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 2.0,\n \"MatchmakingSkillValue\": 1.8,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-08T14:00:36.993Z\"\n }\n ],\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\"\n }\n}", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Skills\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 1.0,\n \"MatchmakingSkillValue\": 0.9,\n \"SkillQuantileRank\": 0.5,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-22T14:00:59.795Z\"\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 2.0,\n \"MatchmakingSkillValue\": 1.8,\n \"SkillQuantileRank\": 0.8,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-22T14:00:59.795Z\"\n }\n ],\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\"\n }\n}", "AnyInclusiveFlags": [ "Beta" ], @@ -13510,7 +13523,7 @@ "request": "GetPlayerSkillFromModelRequest", "requestExample": "{\n \"ModelId\": \"73a2506e-9fd3-4d84-8dd7-570c8e9e02cf\",\n \"Players\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SquadSize\": 2\n }\n ],\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n }\n}", "result": "GetPlayerSkillFromModelResponse", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Skills\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 1.0,\n \"MatchmakingSkillValue\": 0.9,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-08T14:00:36.997Z\"\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 2.0,\n \"MatchmakingSkillValue\": 1.8,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-08T14:00:36.997Z\"\n }\n ],\n \"IsModelPrimary\": true\n }\n}", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Skills\": [\n {\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 1.0,\n \"MatchmakingSkillValue\": 0.9,\n \"SkillQuantileRank\": 0.5,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-22T14:00:59.8Z\"\n },\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SkillValue\": 2.0,\n \"MatchmakingSkillValue\": 1.8,\n \"SkillQuantileRank\": 0.8,\n \"LastProcessedMatchUploadTimeUtc\": \"2024-11-22T14:00:59.8Z\"\n }\n ],\n \"IsModelPrimary\": true\n }\n}", "AnyInclusiveFlags": [ "Beta" ], @@ -14980,9 +14993,9 @@ "auth": "EntityToken", "method": "POST", "request": "UploadMatchResultRequest", - "requestExample": "{\n \"MatchResult\": {\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"Teams\": [\n {\n \"Players\": [\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"PreMatchPartyId\": \"630a6523-8853-4cf6-9fda-c7da84f3d87a\",\n \"SecondsPlayed\": 1800,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"PC\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 35,\n \"Deaths\": 5\n }\n },\n {\n \"Entity\": {\n \"Id\": \"8765\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"PreMatchPartyId\": \"630a6523-8853-4cf6-9fda-c7da84f3d87a\",\n \"SecondsPlayed\": 1800,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 15,\n \"Deaths\": 10\n }\n }\n ],\n \"Rank\": 0\n },\n {\n \"Players\": [\n {\n \"SecondsPlayed\": 1800,\n \"BotId\": 77,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 10,\n \"Deaths\": 15\n }\n },\n {\n \"Entity\": {\n \"Id\": \"0371\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SecondsPlayed\": 900,\n \"CompletionStatus\": \"Disconnected\",\n \"Conditions\": {\n \"Platform\": \"PlayStation\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 2,\n \"Deaths\": 20\n }\n },\n {\n \"Entity\": {\n \"Id\": \"9731\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SecondsPlayed\": 900,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"PlayStation\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 3,\n \"Deaths\": 15\n }\n }\n ],\n \"Rank\": 1\n }\n ],\n \"StartDateTimeUtc\": \"2024-11-08T13:30:37Z\",\n \"EndDateTimeUtc\": \"2024-11-08T14:00:37Z\"\n }\n}", + "requestExample": "{\n \"MatchResult\": {\n \"ScenarioId\": \"f9f0331e-0149-42ba-a994-29b18cac4e4d\",\n \"Teams\": [\n {\n \"Players\": [\n {\n \"Entity\": {\n \"Id\": \"5678\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"PreMatchPartyId\": \"630a6523-8853-4cf6-9fda-c7da84f3d87a\",\n \"SecondsPlayed\": 1800,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"PC\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 35,\n \"Deaths\": 5\n }\n },\n {\n \"Entity\": {\n \"Id\": \"8765\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"PreMatchPartyId\": \"630a6523-8853-4cf6-9fda-c7da84f3d87a\",\n \"SecondsPlayed\": 1800,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 15,\n \"Deaths\": 10\n }\n }\n ],\n \"Rank\": 0\n },\n {\n \"Players\": [\n {\n \"SecondsPlayed\": 1800,\n \"BotId\": 77,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"Xbox\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 10,\n \"Deaths\": 15\n }\n },\n {\n \"Entity\": {\n \"Id\": \"0371\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SecondsPlayed\": 900,\n \"CompletionStatus\": \"Disconnected\",\n \"Conditions\": {\n \"Platform\": \"PlayStation\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 2,\n \"Deaths\": 20\n }\n },\n {\n \"Entity\": {\n \"Id\": \"9731\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"SecondsPlayed\": 900,\n \"CompletionStatus\": \"Completed\",\n \"Conditions\": {\n \"Platform\": \"PlayStation\",\n \"Mode\": \"Deathmatch\"\n },\n \"EventCounts\": {\n \"Kills\": 3,\n \"Deaths\": 15\n }\n }\n ],\n \"Rank\": 1\n }\n ],\n \"StartDateTimeUtc\": \"2024-11-22T13:30:59.803Z\",\n \"EndDateTimeUtc\": \"2024-11-22T14:00:59.803Z\"\n }\n}", "result": "UploadMatchResultResponse", - "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"MatchResultId\": \"62f531c9d84065895ab12663efab5a85\",\n \"UploadTimeUtc\": \"2024-11-08T14:00:37.004Z\"\n }\n}", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"MatchResultId\": \"62f531c9d84065895ab12663efab5a85\",\n \"UploadTimeUtc\": \"2024-11-22T14:00:59.808Z\"\n }\n}", "AnyInclusiveFlags": [ "Beta" ], @@ -17378,6 +17391,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -18494,6 +18515,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -19111,6 +19140,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -19390,6 +19421,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Profiles.api.json b/Legacy/PlayFab/Profiles.api.json index 893d25f6..d20ef9a1 100644 --- a/Legacy/PlayFab/Profiles.api.json +++ b/Legacy/PlayFab/Profiles.api.json @@ -3470,6 +3470,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4586,6 +4594,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -5203,6 +5219,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5482,6 +5500,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Progression.api.json b/Legacy/PlayFab/Progression.api.json index b06822a4..a529e130 100644 --- a/Legacy/PlayFab/Progression.api.json +++ b/Legacy/PlayFab/Progression.api.json @@ -1874,11 +1874,22 @@ "result": "GetEntityLeaderboardResponse", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Version\": 5,\n \"Rankings\": [\n {\n \"Entity\": {\n \"Id\": \"1784371290HJA9\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"DisplayName\": \"FastHand\",\n \"Score\": 0,\n \"Scores\": [\n \"4503\"\n ],\n \"Rank\": 1,\n \"LastUpdated\": \"0001-01-01T00:00:00Z\"\n },\n {\n \"Entity\": {\n \"Id\": \"1947109JA18412\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"DisplayName\": \"Mouse\",\n \"Score\": 0,\n \"Scores\": [\n \"4502\"\n ],\n \"Rank\": 2,\n \"LastUpdated\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"EntryCount\": 0\n }\n}", "errors": [ + "AccountNotFound", "ApiNotEnabledForTitle", + "DownstreamServiceUnavailable", + "ExpiredXboxLiveToken", + "FacebookAPIError", "InvalidEntityType", + "InvalidSignature", + "InvalidSignatureTime", + "InvalidXboxLiveToken", "LeaderboardNotFound", "NoLeaderboardForStatistic", - "StatisticNotFound" + "PlayerSecretNotConfigured", + "StatisticNotFound", + "XboxInaccessible", + "XboxServiceTooManyRequests", + "XboxXASSExchangeFailure" ] }, { @@ -2188,7 +2199,8 @@ "InvalidEntityType", "NotAuthorized", "StatisticColumnLengthMismatch", - "StatisticNotFound" + "StatisticNotFound", + "TransactionAlreadyApplied" ] } ], @@ -4525,6 +4537,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -5641,6 +5661,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -6258,6 +6286,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -6537,6 +6567,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Server.api.json b/Legacy/PlayFab/Server.api.json index 4012fc99..b704e800 100644 --- a/Legacy/PlayFab/Server.api.json +++ b/Legacy/PlayFab/Server.api.json @@ -5052,6 +5052,12 @@ { "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + { + "name": "TransactionAlreadyApplied" + }, + { + "name": "ReportDataNotRetrievedSuccessfully" + }, { "name": "MatchmakingEntityInvalid" }, @@ -5889,6 +5895,12 @@ { "name": "GameSaveOperationNotAllowed" }, + { + "name": "GameSaveDataStorageQuotaExceeded" + }, + { + "name": "GameSaveNewerManifestExists" + }, { "name": "StateShareForbidden" }, @@ -7942,6 +7954,42 @@ } ] }, + "GetPlayFabIDsFromSteamNamesRequest": { + "name": "GetPlayFabIDsFromSteamNamesRequest", + "className": "GetPlayFabIDsFromSteamNamesRequest", + "classNameSpace": "PlayFab.Server.Models", + "assembly": "PlayFab.Server.Models", + "isRequest": true, + "properties": [ + { + "name": "SteamNames", + "description": "Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.", + "collection": "array", + "jsontype": "String", + "actualtype": "String", + "optional": false + } + ] + }, + "GetPlayFabIDsFromSteamNamesResult": { + "name": "GetPlayFabIDsFromSteamNamesResult", + "className": "GetPlayFabIDsFromSteamNamesResult", + "classNameSpace": "PlayFab.Server.Models", + "assembly": "PlayFab.Server.Models", + "description": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.", + "isResult": true, + "properties": [ + { + "name": "Data", + "description": "Mapping of Steam identifiers to PlayFab identifiers.", + "collection": "array", + "jsontype": "Object", + "actualtype": "SteamNamePlayFabIdPair", + "isclass": true, + "optional": true + } + ] + }, "GetPlayFabIDsFromTwitchIDsRequest": { "name": "GetPlayFabIDsFromTwitchIDsRequest", "className": "GetPlayFabIDsFromTwitchIDsRequest", @@ -13168,6 +13216,28 @@ } ] }, + "SteamNamePlayFabIdPair": { + "name": "SteamNamePlayFabIdPair", + "className": "SteamNamePlayFabIdPair", + "classNameSpace": "PlayFab.Server.Models", + "assembly": "PlayFab.Server.Models", + "properties": [ + { + "name": "PlayFabId", + "description": "Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.", + "jsontype": "String", + "actualtype": "String", + "optional": true + }, + { + "name": "SteamName", + "description": "Unique Steam identifier for a user, also known as Steam persona name.", + "jsontype": "String", + "actualtype": "String", + "optional": true + } + ] + }, "SteamPlayFabIdPair": { "name": "SteamPlayFabIdPair", "className": "SteamPlayFabIdPair", @@ -15727,6 +15797,7 @@ "GetPlayFabIDsFromPSNAccountIDs", "GetPlayFabIDsFromPSNOnlineIDs", "GetPlayFabIDsFromSteamIDs", + "GetPlayFabIDsFromSteamNames", "GetPlayFabIDsFromTwitchIDs", "GetPlayFabIDsFromXboxLiveIDs", "GetServerCustomIDsFromPlayFabIDs", @@ -16962,6 +17033,20 @@ "result": "GetPlayFabIDsFromSteamIDsResult", "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": [\n {\n \"SteamStringId\": \"857498576495\",\n \"PlayFabId\": \"5a446c83645201\"\n },\n {\n \"SteamStringId\": \"759374651209\",\n \"PlayFabId\": \"6345cd25a6c7cc\"\n }\n ]\n }\n}" }, + { + "name": "GetPlayFabIDsFromSteamNames", + "summary": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.", + "resultDetails": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.", + "subgroup": "Account Management", + "titleTiers": null, + "url": "/Server/GetPlayFabIDsFromSteamNames", + "auth": "SecretKey", + "method": "POST", + "request": "GetPlayFabIDsFromSteamNamesRequest", + "requestExample": "{\n \"SteamNames\": [\n \"steamPersonaName1\",\n \"steamPersonaName2\"\n ]\n}", + "result": "GetPlayFabIDsFromSteamNamesResult", + "resultExample": "{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"Data\": [\n {\n \"SteamName\": \"steamPersonaName1\",\n \"PlayFabId\": \"18727374849283\"\n },\n {\n \"SteamName\": \"steamPersonaName2\",\n \"PlayFabId\": \"18727374849284\"\n }\n ]\n }\n}" + }, { "name": "GetPlayFabIDsFromTwitchIDs", "summary": "Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).", @@ -21402,6 +21487,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -22518,6 +22611,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -23135,6 +23236,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -23414,6 +23517,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/State.api.json b/Legacy/PlayFab/State.api.json index f1a70f93..fd8331ed 100644 --- a/Legacy/PlayFab/State.api.json +++ b/Legacy/PlayFab/State.api.json @@ -3095,6 +3095,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4211,6 +4219,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4828,6 +4844,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -5107,6 +5125,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/Legacy/PlayFab/Sweepstakes.api.json b/Legacy/PlayFab/Sweepstakes.api.json index 4ee0c88a..38f9af85 100644 --- a/Legacy/PlayFab/Sweepstakes.api.json +++ b/Legacy/PlayFab/Sweepstakes.api.json @@ -2577,6 +2577,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3693,6 +3701,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" @@ -4310,6 +4326,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -4589,6 +4607,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", diff --git a/SdkManualNotes.json b/SdkManualNotes.json index 99f11466..92e63438 100644 --- a/SdkManualNotes.json +++ b/SdkManualNotes.json @@ -1,21 +1,21 @@ { "description": "This file records version numbers for each SdkGenerator target. Keys must be lowercase, and match subfolders in SdkGenerator/targets.", "sdkVersion": { - "azure": "0.78.241108", - "csharp": "1.192.241108", - "javascript": "1.183.241108", - "java": "0.228.241108", - "luasdk": "0.195.241108", - "js-node": "2.165.241108", - "postman": "0.220.241108", - "unity-v2": "2.205.241108", - "xplatcppsdk": "3.148.241108", - "phpsdk": "0.0.241108", - "sdktestingcloudscript": "0.0.241108", - "objc": "0.0.241108", - "pythonsdk": "0.0.241108", - "unrealmarketplaceplugin": "1.155.241108", + "azure": "0.79.241122", + "csharp": "1.193.241122", + "javascript": "1.184.241122", + "java": "0.229.241122", + "luasdk": "0.196.241122", + "js-node": "2.166.241122", + "postman": "0.221.241122", + "unity-v2": "2.206.241122", + "xplatcppsdk": "3.149.241122", + "phpsdk": "0.0.241122", + "sdktestingcloudscript": "0.0.241122", + "objc": "0.0.241122", + "pythonsdk": "0.0.241122", + "unrealmarketplaceplugin": "1.156.241122", "newtarget": "0.0.todaysDate", - "jcutestrepo": "0.0.241108" + "jcutestrepo": "0.0.241122" } } \ No newline at end of file diff --git a/Swagger/PlayFab/Addon.swagger.json b/Swagger/PlayFab/Addon.swagger.json index 5531c193..2b0def9d 100644 --- a/Swagger/PlayFab/Addon.swagger.json +++ b/Swagger/PlayFab/Addon.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Addon API", "description": "APIs for managing addons.", "termsOfService": "https://playfab.com/terms/", @@ -5066,6 +5066,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -6182,6 +6190,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Admin.swagger.json b/Swagger/PlayFab/Admin.swagger.json index 8838f006..38800e0c 100644 --- a/Swagger/PlayFab/Admin.swagger.json +++ b/Swagger/PlayFab/Admin.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Admin API", "description": "APIs for managing title configurations, uploaded Game Server code executables, and user data", "termsOfService": "https://playfab.com/terms/", @@ -1446,6 +1446,7 @@ "x-requestDetails": "Gets the download URL for the requested report data (in CSV form). The reports available through this API call are those available in the Game Manager, in the Analytics->Reports tab.", "x-ms-docs-errors": [ "InvalidReportDate", + "ReportDataNotRetrievedSuccessfully", "ReportNotAvailable" ] } @@ -7447,6 +7448,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -7726,6 +7729,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", @@ -20811,6 +20816,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -21927,6 +21940,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Authentication.swagger.json b/Swagger/PlayFab/Authentication.swagger.json index b04b9a03..cec112ac 100644 --- a/Swagger/PlayFab/Authentication.swagger.json +++ b/Swagger/PlayFab/Authentication.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Authentication API", "description": "The Authentication APIs provide a convenient way to convert classic authentication responses into entity authentication models. These APIs will provide you with the entity authentication token needed for subsequent Entity API calls. The game_server API is designed to create uniquely identifiable game_server entities. The game_server Entity token can be used to call Matchmaking Lobby and Pubsub for server scenarios.", "termsOfService": "https://playfab.com/terms/", @@ -3032,6 +3032,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4148,6 +4156,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Client.swagger.json b/Swagger/PlayFab/Client.swagger.json index 1a70b273..2de01158 100644 --- a/Swagger/PlayFab/Client.swagger.json +++ b/Swagger/PlayFab/Client.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Client API", "description": "APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory, friends, matchmaking, reporting, and platform-specific functionality", "termsOfService": "https://playfab.com/terms/", @@ -2056,6 +2056,37 @@ "x-responseDetails": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned." } }, + "/Client/GetPlayFabIDsFromSteamNames": { + "post": { + "operationId": "GetPlayFabIDsFromSteamNames", + "tags": [ + "Account Management" + ], + "description": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames" + }, + "parameters": [ + { + "$ref": "#/parameters/GetPlayFabIDsFromSteamNamesRequest" + } + ], + "security": [ + { + "SessionTicket": [] + } + ], + "responses": { + "200": { + "$ref": "#/responses/GetPlayFabIDsFromSteamNamesResult" + }, + "400": { + "$ref": "#/responses/ApiErrorWrapper" + } + }, + "x-responseDetails": "For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned." + } + }, "/Client/GetPlayFabIDsFromTwitchIDs": { "post": { "operationId": "GetPlayFabIDsFromTwitchIDs", @@ -4014,6 +4045,7 @@ "x-ms-docs-errors": [ "EncryptionKeyMissing", "EvaluationModePlayerCountExceeded", + "FeatureNotConfiguredForTitle", "InvalidPSNAuthCode", "InvalidPSNIssuerId", "PlayerSecretAlreadyConfigured", @@ -10664,6 +10696,53 @@ ] } }, + "GetPlayFabIDsFromSteamNamesRequest": { + "type": "object", + "properties": { + "SteamNames": { + "description": "Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "SteamNames" + ], + "example": { + "SteamNames": [ + "steamPersonaName1", + "steamPersonaName2" + ] + } + }, + "GetPlayFabIDsFromSteamNamesResult": { + "description": "For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.", + "type": "object", + "properties": { + "Data": { + "description": "Mapping of Steam identifiers to PlayFab identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SteamNamePlayFabIdPair" + }, + "x-isclass": true + } + }, + "example": { + "Data": [ + { + "SteamName": "steamPersonaName1", + "PlayFabId": "18727374849283" + }, + { + "SteamName": "steamPersonaName2", + "PlayFabId": "18727374849284" + } + ] + } + }, "GetPlayFabIDsFromTwitchIDsRequest": { "type": "object", "properties": { @@ -14774,6 +14853,19 @@ "Version": 2 } }, + "SteamNamePlayFabIdPair": { + "type": "object", + "properties": { + "PlayFabId": { + "description": "Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.", + "type": "string" + }, + "SteamName": { + "description": "Unique Steam identifier for a user, also known as Steam persona name.", + "type": "string" + } + } + }, "SteamPlayFabIdPair": { "type": "object", "properties": { @@ -17195,6 +17287,13 @@ "$ref": "#/definitions/GetPlayFabIDsFromSteamIDsRequest" } }, + "GetPlayFabIDsFromSteamNamesRequest": { + "name": "GetPlayFabIDsFromSteamNamesRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/GetPlayFabIDsFromSteamNamesRequest" + } + }, "GetPlayFabIDsFromTwitchIDsRequest": { "name": "GetPlayFabIDsFromTwitchIDsRequest", "in": "body", @@ -20047,6 +20146,41 @@ } } }, + "GetPlayFabIDsFromSteamNamesResult": { + "description": "For Steam identifiers which have not been linked to PlayFab accounts, or if the user has not logged in recently, null will be returned.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "description": "The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code." + }, + "status": { + "type": "string", + "description": "The Http status code as a string." + }, + "data": { + "$ref": "#/definitions/GetPlayFabIDsFromSteamNamesResult" + } + }, + "example": { + "code": 200, + "status": "OK", + "data": { + "Data": [ + { + "SteamName": "steamPersonaName1", + "PlayFabId": "18727374849283" + }, + { + "SteamName": "steamPersonaName2", + "PlayFabId": "18727374849284" + } + ] + } + } + } + }, "GetPlayFabIDsFromTwitchIDsResult": { "description": "For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.", "schema": { @@ -24485,6 +24619,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -25601,6 +25743,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/CloudScript.swagger.json b/Swagger/PlayFab/CloudScript.swagger.json index e9bdfaf1..42a10d5f 100644 --- a/Swagger/PlayFab/CloudScript.swagger.json +++ b/Swagger/PlayFab/CloudScript.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab CloudScript API", "description": "API methods for executing CloudScript using an Entity Profile", "termsOfService": "https://playfab.com/terms/", @@ -4796,6 +4796,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -5912,6 +5920,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Data.swagger.json b/Swagger/PlayFab/Data.swagger.json index c5abe69e..a877cbdc 100644 --- a/Swagger/PlayFab/Data.swagger.json +++ b/Swagger/PlayFab/Data.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Data API", "description": "Store arbitrary data associated with an entity. Objects are small (~1KB) JSON-compatible objects which are stored directly on the entity profile. Objects are made available for use in other PlayFab contexts, such as PlayStream events and CloudScript functions. Files can efficiently store data of any size or format. Both objects and files support a flexible permissions system to control read and write access by other entities.", "termsOfService": "https://playfab.com/terms/", @@ -3662,6 +3662,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4778,6 +4786,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Economy.swagger.json b/Swagger/PlayFab/Economy.swagger.json index 39e2a3e5..0fb15654 100644 --- a/Swagger/PlayFab/Economy.swagger.json +++ b/Swagger/PlayFab/Economy.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Economy API", "description": "API methods for managing the catalog. Inventory manages in-game assets for any given entity.", "termsOfService": "https://playfab.com/terms/", @@ -12168,6 +12168,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -13284,6 +13292,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Events.swagger.json b/Swagger/PlayFab/Events.swagger.json index 8b6a42d9..7e5b61f6 100644 --- a/Swagger/PlayFab/Events.swagger.json +++ b/Swagger/PlayFab/Events.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Events API", "description": "Write custom PlayStream and Telemetry events for any PlayFab entity. Telemetry events can be used for analytic, reporting, or debugging. PlayStream events can do all of that and also trigger custom actions in near real-time.", "termsOfService": "https://playfab.com/terms/", @@ -3264,6 +3264,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4380,6 +4388,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Experimentation.swagger.json b/Swagger/PlayFab/Experimentation.swagger.json index 069425af..615ea954 100644 --- a/Swagger/PlayFab/Experimentation.swagger.json +++ b/Swagger/PlayFab/Experimentation.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Experimentation API", "description": "APIs for managing experiments.", "termsOfService": "https://playfab.com/terms/", @@ -4091,6 +4091,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -5207,6 +5215,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Groups.swagger.json b/Swagger/PlayFab/Groups.swagger.json index 878c2dd5..691ff922 100644 --- a/Swagger/PlayFab/Groups.swagger.json +++ b/Swagger/PlayFab/Groups.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Groups API", "description": "The Groups API is designed for any permanent or semi-permanent collections of Entities (players, or non-players). If you want to make Guilds/Clans/Corporations/etc., then you should use groups. Groups can also be used to make chatrooms, parties, or any other persistent collection of entities.", "termsOfService": "https://playfab.com/terms/", @@ -6010,6 +6010,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -7126,6 +7134,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Insights.swagger.json b/Swagger/PlayFab/Insights.swagger.json index 45cc4d47..c33e57ef 100644 --- a/Swagger/PlayFab/Insights.swagger.json +++ b/Swagger/PlayFab/Insights.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Insights API", "description": "Manage the Insights performance level and data storage retention settings.", "termsOfService": "https://playfab.com/terms/", @@ -3068,6 +3068,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4184,6 +4192,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Localization.swagger.json b/Swagger/PlayFab/Localization.swagger.json index 539951a8..9377ef05 100644 --- a/Swagger/PlayFab/Localization.swagger.json +++ b/Swagger/PlayFab/Localization.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Localization API", "description": "The Localization APIs give you the tools needed to manage language setup in your title.", "termsOfService": "https://playfab.com/terms/", @@ -2527,6 +2527,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3643,6 +3651,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Matchmaker.swagger.json b/Swagger/PlayFab/Matchmaker.swagger.json index a4b58ff6..91e1e724 100644 --- a/Swagger/PlayFab/Matchmaker.swagger.json +++ b/Swagger/PlayFab/Matchmaker.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Matchmaker API", "description": "Enables the use of an external match-making service in conjunction with PlayFab hosted Game Server instances", "termsOfService": "https://playfab.com/terms/", @@ -2433,6 +2433,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3549,6 +3557,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Multiplayer.swagger.json b/Swagger/PlayFab/Multiplayer.swagger.json index 6d483ff3..efbf0463 100644 --- a/Swagger/PlayFab/Multiplayer.swagger.json +++ b/Swagger/PlayFab/Multiplayer.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Multiplayer API", "description": "API methods for managing multiplayer servers. API methods for managing parties. The lobby service helps players group together to play multiplayer games. It is often used as a rendezvous point for players to share connection information. The TrueSkill service helps titles to estimate a player's skill based on their match results. The player skill values from this service are commonly used by a matchmaking service to provide players with balanced matches.", "termsOfService": "https://playfab.com/terms/", @@ -1441,6 +1441,11 @@ } }, "x-requestDetails": "Creates a multiplayer server build alias and returns the created alias.", + "x-seeAlso": [ + "MultiplayerServer/DeleteBuildAlias", + "MultiplayerServer/GetBuildAlias", + "MultiplayerServer/UpdateBuildAlias" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -1575,6 +1580,12 @@ } }, "x-requestDetails": "Creates a multiplayer server build with the game server running as a process and returns information about the build creation request.", + "x-seeAlso": [ + "MultiplayerServer/CreateBuildWithManagedContainer", + "MultiplayerServer/DeleteBuild", + "MultiplayerServer/GetBuild", + "MultiplayerServer/ListBuildSummariesV2" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -1796,6 +1807,11 @@ } }, "x-requestDetails": "Deletes a multiplayer server build alias.", + "x-seeAlso": [ + "MultiplayerServer/CreateBuildAlias", + "MultiplayerServer/GetBuildAlias", + "MultiplayerServer/UpdateBuildAlias" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBuildAliasReferencedByMatchmakingQueue", @@ -2110,6 +2126,10 @@ } }, "x-requestDetails": "Gets a URL that can be used to download the specified asset.", + "x-seeAlso": [ + "MultiplayerServer/GetAssetUploadUrl", + "MultiplayerServer/ListAssetSummaries" + ], "x-ms-docs-errors": [ "MultiplayerServerBadRequest", "MultiplayerServerForbidden", @@ -2197,6 +2217,11 @@ } }, "x-requestDetails": "Returns the details about a multiplayer server build.", + "x-seeAlso": [ + "MultiplayerServer/CreateBuildWithManagedContainer", + "MultiplayerServer/DeleteBuild", + "MultiplayerServer/ListBuildSummariesV2" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -2238,6 +2263,11 @@ } }, "x-requestDetails": "Returns the details about a multiplayer server build alias.", + "x-seeAlso": [ + "MultiplayerServer/CreateBuildAlias", + "MultiplayerServer/DeleteBuildAlias", + "MultiplayerServer/UpdateBuildAlias" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -2324,6 +2354,9 @@ } }, "x-requestDetails": "Gets multiplayer server session details for a build in a specific region.", + "x-seeAlso": [ + "MultiplayerServer/RequestMultiplayerServer" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -2364,6 +2397,10 @@ } }, "x-requestDetails": "Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated.", + "x-seeAlso": [ + "MultiplayerServer/GetMultiplayerServerDetails", + "MultiplayerServer/RequestMultiplayerServer" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -2405,6 +2442,10 @@ } }, "x-requestDetails": "Gets multiplayer server logs for a specific server id in a region. The logs are available only after a server has terminated.", + "x-seeAlso": [ + "MultiplayerServer/GetMultiplayerServerDetails", + "MultiplayerServer/RequestMultiplayerServer" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -2490,6 +2531,9 @@ } }, "x-requestDetails": "Gets the status of whether a title is enabled for the multiplayer server feature. The enabled status can be Initializing, Enabled, and Disabled.", + "x-seeAlso": [ + "MultiplayerServer/EnableMultiplayerServersForTitle" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -3351,6 +3395,11 @@ } }, "x-requestDetails": "Creates a multiplayer server build alias and returns the created alias.", + "x-seeAlso": [ + "MultiplayerServer/CreateBuildAlias", + "MultiplayerServer/DeleteBuildAlias", + "MultiplayerServer/GetBuildAlias" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -3392,6 +3441,13 @@ } }, "x-requestDetails": "Updates a multiplayer server build's name.", + "x-seeAlso": [ + "MultiplayerServer/DeleteBuild", + "MultiplayerServer/GetBuild", + "MultiplayerServer/ListBuildSummariesV2", + "MultiplayerServer/UpdateBuildRegion", + "MultiplayerServer/UpdateBuildRegions" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -3433,6 +3489,13 @@ } }, "x-requestDetails": "Updates a multiplayer server build's region.", + "x-seeAlso": [ + "MultiplayerServer/DeleteBuild", + "MultiplayerServer/DeleteBuildRegion", + "MultiplayerServer/GetBuild", + "MultiplayerServer/ListBuildSummariesV2", + "MultiplayerServer/UpdateBuildRegions" + ], "x-ms-docs-errors": [ "APINotEnabledForGameClientAccess", "MultiplayerServerBadRequest", @@ -3809,7 +3872,9 @@ "CentralIndia", "UaeNorth", "UkSouth", - "SwedenCentral" + "SwedenCentral", + "CanadaCentral", + "MexicoCentral" ] }, "AzureVmFamily": { @@ -17484,6 +17549,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -18600,6 +18673,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Profiles.swagger.json b/Swagger/PlayFab/Profiles.swagger.json index c2078922..71b86279 100644 --- a/Swagger/PlayFab/Profiles.swagger.json +++ b/Swagger/PlayFab/Profiles.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Profiles API", "description": "All PlayFab entities have profiles, which hold top-level properties about the entity. These APIs give you the tools needed to manage entity profiles.", "termsOfService": "https://playfab.com/terms/", @@ -3840,6 +3840,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -4956,6 +4964,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Progression.swagger.json b/Swagger/PlayFab/Progression.swagger.json index 125a7bf6..abc6f244 100644 --- a/Swagger/PlayFab/Progression.swagger.json +++ b/Swagger/PlayFab/Progression.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Progression API", "description": "Manage entity statistics Manage entity leaderboards", "termsOfService": "https://playfab.com/terms/", @@ -179,11 +179,22 @@ } }, "x-ms-docs-errors": [ + "AccountNotFound", "ApiNotEnabledForTitle", + "DownstreamServiceUnavailable", + "ExpiredXboxLiveToken", + "FacebookAPIError", "InvalidEntityType", + "InvalidSignature", + "InvalidSignatureTime", + "InvalidXboxLiveToken", "LeaderboardNotFound", "NoLeaderboardForStatistic", - "StatisticNotFound" + "PlayerSecretNotConfigured", + "StatisticNotFound", + "XboxInaccessible", + "XboxServiceTooManyRequests", + "XboxXASSExchangeFailure" ] } }, @@ -821,7 +832,8 @@ "InvalidEntityType", "NotAuthorized", "StatisticColumnLengthMismatch", - "StatisticNotFound" + "StatisticNotFound", + "TransactionAlreadyApplied" ] } } @@ -5329,6 +5341,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -6445,6 +6465,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Server.swagger.json b/Swagger/PlayFab/Server.swagger.json index 0a54a282..7244965d 100644 --- a/Swagger/PlayFab/Server.swagger.json +++ b/Swagger/PlayFab/Server.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Server API", "description": "Provides functionality to allow external (developer-controlled) servers to interact with user inventories and data in a trusted manner, and to handle matchmaking and client connection orchestration", "termsOfService": "https://playfab.com/terms/", @@ -1752,6 +1752,37 @@ "x-responseDetails": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned." } }, + "/Server/GetPlayFabIDsFromSteamNames": { + "post": { + "operationId": "GetPlayFabIDsFromSteamNames", + "tags": [ + "Account Management" + ], + "description": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona names.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames" + }, + "parameters": [ + { + "$ref": "#/parameters/GetPlayFabIDsFromSteamNamesRequest" + } + ], + "security": [ + { + "SecretKey": [] + } + ], + "responses": { + "200": { + "$ref": "#/responses/GetPlayFabIDsFromSteamNamesResult" + }, + "400": { + "$ref": "#/responses/ApiErrorWrapper" + } + }, + "x-responseDetails": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned." + } + }, "/Server/GetPlayFabIDsFromTwitchIDs": { "post": { "operationId": "GetPlayFabIDsFromTwitchIDs", @@ -7488,6 +7519,8 @@ "StatisticColumnLengthMismatch", "InvalidExternalEntityId", "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier", + "TransactionAlreadyApplied", + "ReportDataNotRetrievedSuccessfully", "MatchmakingEntityInvalid", "MatchmakingPlayerAttributesInvalid", "MatchmakingQueueNotFound", @@ -7767,6 +7800,8 @@ "GameSaveFileNotUploaded", "GameSaveBadRequest", "GameSaveOperationNotAllowed", + "GameSaveDataStorageQuotaExceeded", + "GameSaveNewerManifestExists", "StateShareForbidden", "StateShareTitleNotInFlight", "StateShareStateNotFound", @@ -9943,6 +9978,53 @@ ] } }, + "GetPlayFabIDsFromSteamNamesRequest": { + "type": "object", + "properties": { + "SteamNames": { + "description": "Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "SteamNames" + ], + "example": { + "SteamNames": [ + "steamPersonaName1", + "steamPersonaName2" + ] + } + }, + "GetPlayFabIDsFromSteamNamesResult": { + "description": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.", + "type": "object", + "properties": { + "Data": { + "description": "Mapping of Steam identifiers to PlayFab identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SteamNamePlayFabIdPair" + }, + "x-isclass": true + } + }, + "example": { + "Data": [ + { + "SteamName": "steamPersonaName1", + "PlayFabId": "18727374849283" + }, + { + "SteamName": "steamPersonaName2", + "PlayFabId": "18727374849284" + } + ] + } + }, "GetPlayFabIDsFromTwitchIDsRequest": { "type": "object", "properties": { @@ -13742,6 +13824,19 @@ "Version": 2 } }, + "SteamNamePlayFabIdPair": { + "type": "object", + "properties": { + "PlayFabId": { + "description": "Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier.", + "type": "string" + }, + "SteamName": { + "description": "Unique Steam identifier for a user, also known as Steam persona name.", + "type": "string" + } + } + }, "SteamPlayFabIdPair": { "type": "object", "properties": { @@ -15844,6 +15939,13 @@ "$ref": "#/definitions/GetPlayFabIDsFromSteamIDsRequest" } }, + "GetPlayFabIDsFromSteamNamesRequest": { + "name": "GetPlayFabIDsFromSteamNamesRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/GetPlayFabIDsFromSteamNamesRequest" + } + }, "GetPlayFabIDsFromTwitchIDsRequest": { "name": "GetPlayFabIDsFromTwitchIDsRequest", "in": "body", @@ -18052,6 +18154,41 @@ } } }, + "GetPlayFabIDsFromSteamNamesResult": { + "description": "For Steam identifiers which have not been linked to PlayFab accounts, null will be returned.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "description": "The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code." + }, + "status": { + "type": "string", + "description": "The Http status code as a string." + }, + "data": { + "$ref": "#/definitions/GetPlayFabIDsFromSteamNamesResult" + } + }, + "example": { + "code": 200, + "status": "OK", + "data": { + "Data": [ + { + "SteamName": "steamPersonaName1", + "PlayFabId": "18727374849283" + }, + { + "SteamName": "steamPersonaName2", + "PlayFabId": "18727374849284" + } + ] + } + } + } + }, "GetPlayFabIDsFromTwitchIDsResult": { "description": "For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.", "schema": { @@ -22182,6 +22319,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -23298,6 +23443,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/State.swagger.json b/Swagger/PlayFab/State.swagger.json index f3806826..5bb28ede 100644 --- a/Swagger/PlayFab/State.swagger.json +++ b/Swagger/PlayFab/State.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab State API", "description": "Allow storage and retrieval of game specific state, on a per entity basis.", "termsOfService": "https://playfab.com/terms/", @@ -2436,6 +2436,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3552,6 +3560,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden" diff --git a/Swagger/PlayFab/Sweepstakes.swagger.json b/Swagger/PlayFab/Sweepstakes.swagger.json index 5a435c9e..074f8bb6 100644 --- a/Swagger/PlayFab/Sweepstakes.swagger.json +++ b/Swagger/PlayFab/Sweepstakes.swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "241108", + "version": "241122", "title": "PlayFab Sweepstakes API", "description": "The sweepstakes API is designed for game developers to create and view a sweepstakes via a title. ", "termsOfService": "https://playfab.com/terms/", @@ -2436,6 +2436,14 @@ "id": 1595, "name": "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" }, + "TransactionAlreadyApplied": { + "id": 1596, + "name": "TransactionAlreadyApplied" + }, + "ReportDataNotRetrievedSuccessfully": { + "id": 1597, + "name": "ReportDataNotRetrievedSuccessfully" + }, "MatchmakingEntityInvalid": { "id": 2001, "name": "MatchmakingEntityInvalid" @@ -3552,6 +3560,14 @@ "id": 20310, "name": "GameSaveOperationNotAllowed" }, + "GameSaveDataStorageQuotaExceeded": { + "id": 20311, + "name": "GameSaveDataStorageQuotaExceeded" + }, + "GameSaveNewerManifestExists": { + "id": 20312, + "name": "GameSaveNewerManifestExists" + }, "StateShareForbidden": { "id": 21000, "name": "StateShareForbidden"