​

Quickstart: PlayFab Client library for C# in Unity

Get started with the PlayFab Client library for C# in Unity. Follow steps to install the package and try out example code for a basic task. This quickstart helps you make your first PlayFab API call in the Unity engine.

​

Requirements

• A PlayFab developer account.
• An installed copy of the Unity Editor. To install Unity for personal use via Unity Hub, or Unity+ for professional use, see Download Unity.

• A Unity Project of any of the following types:
  • A brand new project. For more information, see Starting Unity for the first time.
  • A guided tutorial project. For more information, see Getting Started with Unity.
  • An existing project.
• The PlayFab Unity SDK.

​

Download and install PlayFab SDK

Either use the PlayFab Editor Extensions package to install the SDK or install the SDK directly. The PlayFab Editor Extensions are a stand-alone Unity plug-in that streamlines installing the SDK and configuring some PlayFab settings for your Title. For information about installing the SDK without using the PlayFab Editor Extensions, see Installing the PlayFab SDK Without Editor Extensions for Unity.

1. Download the PlayFab Unity Editor Extensions Asset Package.
2. Open your Unity Project.
3. Navigate to where you downloaded the file and double-click on the PlayFabEditorExtensions.UnityPackage file to open the Import Unity Package dialog in the Unity Editor.
4. To import the PlayFab Unity Editor Extensions into your project, select Import.
5. When the import completes, the PlayFab Unity Editor Extensions panel should open automatically displaying the SDK installation dialog.

6. Select Install PlayFab SDK to automatically import the SDK into your project or upgrade the version that is currently installed.

​

Set your title settings

Before you can make an API call, you must create a PlayFabSharedSettings.asset and specify the Title ID to receive the call. To set the Title ID:

1. Select PlayFab > MakePlayFabSharedSettings which should create the settings asset and open it in the Inspector panel.
2. Set your Title ID in the inspector.
3. Now at any time, you may also see and change the current Title ID from the Settings tab in the Editor Extensions panel.

The Developer Secret Key is not set by default. If you are making a server build, be sure to provide the secret key in the PlayFabSharedSettings.asset. The Developer Secret Key is automatically set to the default secret key for the Title. For more information about secret keys, see Secret key management. Otherwise, be sure the secret key is not set when building your game client. For more information about secret keys, see Secret key management.

​

Making your first API call

This part of the guide provides the minimum steps to make your first PlayFab API call. This example doesn’t provide any GUI or on-screen feedback. Confirmation is displayed in the Console log.

1. If your Unity Project doesn’t already have a Scripts folder (HDRP and LWRP/URP templates have one by default), right-click on the Assets folder in the Project panel and select Create > Folder.
2. In the Assets window, name the folder Scripts.
3. Right-click the Scripts folder and select Create > C# Script.
4. Name the script PlayFabLogin.
5. Double-click the file to open it in a code-editor.
6. In your code editor, replace the contents of PlayFabLogin.cs with the provided code and save the file.
   using PlayFab;
   using PlayFab.ClientModels;
   using UnityEngine;
   
   public class PlayFabLogin : MonoBehaviour
   {
       public void Start()
       {
           if (string.IsNullOrEmpty(PlayFabSettings.staticSettings.TitleId)){
               /*
               Please change the titleId below to your own titleId from PlayFab Game Manager.
               If you have already set the value in the Editor Extensions, this can be skipped.
               */
               PlayFabSettings.staticSettings.TitleId = "42";
           }
           var request = new LoginWithCustomIDRequest { CustomId = "GettingStartedGuide", CreateAccount = true};
           PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
       }
   
       private void OnLoginSuccess(LoginResult result)
       {
           Debug.Log("Congratulations, you made your first successful API call!");
       }
   
       private void OnLoginFailure(PlayFabError error)
       {
           Debug.LogWarning("Something went wrong with your first API call.  :(");
           Debug.LogError("Here's some debug information:");
           Debug.LogError(error.GenerateErrorReport());
       }
   }
   

LoginWithAndroidDeviceID, LoginWithIOSDeviceID, or some form of social login such as LoginWithFacebook. 7. In the Hierarchy panel, right-click your scene, then select Create Empty (or Game Object > Create Empty in older versions of Unity). 8. Select the new Game Object and in the Inspector panel, select Add Component. 9. From the component drop-down menu, select Scripts > PlayFabLogin. For more information on creating and using scripts in the Unity Editor, see Creating and Using Scripts in the Unity documentation.

​

Finish and execute

You’re now ready to test out this sample.

• Be sure to save all files and return to the Unity Editor
• Press the Play button at the top of the editor

You should see the following message in your Unity Console Panel. For a list of all available client API calls, see PlayFab API References.

​

Next steps

This quickstart shows a simplified procedure for authenticating a user. For more information on user authentication, see Login basics and best practices. Learn how to bind an account to multiple devices and login mechanisms: Account linking quickstart.