​

Inicio rápido: biblioteca cliente de PlayFab para NodeJS

​

Requisitos previos

• Una cuenta de desarrollador de PlayFab. Para obtener información sobre cómo crear un título y encontrar el TitleId, consulte el inicio rápido de Game Manager.
• Node.js
• Node debe estar en la variable de entorno PATH. Si usó el instalador, probablemente esté establecida en la ubicación predeterminada: C:/Program Files (x86)/nodejs/

​

Configuración

1. Cree una carpeta nueva para el proyecto {NodeProjLocation}: GettingStarted.js
2. Abra una ventana de comandos en la carpeta del proyecto.
3. Ejecute este comando: npm install playfab-sdk --save (Mantenga esta ventana abierta; la volverá a usar más adelante.)

​

Ejemplos de código

​

Autenticación del cliente

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

​

Ejecución del código

1. En la ventana de consola que abrimos durante la instalación, ejecute el comando: node GettingStarted.js Debería ver el texto siguiente como resultado: “Congratulations, you made your first successful API call!”

​

Análisis del código

• Desglose línea por línea de GettingStarted.js
  • PlayFab.settings.titleId = "xxxx";
    • Cada desarrollador de PlayFab crea un título en Game Manager. Cuando publique su juego, debe codificar ese TitleId en el juego. Esto permite que el cliente sepa cómo acceder a los datos correctos dentro de PlayFab. Para la mayoría de los usuarios, considérelo simplemente un paso obligatorio que hace que PlayFab funcione.
  • var loginRequest = { TitleId: PlayFab.settings.titleId, CustomId: "GettingStartedGuide", CreateAccount: true };
    • La mayoría de los métodos de la API de PlayFab requieren parámetros de entrada, y esos parámetros de entrada se empaquetan en un objeto de solicitud.
    • Cada método de la API requiere un objeto de solicitud único, con una combinación de parámetros opcionales y obligatorios.
      • Para LoginWithCustomIDRequest, hay un parámetro obligatorio, CustomId, que identifica de forma única a un jugador, y CreateAccount, que permite crear una cuenta nueva con esta llamada. TitleId es otro parámetro obligatorio en JavaScript, y debe coincidir con PlayFab.settings.titleId.
      • Para obtener información sobre dónde encontrar el TitleId, consulte el inicio rápido de Game Manager.
• En este caso, TitleId, customId y CreateAccount proceden del cuerpo de la solicitud de LoginWithCustomID.
  • PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
    • Esto inicia la solicitud asincrónica a LoginWithCustomID, que llamará a LoginCallback cuando se complete la llamada a la API.
  • Para el inicio de sesión, la mayoría de los desarrolladores querrán usar un método de inicio de sesión más adecuado.
    • Consulte la documentación de inicio de sesión de PlayFab para obtener una lista de todos los métodos de inicio de sesión y los parámetros de entrada. Las opciones comunes son:
      • LoginWithAndroidDeviceID
      • LoginWithIOSDeviceID
      • LoginWithEmailAddress
• LoginCallback contiene dos parámetros: error y result.
  • Si la llamada se realiza correctamente, error será null y el objeto result contendrá la información solicitada, según la API a la que se haya llamado.
    • Este result contiene información básica sobre el jugador, pero para la mayoría de los usuarios, el inicio de sesión es simplemente un paso obligatorio antes de llamar a otras API.
• Si error no es null, la llamada a la API ha fallado.

​

Solución de problemas

• Las llamadas a la API pueden fallar por muchos motivos, y siempre debe intentar controlar los errores.
• El objeto error incluye el nombre del error, el código de error y el mensaje de error. En conjunto, esta información debería ser suficiente para diagnosticar el error.
• Motivos por los que fallan las llamadas a la API (en orden de probabilidad):
  • PlayFabSettings.TitleId no está establecido. Si olvida establecer TitleId en su título, nada funcionará.
  • Parámetros de la solicitud. Si no ha proporcionado la información correcta o necesaria para una llamada a la API concreta, esta fallará. Consulte error.errorMessage, error.errorDetails o error.GenerateErrorReport() para obtener más información.
  • Problema de conectividad del dispositivo. Los teléfonos móviles pierden y recuperan la conectividad constantemente, por lo que cualquier llamada a la API en cualquier momento puede fallar aleatoriamente y funcionar inmediatamente después. Entrar en un túnel puede desconectarle por completo.
  • Problema del servidor de PlayFab. Como ocurre con todo el software, puede haber problemas. Consulte nuestras notas de la versión para conocer las actualizaciones.
• Internet no es 100 % confiable. A veces, el mensaje se daña o no llega al servidor de PlayFab.
  • Los códigos de error globales de los métodos de la API se encuentran en Códigos de error globales de los métodos de la API.
  • Si tiene dificultades para depurar un problema y la información contenida en el error no es suficiente, visítenos en nuestros foros.

​

Pasos siguientes