Schnellstart: PlayFab-Clientbibliothek für NodeJS

Artikel
07/11/2023

Beginnen Sie mit der PlayFab-Clientbibliothek für NodeJS, um Ihren ersten PlayFab-API-Aufruf auszuführen und einen Player zu authentifizieren. Führen Sie die Schritte aus, um das Paket zu installieren und Beispielcode für grundlegende Aufgaben auszuprobieren.

Voraussetzungen

Ein PlayFab-Entwicklerkonto. Informationen zum Erstellen eines Titels und zum Suchen nach TitleId finden Sie unter Game Manager-Schnellstart.
Node.js
Der Knoten muss sich in Ihrer PATH-Umgebungsvariablen befinden. Wenn Sie das Installationsprogramm verwendet haben, ist es wahrscheinlich für Sie auf den Standardspeicherort festgelegt: C:/Programme (x86)/nodejs/

Einrichtung wird ausgeführt

Die folgenden Befehle funktionieren unter Windows, MacOS und Linux.

Erstellen Sie einen neuen Ordner für Ihr Projekt {NodeProjLocation}:

GettingStarted.js
Öffnen Sie ein Befehlsfenster in Ihrem Projektordner.
Führen Sie den folgenden Befehl aus:

npm install playfab-sdk --save

(Lassen Sie dieses Fenster geöffnet (wir verwenden es später erneut.)

PlayFab-Installation abgeschlossen!

Codebeispiele

Authentifizieren des Clients

Dieser Leitfaden enthält die Mindestschritte für den ersten PlayFab-API-Aufruf ohne GUI oder Feedback auf dem Bildschirm.This guide provides the minimum steps for you to make your first PlayFab API call, without any GUI or on-screen feedback. Die Bestätigung erfolgt über das Konsolenprotokoll. Für weitere Informationen zu Parametern und Rückgabewerten empfehlen wir zunächst die Verwendung der Postman-Vorlage .

Aktualisieren Sie in Ihrem bevorzugten Text-Editor den Inhalt von GettingStarted.js wie folgt:

Notiz

Informationen zum Suchen des richtigen Formats für das loginRequest -Objekt in diesem Beispiel finden Sie in der API-Referenz für LoginWithCustomID.

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

Ausführen des Codes

Führen Sie im Konsolenfenster, das wir während der Installation geöffnet haben, den Folgenden Befehl aus:

node GettingStarted.js

Daraufhin sollte der folgende Text angezeigt werden:

"Herzlichen Glückwunsch, Sie haben Ihren ersten erfolgreichen API-Aufruf durchgeführt!"

Jetzt können Sie damit beginnen, andere API-Aufrufe auszuführen und Ihr Spiel zu erstellen.

Eine Liste aller verfügbaren Client-API-Aufrufe finden Sie in unserer Dokumentation zu PlayFab-API-Referenzen .

Dekonstruieren des Codes

In diesem Abschnitt werden die einzelnen Teile des Node-Schnellstartcodes ausführlich erläutert.

Für das Node SDK werden die Funktionen in PlayFabClientSDK nach der HTTP-Anforderung benannt. Beispielsweise wird die entsprechende HTTP-Anforderung für die LoginWithCustomID Funktion auch als "LoginWithCustomID" bezeichnet. Die Anforderungsheader und der Anforderungstext werden als Schlüssel und Werte in das JavaScript-Anforderungsobjekt gepackt.

Zeilen-für-Zeilen-Aufschlüsselung für GettingStarted.js
- PlayFab.settings.titleId = "xxxx";
  - Jeder PlayFab-Entwickler erstellt einen Titel in Game Manager. Wenn Sie Ihr Spiel veröffentlichen, müssen Sie diese TitleId in Ihr Spiel codieren. Dadurch kann der Client wissen, wie auf die richtigen Daten in PlayFab zugegriffen werden kann. Für die meisten Benutzer ist es nur ein obligatorischer Schritt, der PlayFab funktioniert.
- var loginRequest = { TitleId: PlayFab.settings.titleId, CustomId: "GettingStartedGuide", CreateAccount: true };
  - Die meisten PlayFab-API-Methoden erfordern Eingabeparameter, und diese Eingabeparameter werden in ein Anforderungsobjekt gepackt.
  - Jede API-Methode erfordert ein eindeutiges Anforderungsobjekt mit einer Mischung aus optionalen und obligatorischen Parametern.
    - Für LoginWithCustomIDRequestgibt es einen obligatorischen Parameter von , der CustomIdeinen Spieler eindeutig identifiziert, und CreateAccount, der die Erstellung eines neuen Kontos mit diesem Aufruf ermöglicht. TitleId ist ein weiterer obligatorischer Parameter in JavaScript und muss mit übereinstimmen PlayFab.settings.titleId.
    - Informationen dazu, wo Sie finden TitleId, finden Sie unter Game Manager-Schnellstart.
In diesem Fall TitleIdstammen , customIdund CreateAccount aus dem Anforderungstext von LoginWithCustomID.
- PlayFabClientSDK.LoginWithCustomID(loginRequest, LoginCallback);
  - Dadurch wird die asynchrone Anforderung an LoginWithCustomIDgestartet, die LoginCallback aufruft, wenn der API-Aufruf abgeschlossen ist.
- Für die Anmeldung sollten die meisten Entwickler eine geeignetere Anmeldemethode verwenden.
  - Eine Liste aller Anmeldemethoden und Eingabeparameter finden Sie in der Dokumentation zur PlayFab-Anmeldung . Häufig sind folgende Optionen verfügbar:
LoginCallback enthält zwei Parameter: error und result.
- Wenn dies erfolgreich ist, error ist null, und das result -Objekt enthält die angeforderten Informationen gemäß der aufgerufenen API.
  - Dies result enthält einige grundlegende Informationen zum Spieler, aber für die meisten Benutzer ist die Anmeldung einfach ein obligatorischer Schritt vor dem Aufrufen anderer APIs.
Wenn der Fehler nicht nulllautet, ist für Ihre API ein Fehler aufgetreten.

Problembehandlung

API-Aufrufe können aus vielen Gründen fehlschlagen, und Sie sollten immer versuchen, Fehler zu behandeln.
Das Error-Objekt enthält den Fehlernamen, den Fehlercode und die Fehlermeldung. Zusammen sollten diese Informationen ausreichen, um Ihren Fehler zu diagnostizieren.
Warum API-Aufrufe fehlschlagen (In der Reihenfolge der Wahrscheinlichkeit):
- PlayFabSettings.TitleId ist nicht festgelegt. Wenn Sie vergessen, auf Ihren Titel festzulegen TitleId , funktioniert nichts.
- Anforderungsparameter. Wenn Sie nicht die richtigen oder erforderlichen Informationen für einen bestimmten API-Aufruf angegeben haben, tritt ein Fehler auf. Weitere Informationen finden Sie unter error.errorMessage, error.errorDetailsoder error.GenerateErrorReport() .
- Gerätekonnektivitätsproblem. Mobiltelefone verlieren ständig die Konnektivität bzw. erhalten sie wieder, sodass jeder API-Aufruf zu einem beliebigen Zeitpunkt nach dem Zufallsprinzip fehlschlagen kann und dann sofort danach funktioniert. Wenn Sie in einen Tunnel gehen, können Sie vollständig getrennt werden.
- PlayFab-Serverproblem. Wie bei der gesamten Software kann es Probleme geben. Informationen zu Updates finden Sie in unseren Versionshinweisen .
Das Internet ist nicht 100% zuverlässig. Manchmal ist die Nachricht beschädigt oder kann den PlayFab-Server nicht erreichen.
- Fehlercodes für globale API-Methoden finden Sie unter Fehlercodes für globale API-Methoden.
- Wenn Sie Probleme beim Debuggen eines Problems haben und die Informationen in den Fehlerinformationen nicht ausreichen, besuchen Sie uns bitte in unseren Foren.

Weitere Schritte

In dieser Schnellstartanleitung wird ein vereinfachtes Verfahren zum Authentifizieren eines Benutzers veranschaulicht. Weitere Informationen zur Benutzerauthentifizierung finden Sie unter Anmeldegrundlagen und bewährte Methoden.

Wir wünschen viel Vergnügen bei der Codeerstellung!

Freigeben über