​

快速入门：适用于 NodeJS 的 PlayFab 客户端库

​

前提条件

• 一个 PlayFab 开发者帐户。有关创建 Title 和查找 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 中的另一个必需参数，它必须匹配 PlayFab.settings.titleId。
      • 有关在何处找到 TitleId 的信息，请参阅 Game Manager 快速入门。
• 在本例中，TitleId、customId 和 CreateAccount 来自 LoginWithCustomID 的请求正文。
  • PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
    • 这会开始对 LoginWithCustomID 的异步请求，当 API 调用完成时将调用 LoginCallback。
  • 对于登录，大多数开发者会希望使用更适合的登录方法。
    • 请参阅 PlayFab 登录文档 了解所有登录方法及输入参数的列表。常见选择包括：
      • LoginWithAndroidDeviceID
      • LoginWithIOSDeviceID
      • LoginWithEmailAddress
• LoginCallback 包含两个参数：error 和 result。
  • 成功时，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 方法错误代码。
  • 如果你在调试问题时遇到困难，且错误信息中的内容不够充分，请访问我们的 论坛。

​

后续步骤