> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unity 快速入門

> 安裝 PlayFab Unity SDK，並使用編輯器和 Client 程式庫，從 Unity 專案以 C# 進行您的第一次 PlayFab 用戶端 API 呼叫。

# 快速入門：Unity 中適用於 C# 的 PlayFab Client 程式庫

開始使用 Unity 中適用於 C# 的 PlayFab Client 程式庫。請依照步驟安裝套件，並試用基本工作的範例程式碼。

本快速入門可協助您在 Unity 引擎中進行第一次 PlayFab API 呼叫。

## 需求

* [PlayFab 開發人員帳戶](https://developer.playfab.com)。
* 已安裝的 Unity 編輯器。若要透過 Unity Hub 安裝供個人使用的 Unity，或供專業使用的 Unity+，請參閱[下載 Unity](https://unity.com/download)。

<Note>
  PlayFab Unity SDK 支援 Unity 編輯器 5.3 版 (於 2015 年 12 月發行) 及更新版本。
</Note>

* 下列任一類型的 Unity 專案：
  * 全新的專案。如需詳細資訊，請參閱[第一次啟動 Unity](https://docs.unity3d.com/Manual/get-started-with-unity.html)。
  * 引導式教學課程專案。如需詳細資訊，請參閱[開始使用 Unity](https://learn.unity.com/)。
  * 現有的專案。
* PlayFab Unity SDK。

## 下載並安裝 PlayFab SDK

您可以使用 PlayFab 編輯器延伸模組套件來安裝 SDK，或直接安裝 SDK。PlayFab 編輯器延伸模組是一個獨立的 Unity 外掛程式，可簡化 SDK 的安裝，以及為您的遊戲設定某些 PlayFab 設定。如需在不使用 PlayFab 編輯器延伸模組的情況下安裝 SDK 的相關資訊，請參閱[在 Unity 中不使用編輯器延伸模組安裝 PlayFab SDK](/zh-TW/services/playfab/sdks/unity3d/installing-unity3d-sdk#download-and-install-the-sdk-only)。

1. 下載 [PlayFab Unity 編輯器延伸模組資產套件](https://aka.ms/PlayFabUnityEdEx)。
2. 開啟您的 Unity 專案。
3. 瀏覽至您下載檔案的位置，然後按兩下 `PlayFabEditorExtensions.UnityPackage` 檔案，以在 Unity 編輯器中開啟 **Import Unity Package** 對話方塊。

   <img src="https://mintcdn.com/microsoft-4404708b/N3T1ucKV7zIMBudj/images/playfab/sdks/unity3d/import-uedex.png?fit=max&auto=format&n=N3T1ucKV7zIMBudj&q=85&s=7fe7482c3981c4c09469872bc7ee6bc1" alt="匯入 Unity 資產套件" width="352" height="582" data-path="images/playfab/sdks/unity3d/import-uedex.png" />
4. 若要將 PlayFab Unity 編輯器延伸模組匯入您的專案，請選取 **Import**。
5. 匯入完成時，PlayFab Unity 編輯器延伸模組面板應該會自動開啟，並顯示 SDK 安裝對話方塊。

<Note>
  如果面板沒有開啟，或者您關閉了面板並想要重新開啟，可以選取 **Window** > **PlayFab** > **Editor Extensions** 來開啟
</Note>

<img src="https://mintcdn.com/microsoft-4404708b/N3T1ucKV7zIMBudj/images/playfab/sdks/unity3d/install-sdk.png?fit=max&auto=format&n=N3T1ucKV7zIMBudj&q=85&s=ef1dddd1a1f2e66865c1ffae2f972fbe" alt="安裝 PlayFab SDK" width="395" height="384" data-path="images/playfab/sdks/unity3d/install-sdk.png" />

6\. 選取 **Install PlayFab SDK**，將 SDK 自動匯入您的專案，或升級目前安裝的版本。

## 設定您的遊戲設定

您必須先建立 **PlayFabSharedSettings.asset** 並指定要接收呼叫的遊戲識別碼，才能進行 API 呼叫。若要設定遊戲識別碼：

1. 選取 **PlayFab** > **MakePlayFabSharedSettings**，這應該會建立設定資產並在 Inspector 面板中將其開啟。

2. 在 Inspector 中設定您的 **Title ID**。

   <img src="https://mintcdn.com/microsoft-4404708b/N3T1ucKV7zIMBudj/images/playfab/sdks/unity3d/playfab-shared-settings-title-id.png?fit=max&auto=format&n=N3T1ucKV7zIMBudj&q=85&s=6d2534c5573758d21d3f860adcab8f65" alt="PlayFab 遊戲識別碼設定" width="1018" height="510" data-path="images/playfab/sdks/unity3d/playfab-shared-settings-title-id.png" />

3. 現在，您隨時都可以從編輯器延伸模組面板的 **Settings** 索引標籤查看及變更目前的遊戲識別碼。

**Developer Secret Key** 預設不會設定。如果您要進行伺服器組建，請務必在 **PlayFabSharedSettings.asset** 中提供祕密金鑰。

<img src="https://mintcdn.com/microsoft-4404708b/N3T1ucKV7zIMBudj/images/playfab/sdks/unity3d/playfab-shared-settings-secret-key.png?fit=max&auto=format&n=N3T1ucKV7zIMBudj&q=85&s=35f6f7c6dcd9094e0699bfa967b8ec77" alt="PlayFab 開發人員祕密金鑰設定" width="1018" height="510" data-path="images/playfab/sdks/unity3d/playfab-shared-settings-secret-key.png" />

**Developer Secret Key** 會自動設定為遊戲的預設祕密金鑰。如需祕密金鑰的詳細資訊，請參閱[祕密金鑰管理](/zh-TW/services/playfab/live-service-management/gamemanager/secret-key-management)。

否則，在建置您的遊戲用戶端時，請務必**不要設定**祕密金鑰。如需祕密金鑰的詳細資訊，請參閱[祕密金鑰管理](/zh-TW/services/playfab/live-service-management/gamemanager/secret-key-management)。

<Note>
  延伸模組可讓您自訂用來向 PlayFab 提出要求的 HTTP 傳輸。建議的預設值為 Unity Web Request。其他選項可提供與較舊引擎版本或遊戲特定 HTTP 實作的相容性。
</Note>

## 進行您的第一次 API 呼叫

本指南的這個部分提供進行第一次 PlayFab API 呼叫所需的最少步驟。此範例不提供任何 GUI 或畫面上的回饋。確認會顯示在主控台記錄中。

1. 如果您的 Unity 專案還沒有 *Scripts* 資料夾 (**HDRP** 和 **LWRP/URP** 範本預設會有一個)，請在 Project 面板中以滑鼠右鍵按一下 **Assets** 資料夾，然後選取 **Create** > **Folder**。
2. 在 **Assets** 視窗中，將資料夾命名為 *Scripts*。
3. 以滑鼠右鍵按一下 Scripts 資料夾，然後選取 **Create** > **C# Script**。
4. 將指令碼命名為 PlayFabLogin。
5. 按兩下檔案，以在程式碼編輯器中開啟它。
6. 在您的程式碼編輯器中，將 PlayFabLogin.cs 的內容取代為提供的程式碼，然後儲存檔案。

   ```csharp theme={null}
   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());
       }
   }
   ```

<Info>
  提供的程式碼不適用於行動遊戲。這只是一個範例，示範如何使用 `CustomID` 登入。若要為行動遊戲實作登入，請使用
</Info>

[LoginWithAndroidDeviceID](xref:titleid.playfabapi.com.client.authentication.loginwithandroiddeviceid)、[LoginWithIOSDeviceID](xref:titleid.playfabapi.com.client.authentication.loginwithiosdeviceid)，或某種形式的社交登入，例如 [LoginWithFacebook](xref:titleid.playfabapi.com.client.authentication.loginwithfacebook)。
7\. 在 **Hierarchy** 面板中，以滑鼠右鍵按一下您的場景，然後選取 **Create Empty** (在較舊版本的 Unity 中為 **Game Object** > **Create Empty**)。
8\. 選取新的 Game Object，然後在 **Inspector** 面板中選取 **Add Component**。
9\. 從元件下拉式功能表中，選取 **Scripts** > **PlayFabLogin**。

如需在 Unity 編輯器中建立和使用指令碼的詳細資訊，請參閱 Unity 文件中的[建立和使用指令碼](https://docs.unity3d.com/Manual/CreatingAndUsingScripts.html)。

## 完成並執行

您現在已準備好測試此範例。

* 請務必儲存所有檔案並返回 Unity 編輯器
* 按下編輯器頂端的 **Play** 按鈕

您應該會在 Unity Console 面板中看到下列訊息。

<img src="https://mintcdn.com/microsoft-4404708b/N3T1ucKV7zIMBudj/images/playfab/sdks/unity3d/first-call-log.png?fit=max&auto=format&n=N3T1ucKV7zIMBudj&q=85&s=7f898d9ade63a607072bd75daeebf12d" alt="第一次 API 呼叫的主控台記錄" width="600" height="242" data-path="images/playfab/sdks/unity3d/first-call-log.png" />

<Tip>
  或者，您可以登入 PlayFab 並在 Game Manager 中瀏覽至遊戲，然後選取 **PlayStream Monitor** 索引標籤。每當您將焦點從正在執行的 Unity 遊戲移開時，它都會傳遞一個事件，您可以在 PlayStream Monitor 中查看並確認。
</Tip>

如需所有可用用戶端 API 呼叫的清單，請參閱 [PlayFab API 參考](/zh-TW/services/playfab/api-references)。

## 後續步驟

本快速入門示範了驗證使用者的簡化程序。如需使用者驗證的詳細資訊，請參閱[登入基本概念和最佳做法](/zh-TW/services/playfab/identity/player-identity/login/login-basics-best-practices)。

了解如何將帳戶繫結至多個裝置和登入機制：[帳戶連結快速入門](/zh-TW/services/playfab/identity/player-identity/login/quickstart)。


## Related topics

- [Party 快速入門](/zh-TW/services/playfab/multiplayer/networking/quickstart.md)
- [Lobby SDK 快速入門](/zh-TW/services/playfab/multiplayer/lobby/lobby-getting-started.md)
- [Matchmaking SDK 快速入門](/zh-TW/services/playfab/multiplayer/matchmaking/quickstart-client-sdk.md)
- [快速入門](/zh-TW/services/playfab/economy-monetization/economy-v2/quickstart.md)
- [Photon 快速入門](/zh-TW/services/playfab/live-service-management/service-gateway/add-ons/photon/quickstart.md)