Documentation

Tutorials & Guides

Below find a number of our Tutorials and Guides to help you on your way with PlayFab.

Guides

In-depth documentation, covering core PlayFab features

  • General Beginners Guide to PlayFab 
    This document describes the overall structure of PlayFab and how PlayFab works.
  • Game Manager Tour 
    This document describes how to use Game Manager, in addition we are proud to announce that game manager has been completely rebuilt, redesigned and refined for managing your games.
  • Parse Migration Guide 
    Both PlayFab and Parse provide back-end tools and services for building and operating your game, but there are several differences. Understanding these differences is important for planning a migration from Parse to PlayFab.

Tutorials

In-depth training, with examples

  • Using Title Data 
    This document describes how to create and use title (game) data. Title data is represented as key/value pairs (KVPs) that can only be associated with a specific title.
  • Using Player Data 
    This document describes how to create and use player data. Player data is information that applies to an individual player or a group of players (shared data) and is stored as key/value pairs (KVPs) by PlayFab.
  • Using Publisher Data 
    This document describes how to create and use publisher (studio) data, which is data spans more than one title, such as when you have multiple games that need to share common information among your games. This category also include data for players that spans multiple games. PlayFab stores data as key/value pairs (KVPs).
  • Testing APIs with Postman 
    Knowing how to manually call the Web API methods is invaluable when you are trying to integrate PlayFab with your game. If a function isn’t working out quite how you expect, being able to call it in a tool that shows you the specific response data and any error messages is a powerful way to debug those calls. There are a number of tools out there that make it easy to interact directly with a Web API, but one that we really like is the Postman Chrome plugin.
  • Using Cloud Script 
    This document describes how to use Cloud Script, which is custom game logic that is written in JavaScript and hosted in the PlayFab service, including how to call Cloud Script functions using a Unity SDK method. Cloud Script has full access to PlayFab's Server methods, and is available as part of the Premium tier of service.
  • Calling Webhooks from Cloud Script 
    This guide describes how to make HTTP requests from within Cloud Script.
  • Custom Game Servers 
    While the PlayFab service has always offered the ability to have custom game servers which are operated and managed by our team on behalf of game titles, the process of uploading and configuring server builds has been largely manual up to now. This update provides developers with the ability to manage builds directly, in order to make the process of testing game servers simple and convenient.
  • Push Basics
    Push notifications give developers a channel to send an immediate, customized, message to their player’s home screens. Using PlayFab's push feature, developers may send unlimited push notifications to any number of devices completely free of charge. As a general guideline, always tell players up front how you will be using the push notification service. Explaining how your game rewards or communicates via push notification can be the difference in building community engagement versus driving players away.
  • Push for Android 
    Push notifications for use on the Android platform
  • Push for iOS
    Push notifications for use on the iOS platform
  • Using Resettable Statistics and Leaderboards
    This tutorial provides a complete walkthrough of how to configure and manage statistics with versioning, which enables “resetting” of statistics, and by extension, leaderboards. In it, we’ll focus on how to use the Admin API methods for this, with additional info on using the Client and Server API methods to query the data, both for the current version as well as old ones. The goal is to provide developers with a technical review of how resettable statistics work in PlayFab, and all the ways they can be used in your games.
  • Using Externally Hosted Game Servers with PlayFab
    In addition to providing auto-scaling server hosting, PlayFab also provides a way to use and manage externally hosted servers. This tutorial covers everything you need to know to use external servers with PlayFab, and provides advice on best practices in this space.
  • Non-Receipt Payment Processing
    PlayFab offers several platform partners for fulfilling real money transactions. This guide covers all purchasing that is not based on receipt validation. Using examples, it deep-dives into how to make purchases from your game client on platforms such as Steam and Xsolla.
  • Creating a Scheduled Task
    This tutorial walks you through how to create a task that runs on a schedule. There are many game operation routines that can be automated using a scheduled task, such as modifying prices in a store according to the time of the day, resetting a leaderboard on a set interval, injecting virtual currencies into the game economy daily, etc. In this example, we show you how to modify a game variable "rareDropRate" in the Title Data at 12:00 UTC, and only on weekend days.
  • Bulk Actions for an Entire Player Segment
    This tutorial walks you through the steps needed to create a task to perform one or more actions on every player in a segment. A vital part of Live Operations for any game, this gives you a powerful set of tools for engaging with your players.
  • Getting a Player's VTD (value-to-date)
    Knowing how much players are worth can be very valuable information to help determine what actions you as a developer take in monetizing your players.
  • Integrating with Universal Windows Platform
    Instructions on how to integrate with the Universal Windows Platform, including authentication using Windows Hello, and validating receipts from in-app purchases made via the Windows Store.
  • Friends Lists
    You can allow your users to interact with one another through Friend lists through Playfab, or even Facebook and Steam
  • User Roles
    Developer roles let you give your developers access to title information according to their role. By granting permissions by role, all users with a role are updated together
  • Custom Events
    Custom events allow PlayStream to interact with or trigger from any event in your game