クイックスタート: Unity の C# 用の PlayFab クライアント ライブラリ

Unity の C# 用の PlayFab クライアント ライブラリを使用して開始します。 パッケージをインストールして、基本的なタスクのコード例を試します。

このクイックスタートでは、Unity3d エンジンで最初の PlayFab API 呼び出しを行うことができます。 続行する前に、「開発者向けの基礎知識」を完了することで、PlayFab アカウントを作成し、PlayFab ゲーム マネージャーに精通してください。

要件

  • PlayFab 開発者アカウント
  • インストール済みの Unity エディターのコピー。 Unity Hub を介して個人的に使用するために Unity をインストールする、または業務用に Unity+ をインストールするには、「Unity のダウンロード」を参照してください。

    注意

    PlayFab Unity3D SDK は、Unity エディター バージョン 5.3 (2015 年 12 月リリース) 以降に対応しています。

  • Unity プロジェクト – これは次のいずれかになります。
    • 最新プロジェクト。 詳細については、「Unity を初めて起動する」を参照してください。
    • ガイド付きチュートリアル プロジェクト。 詳細については、「Unity の使用を開始する」を参照してください。
    • 既存のプロジェクト。
  • PlayFab Unity3D SDK。

PlayFab SDK のダウンロードとインストール

layFab エディターの拡張機能パッケージを使用して、SDK をインストールします。 PlayFab エディター拡張機能はスタンドアロン Unity プラグインの 1 つで、SDK のインストールとタイトル用の PlayFab 設定構成を効率化できます。 PlayFab エディター拡張機能を使用せずに SDK をインストールする方法については、「Unity 用 PlayFab SDK のインストール」を参照します。

  1. PlayFab Unity エディターの拡張機能アセット パッケージをダウンロードします。

  2. Unity プロジェクトを開きます。

  3. ファイルをダウンロードした場所に移動し、PlayFabEditorExtensions.UnityPackage ファイルをダブルクリックすると、Unity エディターで Import Unity Package ダイアログを開くことができます。

    Unity アセット パッケージをインポートする

  4. Playfab Unity エディターの拡張機能をプロジェクトにインポートするには、[インポート] を選択します。

  5. インポートが完了すると、PlayFab Unity エディター拡張機能パネルが自動的に開きます。 PlayFab 開発者アカウントを既に作成している場合は、[ログイン] リンクを選択して、PlayFab 用のユーザー名とパスワードでログインします。

    PlayFab へのログイン

    注意

    パネルが開かなかった場合、またはパネルを閉じてもう一度開く場合は、ウィンドウ > PlayFab > エディター拡張機能 の順に選択してこの操作を行うことができます。

  6. ログイン後、拡張機能に SDK のインストール ダイアログが表示されます。

    PlayFab SDK のインストール

  7. [PlayFab SDK のインストール] を選択すると、SDK を自動的にプロジェクトへインポートしたり、現在のバージョンをアップグレードできます。

タイトル設定を行う

API 呼び出しができるよう前に、タイトルを指定して PlayFab タイトル設定 で呼び出しを受け取ることができるようにする必要があります。 タイトルを設定するには:

  1. [エディター拡張機能][タイトルの設定] を選択します。

    エディター拡張機能でタイトルを設定する

  2. Studio エントリを選択して、スタジオのドロップダウン メニューを開きます。 接続先のタイトルを含むスタジオを選択します。

  3. タイトル IDエントリを選択して、選択したスタジオに関連付けられているタイトルのドロップダウン メニューを開きます。

開発者秘密鍵 が、タイトルの既定の秘密鍵に自動的に設定されます。 秘密鍵については、秘密鍵の管理を参照してください。

PlayFab タイトル設定

最初の API 呼び出しを実行する

ガイドのこの部分には最短の手順があり、最初の PlayFab API 呼び出しを行うことができます。 この例には、GUI や画面上のフィードバックがありません。 確認はコンソール ログに表示されます。

  1. Unity プロジェクトに Scripts フォルダーがまだない場合 (HDRPLWRP/URP テンプレートには既定で 1 つがあります)、[プロジェクト] パネルの アセット フォルダーを右クリックし、 > フォルダー作成 を選択します。

  2. [アセット] ウィンドウで、フォルダーの名前を 文字列 にします。

  3. スクリプト フォルダーを右クリックし、 > C# スクリプト 作成 を選択します。

  4. スクリプトの名前を PlayFabLogin にします。

  5. ファイルをダブルクリックしてコード エディターで開きます。 設定やインストールされているプログラムに応じて、これは Visual Studio または MonoDevelop になります。

  6. コード エディターで、PlayFabLogin.cs の内容を以下で表示されるコードに置き換えてファイルを保存します。

    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());
        }
    }
    

    重要

    上に示したコードは、モバイルのタイトルでは使用できません。 これは一例であり、CustomID を使用してログインする方法を示しています。 モバイル タイトルのログインを実装するには、LoginWithAndroidDeviceIDLoginWithIOSDeviceID、または LoginWithFacebook などのソーシャル ログイン形式のいずれかを使用します。

  7. Hierarchy パネルでシーンを右クリックし、[空の作成] を選択します。Unity の以前のバージョンの場合は、ゲーム オブジェクト > [空の作成] の順に選択します。

  8. 新しいゲーム オブジェクトを選択し、[インスペクター] パネルで、コンポーネントの追加 を選択します。

  9. コンポーネントのドロップダウン メニューから、スクリプト > PlayFabLogin の順に選択します。

Unity エディターでのスクリプトの作成と使用の詳細については、Unity ドキュメントの「スクリプトの作成と使用」を参照します。

完成と実行

このサンプルをテストする準備が整いました。

  • 必ず、すべてのファイルを保存して、Unity エディターに戻ります。
  • エディターの上部にある [再生] ボタンを押します

Unity コンソール パネルで次の内容を確認できます。

最初の API 呼び出しのコンソール ログ

ヒント

または、PlayFab にログインしてゲーム マネージャーでタイトルまで移動して、[PlayStream モニター] タブを選択することができます。Alt+ TAB キーを押すたびに、アクティブに実行されている Unity ゲームからフォーカスが移動し、Playstream モニターで表示および確認っでいるイベントがゲームにより渡されます。

利用可能なすべてのクライアント API 呼び出しの一覧については、PlayFab API リファレンス をご覧ください。

次の手順

このクイックスタートでは、ユーザーを認証するための簡単な手順を示します。 ユーザー認証の詳細については、「ログインの基本とベスト プラクティス」を参照してください。

複数のデバイスとログイン メカニズムにアカウントをバインドする方法についての詳細情報: アカウント リンクのクイックスタート