v2.10.0 March 20, 2022 "Economy v2 General Availability" Release Notes

PlayFab Economy v2 is now Generally Available!

After six months of Public Preview, we can now highlight PlayFab Economy v2 as released. Join studios such as Mojang, Rare, 343 Studios, World's Edge, Gameloft, and many more who have built #1 selling games on the platform.

Pricing

• UGC Section has been updated to "Economy v2 - ITEMS, CURRENCY, BUNDLES, RECIPES, STORES, USER GENERATED CONTENT" to properly reflect the billing grouping for Economy v2 Public Preview.

Features

• Inventory Collections A new API allows Inventory Collections to be managed via a CRUD interface.

Bugfixes

• Game Manager UI improvements.

Roadmap

See the Roadmap.

Documentation

• Minor fixes.

Known Issues

• None at this time.

Changelog

Game Manager

• Remove unused legacy game servers code Legacy game server hosting has been disabled for months. Removing unused code for:,-Uploading and processing game server build file packages,-Starting/stopping game server processes on hosted game server VMs,-Collecting and archiving game server logs and output files,-Servers list tab in Game Manager,The GameBuild record and CRUD operations have to remain for now, as they are also used by the legacy matchmaking,APIs.
• Updating Economy GA APIs that can be called from CloudScript Updating the APIs that can be called. This change adds all the GA APIs.
• Restrict GetTitlePlayer APIs to the same namespace as the caller Restricted namespace, added test, removed previous fix., Review changes., Updated EntityTokenAuthValidation., Review changes., Only checking namespace when necessary., Review change., Change for consistency., Avoiding extra call of Title.GetAsync.
• Add monitoring for playstream processor entityprofile
• Segmentation: refactor KustoFilter construction from segment predicates
• Add DataConnections app id config
• Add Redirect URI RedeemPlayStationStoreInventoryItemsRequest
• Update error code list
• Fix error logging when tracking leaderboard query fails
• Analytics segments management APIs cleanup and fixes
• Update deletion code path for MPA Delete
• Add feature flag for Inventory/GetMicrosoftStoreAccessTokens, Return NotImplemented for Inventory/GetMicrosoftStoreAccessTokens
• Unified Error Codes, 🐛 Fix error mapping
• Update msft add-on description
• add deletion flags for Economy v2 deletions
• Fix Billing Messages
• Fixed a bug with showing old churn predicates
• Deprecated legacy matchmaker APIs
• 💄 update GM economy strings to V2 and Legacy
• REST API updates for Economy
• Updated churn billing summary
• Bump dependencies for VanguardOutrider
• Localization files updated
• Improved default performance of PlayerCustomProperties
• Fixed issues with deleting players
• Add PSN token refreshing to RedeemPlayStationStoreInventoryItems
• Economy GA Page Size Limits Updating per the spec: GetItemReviews = 50
• Make leaderboard creation for stat intentional rather than automatic
• Encourage clients to retry the tickets when it's cancelled by RetryRequired
• Show only a player's own entity in TransactionHistory For transfers, if the caller is a player, Inventory's,GetTransactionHistory will show only that player's entity,,be it the Giving or Receiving entity.,Title entities can view both. This mapping can be also,used for GDPR purposes.
• Fix Game Manager transaction history for transactions without operations
• Economy GA Catalog Config Limits Updated: MaxDeepLinksCount = 10; MaxPlatformsCount = 128; MaxPlatformsLength = 40;
• Updating Redemption APIs to support OfferId filtering: We're adding support for offer id filtering to all the public redemption APIs.
• Change TelemetryKey 'Enabled/Disabled' terms to 'Active/Deactivated'
• ✨ Rework and Expose Subscriptions in Game Manager UX
• Add null check to LinkSteamAccount
• Prevent creating paid data connections without payment methods
• Update scorecard endpoint for Experimentation
• ✨ Add support for removing marketplace config
• Billing Summary string localization for Player Churn meter
• Remove mention of upgrades in limit exceeded notification email: Limit upgrades aren't supported anymore
• Fixed a bug with the Title Overview not responding
• Added Economy V2 deletions to DeleteMasterPlayer
• Removed link to event history from legacy servers active game
• Add analytics segment IDs to reporting events
• Enable display of inventory items removed from catalog
• Added Opt-in for activating Player Churn
• Fix Nintendo add-on config regression for login: Customers who had used V2 UI to save credentials didn't see the green bar on the Nintendo icon on the add-on page
• Add custom properties to PlayerProfile
• Fixing Player/Characters title data page error
• Remove Reference to Null = Indefinite Subscription in Documentation
• Display Quarterly and yearly virtual currency reports
• Make best effort to prevent invalid dates in Transaction History(V2)
• Fix GrantItemAction
• Add And/Or support to filter for GetInventoryItems API
• Fix MaxRequestRate & add common errors codes
• Add StackId filter to GetInventoryItems
• 🩹 fixed Player Purchases Tab Sort Doesn't Work + Stops Rendering After 60 Items
• Fixing broken search for json editor, including brace types and exports
• Disable search UX for Economy, including search bar, dropdown and,search button, while there's a pending search. This will prevent changing types while searching.
• Allow empty stack id in Inventory(v2)
• 🩹 All Inventory API's Should Require Either Id or AlternateId
• Add Display Properties to Inventory(V2) in Game Manager. Display Properties can be added when granting items, they can be updated when updating an item, they can be directly updated through the index (items list), they can be,added for new stacks when splitting stacks. You can also inspect any display properties in every inventory popup/page.
• A very large number of additional performance improvements
• Lots of minor bug fixes

Analytics & Insights

• Added deprecation notice for older features.

Authentication

• No major changes.

Automation

• No major changes.

Economy

• Release of Economy v2 into General Availability!

Multiplayer

• No major changes.

Player Data

• No major changes.

Social & Leaderboards

• No major changes.

SDKs

• The Xbox Game Development Kit now includes an PlayFab Economy v2 Sample.
• The PlayFab Unreal Plugin is now tested with the GDK compatibility matrix.

v2.9.4 December 7, 2022 "Economy v2 Transactions & Inventory" Release Notes

Updates to Economy v2 Transactions and Inventory Systems

tldr Shipping some much-requested features for Economy v2 along with a number of improvements the community has asked for.

Pricing

• UGC Section has been updated to "Economy v2 - ITEMS, CURRENCY, BUNDLES, RECIPES, STORES, USER GENERATED CONTENT" to properly reflect the billing grouping for Economy v2 Public Preview.

Features

• Inventory Collections A new API allows Inventory Collections to be managed via a CRUD interface.

Bugfixes

• Lots of Game Manager UI improvements.

Roadmap

• The next significant release is planned for Q2 2023.
  See our Roadmap for additional details.

Documentation

• Minor fixes.

Known Issues

• None at this time.

Changelog

Game Manager

• Reworked collectionIds
• Updated api error codes
• Localization files updated
• ✅Fix attribute bug
• GM: fix title data export
• Billing Meters for actions
• Billing Meters (Data Connections) - Include destination type dimension
• UI for the PlayerProfile based ChurnPrediction predicate + Kusto query changes
• Fixed localization of trigger types
• Query for title info in parallel to reduce latency
• Improving performance of reporting UI page load
• Fix Add button on Inventory page(Auto) update imports, Refresh Add buttons
• Set Placeholders for Description and Keywords fields in Catalog
• Ensure Format of Title Data Uploaded and Downloaded from Game Manager Doesn't Change
• Spec generation updates, SDK updates
• Fixed title data popup
• Entity ID verification to GrantItemsToUser(s) to ensure it exists.verification to GrantItemsToUser(s) to ensure the PlayFab ID exists before grant items to the inventory., Updated error message text to use PlayFabId instead of User.
• Updated billing summary localization
• Support for on-demand title data loading
• Update MaxRequestRate
• Revoking economy v1 inventory items leaves the items in the main inventory until the queue processor moves them.
  • Some titles like and revoke many inventory items for the same players very frequently, causing a large number of revoked items to accumulate before the next inventory archival is triggered by an inventory load. This should cause the revoked items to be moved out of the main inventory sooner.
• Backfill Economy pricing plans; When enabling UGC add an economy plan
• Playstream Performance Improvements
• Updating Inventory API bc to support public preview opt-in
  • For titles configured to use backcompat, they can now opt-in to using the new API by setting "Item" instead of "Items" in the request
• Removed beta flag from Transaction History
• Add localized strings for Economy
• Increasing the Apple Receipt app_item_id to a long to accomodate values larger than 32 bit.
• Fix typo in PubSub documentation.
• Gave Inventory-etag a more consistent description
• Enable DisplayProperties in Monetization Inventory
• Churn Analysis - Add support to playerprofile + Alter event
• ARIA labels for secret fields
• 🐛 Fix Microsoft Addon Tooltip
• Add capabilities to verify ApplicationId and Publisher Secret against Steam
  • Based on whether the secret key is valid and the secret key has access to the application id using the ISteamApps/GetPartnerAppListForWebAPIKey API
  • Other add-ons will either no-op or throw NotImplementedException if it's not expected to be called through GameManager
• Add DisplayProperties to Transfer in Inventory
  • Upgrades Inventory models to version 0.2.0 to get the Properties, fields in TransferAsset
  • Adds DisplayProperties mapping and validation for TransferInventoryItems and ExecuteInventoryOperations
• Add DisplayProperties to Purchase in Inventory
  • Adds DisplayProperties mapping and validation for PurchaseInventoryItems and ExecuteInventoryOperations.
• Updating new Inventory API Error Codes to match legacy Error Codes
• Add DisplayProperties to Add and Update IventoryItems
  • Updates Inventory models version to support properties in UpdateInventoryItems, DisplayProperties is a Dictionary<string, object>.
  • It also updates ExecuteInventoryOperations to support DisplayProperties for Add and Update.
• Allow retries of player delete within x minutes, then ignore
• Add opt-in landing pages to features that require Insights
• All titles now page by 10
• Add GetPlayFabIDs limit attribute
• Validate google service account creds as part of v2 update config path
• Game Manager Powered Multiplayer > Matchmaking > Usage
  • Changes for game manager powered Cloudscript graphs, Changes to create new area called Metrics to route the calls from all other areas
• Player deletion rate limits
  • InactiveItemUnit batchesApply rate limit to batches rather than individual InactiveItemUnit items, to match the way it works for regular,ItemUnitComposite items.
• Removed line duplicating message on UI
• updated GM error handling to handle 400s
• Game Manager powered Title Limit Detail graphs upgraded to make them color-blind friendly
  • Multiplayer > Servers > (select one) > Go to Usage tab
• Game Manager Powered Multiplayer > Servers (select one) > Go to Usage tabChanges for game manager powered Cloudscript graphs, Changes to create new area called Metrics to route the calls from all other areas, adding copyrights, Changes to power Title Limits with GM code with filters, review- adding copyright and namespace scope for imports, testing MPS graphs, Changes to test Multiplayer > Servers > (select one) > Go to Usage tab and Multiplayer > Total Usage pages, testing Multiplayer > Servers tab > Total Usage and useVMMetricsTimeSeries, code cleanup, code cleanup, fix react test failures, testing MPS > build usage graphs, Testing mps build usage, making isMonthToDateQueryWork, moving code to metrics.ts, fixing bug
• GetPlayersInSegment - add optional GetProfilesAsync parameter, MaxBatchSize:0 for player count
• Bug Fix - An item can be created w/o its associated metadata
• updated save path to handle issue where new item page would get into a bad state
• 🎨 Updated currency page empty state text
• Fix "Admin/SetTitleDataAndOverrides"
• Changes for game manager powered Cloudscript graphs
• add throttling for cancel matchmaking tickets: add additional rate set for title/server when cancelling all tickets for player
• Reword GetItem error messagesReplace ItemId for Id in error messages
• Expiring old Forgot Password links after a user generates a new one
• Disable delete buttons at Economy Settings when Catalog is disabled
  • Fix update of Deep Link in settings
  • Fix update of Catalog in settings
  • Fix update of UGC Tags in settings
  • Fix update of Platforms in settings
• 🐛 fixed issue where inventory items dont show up GM🐛 fixed issue where inventory items dont show up if the item doesnt exist, thr calls so that it completes faster
• [Bug ] Add variables to keep track of state even when a refresh is made
• Rate limit inventory batch deletions
  • Rate limit the deletion of inventory item batches when deleting player inventories.
• Fix undocumented error for purchaseitem
• Add delete popup for deleting Items from the item page
• 🔥 ✅ removed status from GM
• made breadcrumbs consistent on economy pages
• Document InvalidGoogleToken API error code
• Add Lobby Limits to Game Manager
• 🐛 fixed a few issues with addPrice
• Fixing AddInventoryItemsSourceId order was swapped incorrectly
• Add undoc error for LoginWithGooglePlayGamesServices
• PurchaseItem returns error for RM currency
  • This is not an actual virtual currency configured for the title, but stands for "real money" when used in purchase flows that can use either real money or virtual currency as a payment. It does not make sense to specify "RM" in PurchaseItem calls, since there is no way for the API to deduct real money from the player.
• 🎨 🐛deeplinks spelling and syntax fixes
• Add undocumented error codes
• Fixed Microsoft Game Dev Discord Link
• Use a shorter timeout for GetPlayersInSegment API
  • Use a shorter timeout for GetPlayersInSegment API

Analytics & Insights

• Added deprecation notice for older features.

Authentication

• No major changes.

Automation

• No major changes.

Economy

• 🐛 Fix ExpirationDate calculation

• Calculation to reduce unnecessary writes into the system and properly propagate OneStore expiration date to inventory system

• Populate CatalogVersion for RefreshSubscriptions

• Added suppression of OneStore header property

• Reduced error rate on loading cold data

• Remove fallback on legacy config when inventory config is not found In order to allow titles to safely migrate from private preview (legacy config) to public preview (inventory config)

• Increasing the Apple Receipt app_item_id to a long to accommodate values larger than 32 bits

• Reduce unnecessary legacy config calls for OneStore

• Batch's requests and responses support ETag

• Fixing the PS5 consumable ExTxId

• Pulling PS5 fix for ownership integration

  • We identified a bug where the entire algorithm runs and then gets discarded at the very end because ownership sees a duplicate "ExternalTransactionId" and identifies it as already owned. This fix ensures a unique ExTxId is created for each transaction.

• Inventory etc.

Multiplayer

• No major changes.

Player Data

• No major changes.

Social & Leaderboards

• No major changes.

SDKs

• No major changes.

v2.9.3 September 7, 2022 "Economy v2.0 Public Preview" Release Notes

Economy v2 Public Preview is here!

tldr we rewrote much of our Economy backend with a focus on making sure your titles can scale with player demand, and also made a ton of general PlayFab bugfixes and improvements along the way.

Read the Announcement | Read the Docs | Get Started Today

Pricing

• Added Economy v2 Public Preview pricing model.

Note: Economy v2 Catalog is free for the month of September!

Features

• Idempotent Transactions Transactions can now be retried without fear of posting duplicates.
• Batch Operations Bulk updates for items!
• Concurrency & Hyperscaling A brand-new backend for catalogs and inventories. 200 million active players? No sweat.
• Catalog v2 Stores Simplified and streamlined API surface.
• Catalog v2 List APIs Introduced optimized calling pattern.
• Catalog v2 API Policies Simplified policy experience.
• Catalog v2 Unlimited Size Support Seriously, go nuts, this is awesome.
• Catalog v2 Virtual Currencies Updated support for unlimited currencies. No longer are you limited to just 10!
• Catalog v2 Item Bundles Enhanced bundles with additional metadata and scalability.
• Catalog v2 Item Localization Items have added localization fields and support.
• Catalog v2 Item Draft/Publish Support Items now start as Drafts by default and can be published and scheduled.
• Catalog v2 Item Metadata Additional metadata support including Ratings and Reviews as well as PlayFab Deep Links.
• Updated Search Capabilities High performing search with better OData support.
• Massive-scale Inventories v2 allows 3,000+ items per player without performance headaches!
• Player Inventory Stacks Stack items together for improved API usage and performance for player inventories.
• Player Inventory Collections Collections are the building blocks for enhanced and multiple player inventories.
• Paging Improvements Improved paging performance and updated API limits.
• Marketplace Add-on Improvements Simplified v2 addons give us a baseline for better store support and debugging tools in future releases.
• Improved accessibility and ARIA labels to Game Manager components.

Bugfixes

• A large number of Game Manager bug fixes have landed. See the Changelog below for more details.

Roadmap

• The next Economy v2 release is planned for Q3 2022.
• Economy v2 General Availability set for Q2 2023. This gives us time to respond to all your wonderful suggestions and feedback!
  See our Roadmap for additional details.

Documentation

• Economy documentation has been entirely revisited and reorganized to better reflect today's Game Manager and API organization.
• Economy v2 Catalog Public Preview docs have been introduced.
• Minor issues with a number of billing examples have been corrected.
• Etag documentation added for UGC.
• Added PubSub API documentation generation
• Update Lobby docs and enable GameServerIdentity docs

Known Issues

• UGC lists take some time to load. This is due to a config check before resolving the list query and is being worked on.
• Player inventories currently require a separate call for deletion to maintain GDPR compliance. Ideally, we'd like this to take only one API call.

Changelog

Game Manager

• Add limit to all getPlayFabIDs apis
• 🐛 fixed bug where no items could be made
• Rename ActionType enum
• Added a min value to Amount
• Update currencies to use compex prices
• Added undocumented ErrorCodes to APIs
• Add resized leaderboard DB instance
• Added (UTC) to last modified, creation time, start time and end time
• Add functionality to open OData filter when field is focused (tab)
• Deprecated MACAddress in BanRequest and UpdateBanRequest
• Added success message on saving
• Fixed the count issue in prod
• Don't allow game_server callers for FindFriendLobbies API
• Add MatchmakingAttributeInvalid error code to Match/SubscribeToMatchmakingResource and Match/UnsubscribeFromMatchmakingResource api doc
• [Segmentation] Add per-segment property to disable playstream event generation
• Raise maximum title limit to 12,000.
• GetPlayersInSegment MV: improve performance of statistics segments
• Improved tab experience in JSON editor
• Add ARIA labels & ARIA expanded
• Fixed issue with only one JSON Editor being able to escape
• Fixed admin user edit link
• Segmentation API - Add Limit on number of EntitySegments
• Adding PS5 support to Redeem
• Fixed issue where bundles wont load in GM
• Increase request size to 100mb
• Add Title Rate Limiting for Lobby service
• Fix My Profile page on Game Manager Linux
• Fixed date error when viewing Korean billing summary
• Properly filter titles in billing summary data.
• Game Manager - Fix leaderboards delete
• Fix "Show data table" button not showing
• Fix bug to match mouse over displayed time on bar chart below in Trend charts.
• Player-Search: KQL Syntax Error Detection + Error popup to users
• Segments: Player Churn, Statistic column filter bug fix
• Swapped search bar to use radio button in GM
• GM changes for UGC-GA
• Bugfix: Insights should include Content Type in response
• 🐛 ✨ Redirect user to edit page after new item is made
• Fixed Tags not saving and GM and Settings page having correct update colors
• Added Sales Access by Country Code
• Updated Generated Examples
• Added Player Event History page
• 🩹[m10n] Fix Large File Uploads for UGC
• Added max length 500 chars to item search string Economy
• Added char size limit to search param in SearchItems for Catalog
• Added "Required" attribute to ValidateTitlesRequest.
• Fixed legacy content cloudfront hash issue
• Added mime-type validation for Economy images
• Added 255 char limit to platforms textarea in Economy
• Added app insights as a connected service
• Added UI for MPS Crash Dump Configurations
• Adding the tracestate and Request-Id Headers to the allowed CORES headers to support Applications Insights tracing trough PlayFab.
• Segment List call to return Name as well
• Added default OData filter when empty, to match description
• Adding the traceparent header to the allow CORES headers so websites can call playfab APIs with this additional header.
• Fixed economy UGC empty list enable button
• Performance improvements for total player search
• Show friendlyId for catalog items and UGCs indexes
• Enabled error metrics filter.
• Added Studio Creation rate limit
• Added Player-churn Segment scenario to Segmentation metrics

Analytics & Insights

• No major Analytics & Insights updates at this time.

Authentication

• No major Auth updates at this time.

Automation

• No major Automation updates at this time.

Economy

• Validate process for updating Zuora customer bills
• [Catalog] Change Price Properties: Empty Price Lists for Items are no longer considered free.
• Apple receipt validation granting unwanted items, subscriptions
• [UI/UX] Change Tab Naming for UGC GA in Game Manager
• Add AlternateId support to all Catalog APIs
• [GM] Recipe throws error when creating recipe
• [GM] Updated price on items to support multiple currencies
• Fix Craft Page Flickering

Multiplayer

• No major Multiplayer updates at this time.

Player Data

• No major Player Data updates at this time.

Social & Leaderboards

• No major Social and Leaderboard updates at this time.

SDKs

• SDK release XYZ supports the Economy v2 Public Preview.
• 🐛 Fixes Asset SDK memory leak

This release includes a large amount of additional unlisted bugfixes and improvements.

February 8, 2022 Release Notes

New

Documentation

• Updated documentation

November 17, 2021 Release Notes

New

Multiplayer

• Updates cost estimation on multiplayer servers new build page to reflect behavior of standby servers and servers per machine. Fixes various issues related to VM overrides.
• Thundernetes 0.1.0 released! See thundernetes github page for more information
• Ability to attach a profiler to a build to learn more read Attaching a profiler

October 21, 2021 Release Notes

New

User Generated Content (UGC)

• New APIs for Azure PlayFab UGC have been added to support the Public Preview release of that service. Read more on our blog.

August 24, 2021 Release Notes

New

Multiplayer

• Created documentation around different functionality added to build overview. To learn more, see Builds overview.

• Unreal plugin in preview! One of our amazing community members Stefan Krismann (stkrwork) contributed. You can find more information about it at Unreal Plugin Github page.

• Created an Unreal sample & tutorial on utilizing GSDK. To learn more, see Unreal third person MP.

July 21, 2021 Release Notes

New

Multiplayer

• We've added the ability to manage assets from your build summary page. You can now:

  • Quickly see if an asset is associated to a build
  • See asset details such as name and build count
  • Upload, download, and delete assets

• We've added the ability to see and manage aliases for your builds from your build summary page.

• We've released a Virtual Machine Metrics preview that is aimed at helping developers make informed decisions about their VM resources. The metrics in this first preview include:

  • CPU usage
  • Available memory
  • Allocation percentage
  • Network bytes
  • Disk operations

For more, please refer to the documentation

June 9, 2021 Release Notes

New

General
Added support for the Retry-After header for 429 HTTP requests and added the value also in the PlayFab JSON Error payload. This value will represent the number of seconds recommended to wait before retrying the call.

April 28, 2021 Release Notes

New

Multiplayer

• We've enriched our PlayFab Multiplayer Servers (MPS) quickstart documentation to include more references, samples, and improved content to help get you started quickly with multiplayer servers. Please refer to the articles listed under "Get Started" in the navigation menu for the Multiplayer Servers documentation. Notable additions:

  • Wrapping GSDK support for Linux (see documentation and GitHub repo)
  • Test runner utility for easy calls to MPS APIs (see documentation and GitHub repo)

• We've revamped the experience for PlayFab Multiplayer Servers (MPS) in the Game Manager portal to clarify free usage scenarios when using MPS in evaluation mode. Applicable MPS pages in the portal have been updated with additional details about the free usage tier, build summary reports for free services, standby server usage, and other useful information. Please refer to Billing for PlayFab Multiplayer Servers 2.0 - PlayFab | Microsoft Docs for more on the free evaluation tier.

• The following features have been added to the Game Manager "New Build" page for PlayFab Multiplayer Servers:

  • Added VM rate information
  • Estimation of hourly costs for configured standby/max servers of a build
  • UI for enabling process based servers
  • UI for adding or deleting existing game server assets
  • UI for enabling read-only assets
  • UI for enabling streaming asset downloads

• A PlayFab Multiplayer Services usage and costs calculator is now available to help you estimate your monthly charges. The calculator can be found here and is accessible from the main PlayFab pricing page.