​

クイックスタート: NodeJS 向け PlayFab クライアント ライブラリ

​

前提条件

• PlayFab 開発者アカウント。タイトルの作成と TitleId の確認方法については、Game Manager クイックスタート を参照してください。
• Node.js
• Node が PATH 環境変数に含まれている必要があります。インストーラーを使用した場合、デフォルトの場所 C:/Program Files (x86)/nodejs/ に設定されている可能性があります。

​

セットアップ

1. プロジェクト用の新しいフォルダー {NodeProjLocation} を作成します: GettingStarted.js
2. プロジェクト フォルダーでコマンド ウィンドウを開きます。
3. 次のコマンドを実行します: npm install playfab-sdk --save (このウィンドウは開いたままにしてください。後で再度使用します。)

​

コード例

​

クライアントを認証する

var PlayFab = require("./node_modules/playfab-sdk/Scripts/PlayFab/PlayFab");
var PlayFabClient = require("./node_modules/playfab-sdk/Scripts/PlayFab/PlayFabClient");

function DoExampleLoginWithCustomID() {
    PlayFab.settings.titleId = "144";
    var loginRequest = {
        // Currently, you need to look up the correct format for this object in the API reference for LoginWithCustomID. The Request Headers and Request Body are included as keys and values in the request object.
        TitleId: PlayFab.settings.titleId,
        CustomId: "GettingStartedGuide",
        CreateAccount: true
    };

    // For functions in the Node SDK, the first parameter will be the request object and the second parameter will be the callback function. The callback function executes after the request returns.
    PlayFabClient.LoginWithCustomID(loginRequest, LoginCallback);
}

function LoginCallback(error, result) {
    if (result !== null) {
        console.log("Congratulations, you made your first successful API call!");
    } else if (error !== null) {
        console.log("Something went wrong with your first API call.");
        console.log("Here's some debug information:");
        console.log(CompileErrorReport(error));
    }
}

// This is a utility function we haven't put into the core SDK yet. Feel free to use it.
function CompileErrorReport(error) {
    if (error == null)
        return "";
    var fullErrors = error.errorMessage;
    for (var paramName in error.errorDetails)
        for (var msgIdx in error.errorDetails[paramName])
            fullErrors += "\n" + paramName + ": " + error.errorDetails[paramName][msgIdx];
    return fullErrors;
}

// Kick off the actual login call
DoExampleLoginWithCustomID();

​

コードを実行する

1. インストール中に開いたコンソール ウィンドウで、次のコマンドを実行します: node GettingStarted.js 結果として次のテキストが表示されます: “Congratulations, you made your first successful API call!”

​

コードの詳細解説

• GettingStarted.js の行ごとの解説
  • PlayFab.settings.titleId = "xxxx";
    • すべての PlayFab 開発者は、Game Manager でタイトルを作成します。ゲームを公開する際、その TitleId をゲームにコーディングする必要があります。これにより、クライアントは PlayFab 内の正しいデータへのアクセス方法を知ることができます。ほとんどのユーザーにとって、これは PlayFab を動作させるために必要な手順と考えてください。
  • var loginRequest = { TitleId: PlayFab.settings.titleId, CustomId: "GettingStartedGuide", CreateAccount: true };
    • ほとんどの PlayFab API メソッドは入力パラメーターを必要とし、それらの入力パラメーターはリクエスト オブジェクトにまとめられます。
    • すべての API メソッドには、オプションと必須のパラメーターが混在した一意のリクエスト オブジェクトが必要です。
      • LoginWithCustomIDRequest には、プレイヤーを一意に識別する必須パラメーター CustomId と、この呼び出しで新しいアカウントの作成を許可する CreateAccount があります。TitleId は JavaScript のもう 1 つの必須パラメーターで、PlayFab.settings.titleId と一致する必要があります。
      • TitleId の場所については、Game Manager クイックスタート を参照してください。
• この場合、TitleId、customId、CreateAccount は LoginWithCustomID のリクエスト本文からのものです。
  • PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
    • これは LoginWithCustomID への非同期リクエストを開始し、API 呼び出しが完了すると LoginCallback を呼び出します。
  • ログインについては、ほとんどの開発者はより適切なログイン メソッドを使用することを望むでしょう。
    • すべてのログイン メソッドと入力パラメーターの一覧については、PlayFab ログイン ドキュメント を参照してください。一般的な選択肢は次のとおりです。
      • LoginWithAndroidDeviceID
      • LoginWithIOSDeviceID
      • LoginWithEmailAddress
• LoginCallback には、error と result の 2 つのパラメーターが含まれます。
  • 成功した場合、error は null となり、result オブジェクトには呼び出された API に応じた要求された情報が含まれます。
    • この result にはプレイヤーに関する基本情報が含まれますが、ほとんどのユーザーにとって、ログインは他の API を呼び出す前の必須ステップにすぎません。
• error が null でない場合、API は失敗しています。

​

トラブルシューティング

• API 呼び出しはさまざまな理由で失敗する可能性があるため、常に失敗を処理するようにしてください。
• error オブジェクトには、エラー名、エラー コード、エラー メッセージが含まれます。これらの情報を組み合わせることで、エラーの診断に十分な情報が得られるはずです。
• API 呼び出しが失敗する理由 (可能性の高い順):
  • PlayFabSettings.TitleId が設定されていない。TitleId をタイトルに設定するのを忘れた場合、何も動作しません。
  • リクエスト パラメーター。特定の API 呼び出しに対して正しい情報や必要な情報を提供していない場合、失敗します。詳細については、error.errorMessage、error.errorDetails、または error.GenerateErrorReport() を参照してください。
  • デバイスの接続の問題。携帯電話は接続を頻繁に失ったり回復したりします。そのため、いつでも API 呼び出しがランダムに失敗し、その後すぐに動作することがあります。トンネルに入ると、完全に切断される可能性があります。
  • PlayFab サーバーの問題。すべてのソフトウェアと同様に、問題が発生する可能性があります。更新については リリース ノート を参照してください。
• インターネットは 100% 信頼できるわけではありません。メッセージが破損したり、PlayFab サーバーに到達しなかったりすることがあります。
  • グローバル API メソッド エラー コードは、グローバル API メソッド エラー コード を参照してください。
  • 問題のデバッグに苦労しており、エラー情報内の情報だけでは不十分な場合は、フォーラム にアクセスしてください。

​

次のステップ