Quickstart (Legacy Economy)
Economy v1 APIs are in maintenance mode and will not be receiving any new features, only bug fixes. The v1 APIs will be maintained for the foreseeable future. See the Economy v2 Overview to learn more about the next version of PlayFab Economy!
Making monetization work is one of the biggest challenges in games. PlayFab simplifies this experience by building on top of three foundational pieces: Currencies, Items, and Inventory.
In this quickstart, you will:
- Set up a virtual currency.
- Create an item.
- Add an item to a player's inventory.
- Learn the next steps for customizing your economy.
Setting up a virtual currency
Virtual currencies are the foundation of in-game economies. Players and characters can be granted these currencies, which can then be used to buy or trade items.
Items can have a cost in either a virtual currency or real money. Each title can support multiple arbitrary virtual currencies, providing flexibility for your game to implement any medium of exchange (for example, gold, gems, hearts, or interstellar credits).
To create a virtual currency:
- Open Game Manager and select Economy on the left side bar.
- Select the Currency tab.
- Choose New Currency and change these fields (as shown in the image below):
- Set Currency code (2 uppercase characters) to GD.
- Set Display name to Gold.
- Select SAVE CURRENCY.
Now that a currency has been set up, catalog items can be assigned prices corresponding to the virtual currency.
Creating an item
Many games offer the player items for purchase such as a shield, a level-unlock, or a power-up. These items are specified in a catalog. Before the player can purchase an item from a catalog, you must create the items to populate it.
To create a catalog with an item:
Select Economy on the left side bar and select the Catalogs tab.
Choose the NEW CATALOG button and enter main as the Catalog version. An item with the ID of One is added automatically.
Select One and change these fields (as shown in the image below):
- Set Item ID to apple.
- Set Display name to apple.
- Set Description to Perfectly normal apple.
The PRICES section is at the bottom of the form.
Set the apple's price in gold (GD) to 5.
Select the SAVE ITEM button.
Adding an item to a player inventory
- Real money
- Virtual currency
- Triggered item grants based on buying another item
- Locked (with a loot-able/purchasable key) and unlocked boxes
- Random result tables
- Non-purchasable items that are granted based on paid or free events within a game
- And more scenarios, especially with Azure Functions
Add an item to a player's inventory by purchasing it with virtual currency.
In your game, sign in as a player that has been given virtual currency. (Giving virtual currency to a player has more information, if needed.)
Call GetCatalogItems with the following parameter in the request:
CatalogVersion = "main"
Verify that the
Catalogin the result contains an apple with a GD price of 5.
Call PurchaseItem to buy the apple, with these parameter values in the request:
CatalogVersion = "main"
ItemId = "apple"
VirtualCurrency = "GD"
Price = 5
Finally, call GetUserInventory and look in the result of that method. In the array of items in the player's
Inventory- you should see an apple!
Next Steps for customizing your economy
Once you have a Catalog with Items supported by Virtual Currencies, you can light up your economy with:
- Real World Purchases: Our Getting started with PlayFab, Unity IAP, and Android and our Non-receipt payment processing tutorials help you connect your virtual economy with existing stores.
- Leveraging your Catalog: To create Bundles, Containers and Drop Tables. For more information, see our Catalogs tutorial.
- Using Item attributes: To define multiple prices and specify stackable, tradable, and limited edition Items.
- Setting up unique in-game vendors or Sales events: Using Stores and Sales.
- Creating some player Segments and use Stores: To drive different item and bundle offers to your players regardless of where they are in your game lifecycle. For an example, see our Custom stores for player segments tutorial.
- Gathering economic data: Enabling you to improve and iterate your game using PlayFab Reports.