​

Démarrage rapide : bibliothèque cliente PlayFab pour JavaScript

​

Prérequis

• Un compte de développeur PlayFab. Pour plus d’informations sur la création d’un titre et la recherche du TitleId, consultez Démarrage rapide : Game Manager.

​

Configuration du projet JavaScript

• PlayFabGettingStarted.html
• PlayFabGettingStarted.js

​

Exemples de code

​

Authentifier le client

<!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);
    }
}

​

Exécuter le code

1. Ouvrez PlayFabGettingStarted.html dans votre navigateur préféré.
2. Sélectionnez le bouton Call LoginWithCustomID.
3. Le texte suivant devrait s’afficher dans la section Result : “Congratulations, you made your first successful API call!”

​

Analyse du code

<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 />

• Analyse ligne par ligne de PlayFabGettingStarted.js
  • PlayFab.settings.titleId = "xxxx";
    • Chaque développeur PlayFab crée un titre dans Game Manager. Lorsque vous publiez votre jeu, vous devez coder ce titleId dans votre jeu. Cela permet au client de savoir comment accéder aux bonnes données dans PlayFab. Pour la plupart des utilisateurs, considérez simplement qu’il s’agit d’une étape obligatoire pour que PlayFab fonctionne.
  • var loginRequest = { TitleId: PlayFab.settings.titleId, CustomId: "GettingStartedGuide", CreateAccount: true };
    • La plupart des méthodes de l’API PlayFab nécessitent des paramètres d’entrée, et ces paramètres d’entrée sont regroupés dans un objet de requête
    • Chaque méthode d’API nécessite un objet de requête unique, avec un mélange de paramètres facultatifs et obligatoires
      • Pour LoginWithCustomID, il existe un paramètre obligatoire CustomId, qui identifie un joueur de façon unique, et CreateAccount, qui permet de créer un nouveau compte avec cet appel. TitleId est un autre paramètre obligatoire en JavaScript, et il doit correspondre à PlayFab.settings.titleId.
      • Pour savoir où trouver le TitleId, consultez Démarrage rapide : Game Manager.
  • Dans ce cas, TitleId, customId et CreateAccount proviennent du corps de la requête de LoginWithCustomID. Les champs du corps de la requête sont inclus sous forme de clés et de valeurs dans l’objet de requête. Le ticket de session de l’en-tête de la requête est enregistré lors de la connexion; le SessionTicket n’est donc pas inclus dans l’objet de requête.
  • PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
    • Cette ligne lance la requête asynchrone vers LoginWithCustomID, qui appellera LoginCallback une fois l’appel d’API terminé.
    • Pour la connexion, la plupart des développeurs voudront utiliser une méthode de connexion plus appropriée.
      • Consultez la documentation sur la connexion PlayFab pour obtenir la liste de toutes les méthodes de connexion et de leurs paramètres d’entrée. Les choix courants sont :
        • LoginWithAndroidDeviceID
        • LoginWithIOSDeviceID
        • LoginWithEmailAddress
  • Si vous débutez en JavaScript, nous vous recommandons de vous renseigner sur les fonctions de rappel.
  • LoginCallback contient deux paramètres : result et error
    • En cas de réussite, error est null et l’objet result contient les informations demandées, en fonction de l’API appelée.
    • Ce résultat contient des informations de base sur le joueur, mais pour la plupart des utilisateurs, la connexion est simplement une étape obligatoire avant d’appeler d’autres API.
  • Si error n’est pas null, votre appel d’API a échoué.

​

Résolution des problèmes

• Les appels d’API peuvent échouer pour de nombreuses raisons, et vous devez toujours essayer de gérer les échecs.
• L’objet error comprend le nom, le code et le message de l’erreur. Ensemble, ces informations devraient suffire à diagnostiquer votre erreur.
• Les codes d’erreur globaux des méthodes d’API sont disponibles dans les codes d’erreur globaux des méthodes d’API de PlayFab.
• Raisons pour lesquelles les appels d’API échouent (par ordre de probabilité)
  • PlayFabSettings.TitleId n’est pas défini. Si TitleId n’est pas défini, rien ne fonctionnera.
  • Paramètres de la requête. Si vous n’avez pas fourni les informations correctes ou requises pour un appel d’API particulier, celui-ci échouera. Consultez error.errorMessage, error.errorDetails ou error.GenerateErrorReport() pour plus d’informations.
  • Problème de connectivité de l’appareil. Les téléphones portables perdent et retrouvent constamment la connectivité. Ainsi, n’importe quel appel d’API peut échouer de façon aléatoire à tout moment, puis fonctionner immédiatement après. Entrer dans un tunnel peut vous déconnecter complètement.
• Problème de serveur PlayFab. Comme pour tout logiciel, des problèmes peuvent survenir. Consultez nos notes de publication pour connaître les mises à jour.
  • Internet n’est pas fiable à 100 %. Parfois, le message est corrompu ou n’atteint pas le serveur PlayFab.
• Si vous avez des difficultés à déboguer un problème et que les informations d’erreur ne suffisent pas, rendez-vous sur nos forums.

​

Étapes suivantes