Important
Economy v2 is now Generally Available. For support and feedback, go to the PlayFab Forum.
Deep links allow you to directly link to each supported platform's store when making a purchase.
- Allow players to "click an advertisement" directly to an in-game item
- Make it easy to install UGC items from a browser
- Link to lore or app pages based on item ID
You can configure deep link formats by platform on the Economy > Catalog (v2) > Economy Settings page in game manager.
- A deep link platform must be a platform already defined in your catalog settings.
- A deep link format must include the template string
{id}. This string will be replaced by the item GUID when calling the PlayFab API.
Example
Tip
Verify and test your deep link format before deploying - some Platforms have different formats for testing and production environments. For example, the Google Play Store needs your package name for production environments (com.example.android).
| Platform | Format |
|---|---|
mygame-internal |
mygame://journal/?ID={id} |
mygame-website |
https://mygame.com/world/{id} |
microsoft |
ms-windows-store://pdp/?ProductId={id} |
microsoft-review |
ms-windows-store://review/?ProductId={id} |
microsoft-xbox-pc |
msxbox://game/?productId={id} |
android-googleplay |
market://details?id={{PackageNameHere}}.{id} |
apple-appstore |
itms-apps://itunes.apple.com/app/{id} |
Note
Nintendo and Sony do not provide their store schemas publicly as of this writing. You will need a developer account to access their platform link schema documentation.