Catalog v2 quickstart

Economy v2 is now Generally Available. For support and feedback, go to the PlayFab Forum.

After becoming familiar with Game Manager, you can:

Set up a v2 Catalog’s permissions, settings, and items.
Set up Receipt Validation
Walk through purchasing an item

See the Unity-specific Tutorial for a detailed walkthrough in Unity.

Part 1: Catalog overview

Step 1 – Get permissions

The first step is to enable the catalog in the settings page in the Game Manager UI under ⚙️ Title Settings > Economy (V2). You can use the UpdateCatalogConfig API and set the IsCatalogEnabled flag to true. To interact with the Catalog, you either need to Log into GameManger and use the site tools, or get an Entity Token for using the APIs. The easiest way to get an entity token is with the GetEntityToken API.

To call the API as an admin or authoritative service, which you will need to do before you create your first Catalog item, you’ll need to include an X-SecretKey header with a title secret key. You can create title secret keys in the Game Manager UI under ⚙️ Title Settings > Secret Keys.

API

curl \
  -H "X-SecretKey: {{SecretKey}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{titleId}}.playfabapi.com/Authentication/GetEntityToken \
  -d "{\"CustomTags\": {\"user\": \"{{email}}\"}}"

C# SDK

// ENABLE_PLAYFABSERVER_API symbol denotes this is an admin-level game server and not a game client.
private static async Task PlayFabEconomyv2QuickStart()
{
#if ENABLE_PLAYFABSERVER_API
    string systemGUID = Environment.GetEnvironmentVariable("SYSTEM_GUID", EnvironmentVariableTarget.Process);
    PlayFabSettings.staticSettings.DeveloperSecretKey =
        Environment.GetEnvironmentVariable("PLAYFAB_SECRET_KEY", EnvironmentVariableTarget.Process);

#endif
    PlayFabSettings.staticSettings.TitleId =
        Environment.GetEnvironmentVariable("PLAYFAB_TITLE_ID", EnvironmentVariableTarget.Process);
    PlayFab.EconomyModels.EntityKey gameEntityKey = new()
    {
        Type = "title",
        Id = PlayFabSettings.staticSettings.TitleId
    };

    PlayFabResult<GetEntityTokenResponse> gameTokenRequest = null;
    try
    {
        gameTokenRequest = await PlayFabAuthenticationAPI.GetEntityTokenAsync(new GetEntityTokenRequest()
        {
            CustomTags = new Dictionary<string, string>
            {
#if ENABLE_PLAYFABSERVER_API
                { "server", systemGUID }
#endif
            }
        });
        if (gameTokenRequest.Error != null)
        {
            throw new Exception(gameTokenRequest.Error.GenerateErrorReport());
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(string.Format("PlayFab Auth Error: {0}", e));
        return;
    }

    PlayFabAuthenticationContext gameAuthContext = new()
    {
        EntityToken = gameTokenRequest.Result.EntityToken,
    };
}

It’s best practice when calling as an Admin for a Title, a.k.a. without a SessionTicket from a user login, to include a CustomTags entry logging who is making the call - whether it’s you, a server, or an automated script. This makes it easier to trace changes and identify issues when querying your PlayFab logs.

Step 2 - Configure your Catalog Settings

Catalog Settings include many different configurations, from Content Types to User-Generated Content. You can update and retrieve them all through the API, and easily visualize many of them in Game Manager.

Game Manager

In Game Manager, navigate to ⚙️ Title Settings > Economy.
Under the Catalog (V2) tab, go to Catalog Settings
Create a default Content Type (creating a “Game Item” type is a good place to start).

API

Call the Catalog/GetCatalogConfig method, and then UpdateCatalogConfig the Catalog ContentTypes array with a Catalog Type.

curl \
  -H "X-SecretKey: {{SecretKey}}" \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/GetCatalogConfig \
  -d "{\"CustomTags\": {\"user\": \"{{Email}}\"}}"

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/UpdateCatalogConfig \
  -d "{\"Config\": {{{CatalogConfig}}}, \"CustomTags\": {\"user\": \"{{Email}}\"}}"

Example return payload for a title with some content types for Catalog and UGC:

{
    "code": 200,
    "status": "OK",
    "data": {
        "Config": {
            "IsCatalogEnabled": true,
            "AdminEntities": [...],
            "Catalog": {
                "ContentTypes": [
                    "gameitem",
                    "enemy",
                    "weapon",
                    "armor",
                    "levelupstats"
                ],
                "Tags": [...]
            },
            "DeepLinkFormats": [],
            "DisplayPropertyIndexInfos": [
                {
                    "Name": "TestSearchable",
                    "Type": "SearchString"
                }
            ],
            "ReviewerEntities": [],
            "UserGeneratedContent": {
                "ContentTypes": [
                    "weapon",
                    "armor"
                ],
                "Tags": [...]
            },
            ...
        }
    }
}

Step 3 - Publish an Item to the Catalog

GameManager

Navigate to Economy > Catalog (V2). Under the Items tab, select New Item. Fill in the required metadata – there are only four required properties (Creator Type, Title, Start date, and Content type). Select Publish.

Creator Type defaults to “title” - although there may be instances where Players are creating items for your game. In that case, you would select “title_player_account”. Fields with the Edit JSON option are keyed by metadata such as the localization language which defaults to “neutral”. All dates are UTC.

{
  "NEUTRAL": "My Game Item",
  "en-US": "My Game Item"
}

API

Create a “Draft” Catalog Item by calling the CreateDraftItem endpoint:

The EntityToken (from GetEntityToken or other PlayFab login call) in the X-EntityToken header
The PlayFab Title ID in the item’s CreatorEntity.Id

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/CreateDraftItem \
  -d "{{Data}}"

Data:

{
  "Item": {
    "CreatorEntity": {
      "Id": "{{TitleID}}",
      "Type": "title"
    },
    "Type": "catalogItem",
    "ContentType": "gameitem",
    "Title": {
      "NEUTRAL": "My Amazing Fire Sword",
      "en-US": "My Lit Lit Sword"
    },
    "StartDate": "2023-07-27T00:00:00.000Z",
    "Tags": [
      "weapon"
    ]
  },
  "Publish": true,
  "CustomTags": {
    "user": "{{Email}}"
  }
}

C# SDK

private static async Task PlayFabEconomyv2QuickStart()
{
    // Continued from above example...
    CreateDraftItemRequest gameFireItem = new()
    {
        AuthenticationContext = gameAuthContext,
        Item = new CatalogItem()
        {
            CreatorEntity = gameEntityKey,
            Type = "catalogItem",
            ContentType = "gameitem",
            Title = new Dictionary<string, string>
            {
                { "NEUTRAL", "My Amazing Fire Sword" },
                { "en-US", "My Lit Lit Sword" }
            },
            StartDate = DateTime.Now,
            Tags = new List<string>
            {
              "weapon"
            }
        },
        Publish = true,
        CustomTags = new Dictionary<string, string>
        {
            { "server", systemGUID }
        }
    };
    PlayFabResult<CreateDraftItemResponse> gameDraftItemResponse = null;
    try
    {
        gameDraftItemResponse = await PlayFabEconomyAPI.CreateDraftItemAsync(gameFireItem);
        if (gameDraftItemResponse.Error != null)
        {
            throw new Exception(gameDraftItemResponse.Error.GenerateErrorReport());
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(string.Format("PlayFab CreateDraftItem Error: {0}", e));
        return;
    }
    Console.WriteLine(string.Format("PlayFab CreateDraftItem Success: {0}",
        JsonConvert.SerializeObject(gameDraftItemResponse.Result, Formatting.Indented)));
}

Putting the item into a Draft state is not required – Draft is meant for when you expect to iterate on the metadata for some period of time. We support the parameter “publish”, that when set to “true” will publish the item immediately. This could save you some call volume depending on your pattern.

Once an Item is in Draft, you can then push it to a ‘Published’ state using the PublishDraftItem endpoint (this step is handled invisibly in GameManager). Once an item is Published, it’s searchable and available publicly. You need to use the ItemId returned from the CreateDraftItem response in order to publish.

Step 4 - Do a search

Once the Publish call succeeds, the Item can be searched for using the previously published ItemId and SearchItems endpoint. The Catalog/Search API executes a search against the published catalog using a set of parameters provided to the API, returning a set of paginated results.

Game Manager

Game Manager search is self-explanatory and exists on each Catalog v2 page. Published and Draft filters are at the top. Select the Filters (Funnel) icon next to the Search button to see the list of filters. Select Enter ODATA filter to add an OData filter.

API

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/SearchItems \
  -d "{{Data}}"

{
  "Search": "Fire",
  "Filter": "tags/any(t:t eq 'desert') and contentType eq 'gameitem'",
  "OrderBy": "lastModifiedDate asc",
  "ContinuationToken": "abc=",
  "Count": 2
}

Save the ID returned for later in this Quickstart.

Catalog/search filter, orderBy, and select fields use OData as the query standard.

Part 2: Inventory and Virtual Currencies overview

Inventory Items and Virtual Currencies are the two in-game ‘buckets’ of virtual goods that PlayFab supports for Player Entities. The process is:

Set up an initial Virtual Currency
Create an Item with a Virtual Currency Cost
Add the item to a player’s Inventory

Step 1: Creating a 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. Currencies provide flexibility for your game to implement whatever medium of exchange you desire (for example, gold, gems, hearts, or interstellar credits).

Game Manager

Open Game Manager and go to Economy > Catalog (V2).
Select the Currency tab.
Choose New Currency, setting the Start date, a human-readable Title for the “neutral” key, and in the Friendly ID field, enter a unique currency code for this currency.
Select Save as draft. The Item ID is used as a draft currency code.
View your new currency by clicking selecting the Draft filter in the currency list.
Edit the currency again and select Save and publish. The Friendly ID is used as a published currency code.

API

Create a Draft Currency Catalog Item by calling the CreateDraftItem endpoint with type set to “currency” using:

An EntityToken with Catalog Permissions
The Entity.Id as the item ‘Creator’
The PlayFab Title ID
The Item should be a Bundle of type ‘Currency’ and contain a Title and Description

Call PublishItem with the ItemId returned from the CreateDraftItem.

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/CreateDraftItem \
  -d "{{Data}}"

Data:

{ 
  "Item": {
    "CreatorEntity": {
      "Id": "{{TitleID}}",
      "Type": "title"
    },
    "Type": "currency",
    "ContentType": "gameitem",
    "AlternateIds": [
      { 
        "Type": "FriendlyId",
        "Value": "TC"
      } 
    ],
    "Title": {
      "NEUTRAL": "My Amazing Test Currency",
      "en-US": "My Test Coin"
    },
    "StartDate": "2023-07-27T00:00:00.000Z"
  },
  "Publish": true,
  "CustomTags": {
    "user": "{{Email}}"
  }
}

A Catalog/Search for type ‘currency’ will return all of the currencies you have defined.

Step 2 - Granting Currencies

Game Manager

Your entity player needs virtual currency in order to make a Purchase.

Open GameManager, navigate to Players, and select Search to retrieve the list of players.
Select the Player ID you wish to grant currency to.
Select the Inventory (V2) tab.
Filter to “Currency” Type and select Pick multiple items to view the full list of currencies.
Choose the Currency you created and enter a new amount for the Entity Player.
Select Save.

The pages exposing player Currency Grants are not in GameManager today.

API

You can call AddInventoryItems to add currency to an Entity Wallet. By default, you need to use Title Level Entity Auth to arbitrarily add virtual currencies to a player’s inventory.

AddInventoryItems is considered a Title admin call, and is normally not something called directly by the game client.

Step 3 - Update a Catalog Item

An item must have a currency value in order for it to be purchasable with virtual currency.

GameManager

Open Game Manager and navigate to Economy.
Select the Catalog (V2) tab and ensure you’re filtered to Published items.
Select the title of the item you created earlier.
Select Edit draft item.
Select ➕ Add new price and set an Amount by selecting the Currency item you created. Select Add to finish.
Select Save and Publish.

API

Get the draft of your Catalog Item by calling the GetDraftItem endpoint. Then update the draft with the UpdateDraftItem endpoint using:

The EntityToken (from GetEntityToken or other PlayFab login call) in the X-EntityToken header
The Entity.Id from the previous call in the item’s EntityKey.Id

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/GetDraftItem \
  -d "{{Data}}"

Data:

{
  "Id": "{{EntityID}}",
  "CustomTags": {
    "user": "{{Email}}"
  }
}

curl \
  -H "X-EntityToken: {{EntityToken}}" \
  -H "Content-Type: application/json" \
  -X POST https://{{TitleId}}.playfabapi.com/Catalog/UpdateDraftItem \
  -d "{{Data}}"

{
  "Item": {
    "Id": "{{EntityID}}",
    "CreatorEntity": {
      "Id": "{{TitleID}}",
      "Type": "title"
    },
    "Type": "catalogItem",
    "ContentType": "gameitem",
    "Title": {
      "NEUTRAL": "My Amazing Fire Sword",
      "en-US": "My Lit Lit Sword"
    },
    "StartDate": "2023-07-27T00:00:00.000Z",
    "Tags": [
      "weapon"
    ]
    "PriceOptions": {
      "Prices": [
        {
          "Amounts": [
            {
              "ItemId": "{{CurrencyID}}",
              "Amount": 15
            }
          ]
        }
      ]
    }
  },
  "Publish": true,
  "CustomTags": {
    "user": "{{Email}}"
  }
}

If you don’t set Publish to true, then you must push it to the published state using PublishDraftItem. Once an Item is published, it’s searchable and available publicly. You need to use the “itemId” returned from the GetDraftItem response in order to publish.

XBOX Services

PlayFab

Quickstart

Catalog v2 quickstart

Part 1: Catalog overview

Step 1 – Get permissions

API

C# SDK

Step 2 - Configure your Catalog Settings

Game Manager

API

Step 3 - Publish an Item to the Catalog

GameManager

API

C# SDK

Step 4 - Do a search

Game Manager

API

Part 2: Inventory and Virtual Currencies overview

Step 1: Creating a Currency

Game Manager

API

Step 2 - Granting Currencies

Game Manager

API

Step 3 - Update a Catalog Item

GameManager

API

See also

​Catalog v2 quickstart

​Part 1: Catalog overview

​Step 1 – Get permissions

​API

​C# SDK

​Step 2 - Configure your Catalog Settings

​Game Manager

​API

​Step 3 - Publish an Item to the Catalog

​GameManager

​API

​C# SDK

​Step 4 - Do a search

​Game Manager

​API

​Part 2: Inventory and Virtual Currencies overview

​Step 1: Creating a Currency

​Game Manager

​API

​Step 2 - Granting Currencies

​Game Manager

​API

​Step 3 - Update a Catalog Item

​GameManager

​API

​See also

Catalog v2 quickstart

Part 1: Catalog overview

Step 1 – Get permissions

API

C# SDK

Step 2 - Configure your Catalog Settings

Game Manager

API

Step 3 - Publish an Item to the Catalog

GameManager

API

C# SDK

Step 4 - Do a search

Game Manager

API

Part 2: Inventory and Virtual Currencies overview

Step 1: Creating a Currency

Game Manager

API

Step 2 - Granting Currencies

Game Manager

API

Step 3 - Update a Catalog Item

GameManager

API

See also