​

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

​

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.

​

Configuração do projeto JavaScript

• PlayFabGettingStarted.html
• PlayFabGettingStarted.js

​

Exemplos de código

​

Autenticar o cliente

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>PlayFab JavaScript Unit Tests</title>
    <script type="text/javascript" src="https://download.playfab.com/PlayFabClientApi.js"></script>
    <script type="text/javascript" src="PlayFabGettingStarted.js"></script>
</head>
<body>
    PlayFab Getting Started Guide<br />
    TitleID: <input type="text" id="titleId" value="144"><br />
    CustomID: <input type="text" id="customId" value="GettingStartedGuide"><br />
    <input type="button" value="Call LoginWithCustomID" onclick="DoExampleLoginWithCustomID()"><br />
    Result:<br />
    <textarea id="resultOutput" cols="60" rows="5"></textarea><br />
</body>
</html>

function DoExampleLoginWithCustomID(){
    PlayFab.settings.titleId = document.getElementById("titleId").value;
    var loginRequest = {
        // Currently, you need to look up the required and optional keys for this object in the API reference for LoginWithCustomID. See the Request Headers and Request Body.
        TitleId: PlayFab.settings.titleId,
        CustomId: document.getElementById("customId").value,
        CreateAccount: true
    };

    PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
}

// callback functions take two parameters: result and error
// see callback functions in JavaScript if unclear
var LoginCallback = function (result, error) {
    if (result !== null) {
        document.getElementById("resultOutput").innerHTML = "Congratulations, you made your first successful API call!";
    } else if (error !== null) {
        document.getElementById("resultOutput").innerHTML =
            "Something went wrong with your first API call.\n" +
            "Here's some debug information:\n" +
            PlayFab.GenerateErrorReport(error);
    }
}

​

Executar o código

1. Abra PlayFabGettingStarted.html no seu navegador favorito.
2. Selecione o botão Call LoginWithCustomID.
3. Você verá o seguinte texto na seção Result: “Congratulations, you made your first successful API call!”

​

Desconstruir o código

<script type="text/javascript" src="https://download.playfab.com/PlayFabClientApi.js"></script>

<script type="text/javascript" src="PlayFabGettingStarted.js"></script>
...
<input type="button" value="Call LoginWithCustomID" onclick="DoExampleLoginWithCustomID()"><br />

• Análise linha por linha de PlayFabGettingStarted.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 LoginWithCustomID, 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. Os campos do Request Body são incluídos como chaves e valores no objeto de requisição. O Session Ticket no Request Header será salvo a partir do logon, portanto o SessionTicket não é incluído no objeto de requisição.
  • 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
  • Se você é novo em JavaScript, recomendamos ler sobre funções de callback.
  • LoginCallback contém dois parâmetros: result, error
    • 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 chamada à 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.
• 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 do PlayFab.
• Por que as chamadas à API falham (em ordem de probabilidade)
  • PlayFabSettings.TitleId não está definido. Se o TitleId não estiver definido, 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.
• 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