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

[アーティクル]
12/08/2023

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

このクイックスタートでは、Unity エンジンで最初の PlayFab API 呼び出しを行うことができます。

要件

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

注意

PlayFab Unity SDK は、Unity エディターバージョン 5.3 (2015 年 12 月リリース) 以降に対応しています。
次のいずれかの種類の Unity プロジェクト。
- 最新プロジェクト。詳細については、「Unity を初めて起動する」を参照してください。
- ガイド付きチュートリアルプロジェクト。詳細については、「Unity の使用を開始する」を参照してください。
- 既存のプロジェクト。
PlayFab Unity SDK。

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

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

PlayFab Unity エディターの拡張機能アセットパッケージをダウンロードします。
Unity プロジェクトを開きます。
ファイルをダウンロードした場所に移動し、PlayFabEditorExtensions.UnityPackage ファイルをダブルクリックすると、Unity エディターで Import Unity Package ダイアログを開くことができます。
Playfab Unity エディターの拡張機能をプロジェクトにインポートするには、[インポート] を選択します。
インポートが完了すると、PlayFab Unity エディター拡張機能パネルが自動的に開きます。 PlayFab 開発者アカウントを既に作成している場合は、[ログイン] リンクを選択して、PlayFab 用のユーザー名とパスワードでログインします。

注意

パネルが開かなかった場合、またはパネルを閉じてもう一度開く場合は、ウィンドウ>PlayFab>エディター拡張機能 の順に選択してこの操作を行うことができます。
ログイン後、拡張機能に SDK のインストールダイアログが表示されます。
[PlayFab SDK のインストール] を選択すると、SDK を自動的にプロジェクトへインポートしたり、現在のバージョンをアップグレードできます。

タイトル設定を行う

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

[エディター拡張機能]で [タイトルの設定] を選択します。
Studio エントリを選択して、スタジオのドロップダウンメニューを開きます。接続先のタイトルを含むスタジオを選択します。
タイトル IDエントリを選択して、選択したスタジオに関連付けられているタイトルのドロップダウンメニューを開きます。

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

PlayFab タイトル設定

[!注] 拡張機能を使用すると、PlayFab への要求を行うために使用される http トランスポートをカスタマイズできます。推奨される既定値は Unity Web Request です。古いエンジンバージョンまたはゲーム固有の http 実装との互換性を提供するために、その他のオプションが存在します。

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

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

Unity プロジェクトに Scripts フォルダーがまだない場合 (HDRP と LWRP/URP テンプレートには既定で 1 つがあります)、[プロジェクト] パネルの アセット フォルダーを右クリックし、>フォルダー の作成を選択します。
[アセット] ウィンドウで、フォルダーの名前を 文字列 にします。
スクリプトフォルダーを右クリックし、>C# スクリプト作成を選択します。
スクリプトの名前を PlayFabLogin にします。
ファイルをダブルクリックしてコードエディターで開きます。

コードエディターで、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());
    }
}

Important

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

Hierarchy パネルでシーンを右クリックし、[空の作成] を選択します。Unity の以前のバージョンの場合は、ゲームオブジェクト>[空の作成] の順に選択します。
新しいゲームオブジェクトを選択し、[インスペクター] パネルで、コンポーネントの追加 を選択します。
コンポーネントのドロップダウンメニューから、スクリプト>PlayFabLogin の順に選択します。

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

完成と実行

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

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

Unity コンソールパネルで次のメッセージを確認できます。

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

ヒント

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

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

次の手順

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

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

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

要件