​

Início rápido: biblioteca de cliente do PlayFab para NodeJS

​

Pré-requisitos

• Uma conta de desenvolvedor do PlayFab. Para obter informações sobre como criar um título e encontrar o TitleId, consulte o Início rápido do Game Manager.
• Node.js
• O Node precisa estar na variável de ambiente PATH. Se você usou o instalador, provavelmente ela já foi definida para o local padrão: C:/Program Files (x86)/nodejs/

​

Configuração

1. Crie uma nova pasta para o seu projeto {NodeProjLocation}: GettingStarted.js
2. Abra uma janela de comando na pasta do projeto.
3. Execute este comando: npm install playfab-sdk --save (Mantenha esta janela aberta; você a usará novamente mais tarde.)

​

Exemplos de código

​

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

​

Executar o código

1. Na janela de console que abrimos durante a instalação, execute o comando: node GettingStarted.js Você verá o seguinte texto como resultado: “Congratulations, you made your first successful API call!”

​

Desconstruir o código

• Análise linha por linha de GettingStarted.js
  • PlayFab.settings.titleId = "xxxx";
    • Todo desenvolvedor do PlayFab cria um título no Game Manager. Ao publicar seu jogo, você precisa codificar esse TitleId no jogo. Isso permite que o cliente saiba como acessar os dados corretos no PlayFab. Para a maioria dos usuários, basta considerar isso uma etapa obrigatória para que o PlayFab funcione.
  • var loginRequest = { TitleId: PlayFab.settings.titleId, CustomId: "GettingStartedGuide", CreateAccount: true };
    • A maioria dos métodos da API do PlayFab exige parâmetros de entrada, e esses parâmetros são empacotados em um objeto de requisição.
    • Cada método da API exige um objeto de requisição exclusivo, com uma combinação de parâmetros opcionais e obrigatórios.
      • Para LoginWithCustomIDRequest, há um parâmetro obrigatório CustomId, que identifica um jogador de forma exclusiva, e CreateAccount, que permite a criação de uma nova conta com essa chamada. TitleId é outro parâmetro obrigatório em JavaScript e precisa corresponder a PlayFab.settings.titleId.
      • Para obter informações sobre onde encontrar o TitleId, consulte o Início rápido do Game Manager.
• Neste caso, TitleId, customId e CreateAccount vêm do Request Body de LoginWithCustomID.
  • PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
    • Isso inicia a requisição assíncrona para LoginWithCustomID, que chamará LoginCallback quando a chamada à API for concluída.
  • Para o logon, a maioria dos desenvolvedores vai querer usar um método de logon mais adequado.
    • Consulte a documentação de logon do PlayFab para obter uma lista de todos os métodos de logon e parâmetros de entrada. As opções comuns são:
      • LoginWithAndroidDeviceID
      • LoginWithIOSDeviceID
      • LoginWithEmailAddress
• LoginCallback contém dois parâmetros: error e result.
  • Em caso de sucesso, error será null e o objeto result conterá as informações solicitadas, de acordo com a API chamada.
    • Este result contém algumas informações básicas sobre o jogador, mas, para a maioria dos usuários, o logon é simplesmente uma etapa obrigatória antes de chamar outras APIs.
• Se error não for null, sua API falhou.

​

Solução de problemas

• As chamadas à API podem falhar por vários motivos, e você deve sempre tentar tratar a falha.
• O objeto de erro inclui o nome, o código e a mensagem do erro. Juntas, essas informações devem ser suficientes para diagnosticar o erro.
• Por que as chamadas à API falham (em ordem de probabilidade):
  • PlayFabSettings.TitleId não está definido. Se você se esquecer de definir TitleId para o seu título, nada funcionará.
  • Parâmetros da requisição. Se você não tiver fornecido as informações corretas ou obrigatórias para uma determinada chamada à API, ela falhará. Consulte error.errorMessage, error.errorDetails ou error.GenerateErrorReport() para obter mais informações.
  • Problema de conectividade do dispositivo. Celulares perdem e recuperam a conectividade constantemente, portanto qualquer chamada à API pode falhar aleatoriamente a qualquer momento e funcionar logo em seguida. Entrar em um túnel pode desconectar você completamente.
  • Problema no servidor do PlayFab. Como em qualquer software, podem ocorrer problemas. Consulte nossas notas de versão para obter atualizações.
• A internet não é 100% confiável. Às vezes, a mensagem é corrompida ou não chega ao servidor do PlayFab.
  • Os códigos de erro globais dos métodos da API podem ser encontrados em Códigos de erro globais dos métodos da API.
  • Se você estiver com dificuldades para depurar um problema e as informações do erro não forem suficientes, visite nossos fóruns.

​

Próximas etapas