Python-Schnellstart

Artikel
07/11/2023

Diese Schnellstartanleitung soll Ihnen helfen, Ihren ersten API-Aufruf in Python 3 zu tätigen.

Ein natives Python-Projekt kann auf verschiedene Arten verwendet werden:

Als eigenständige Konsole Admin Tool zur Wartung Ihres Spiels.
Integration in eine vorhandene Python-basierte Spiel-Engine.
- Eine Liste der Python-Spiele-Engines finden Sie auf der python.org-Website unter PythonGameLibraries .

Voraussetzungen

Ein PlayFab-Entwicklerkonto.
Python 3 ist auf Ihrem System installiert.
- Außerdem muss das Anforderungsmodul installiert sein.

Notiz

Diese Betaversion des Python SDK unterstützt nur synchrone API-Aufrufe, und Ihre Spielschleife wird möglicherweise blockiert, wenn PlayFab-API-Aufrufe ausgeführt werden. Möglicherweise müssen Sie ein eigenes asynchrones/Threadingmodell erstellen, um dieses Problem zu vermeiden.

Wenn Sie Probleme beim Debuggen eines Problems haben und die bereitgestellten Informationen nicht ausreichen, besuchen Sie uns bitte in unseren PlayFab-Foren.

Python-Projekteinrichtung

Installieren Sie über eine Eingabeaufforderung das PlayFab-Paket mit dem folgenden Befehl.

pip install playfab

Wenn pip sich nicht in Ihrem Pfad befindet, verwenden Sie stattdessen den folgenden Befehl.

python -m pip install playfab

Erstellen Sie in Ihrem Projektverzeichnis ein Python-Skript namens playfab_test.py.

Einrichten Ihres ersten API-Aufrufs

Diese Schnellstartanleitung enthält die minimalen Schritte, um Ihren ersten PlayFab-API-Aufruf ohne GUI oder Feedback auf dem Bildschirm auszuführen. Die Bestätigung erfolgt mit einer Konsolendrucksanweisung.

Ersetzen Sie den Inhalt Ihrer playfab_test.py-Datei durch den unten gezeigten Inhalt.

from playfab import PlayFabClientAPI, PlayFabSettings

PlayFabSettings.TitleId = "144"

request = {
    "CustomId": "GettingStartedGuide",
    "CreateAccount": True
}

def callback(success, failure):
    if success:
        print("Congratulations, you made your first successful API call!")
    else:
        print("Something went wrong with your first API call.  :(")
        if failure:
            print("Here's some debug information:")
            print(failure.GenerateErrorReport())
PlayFabClientAPI.LoginWithCustomID(request, callback)

Fertig stellen und ausführen

Führen Sie das Python-Skript mit dem unten gezeigten Befehl aus.

python playfab_test.py

Nach Abschluss sollte der folgende Text angezeigt werden: "Herzlichen Glückwunsch, Sie haben Ihren ersten erfolgreichen API-Aufruf durchgeführt!"

An diesem Punkt 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 .

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

Dekonstruieren des Codes

In diesem optionalen letzten Abschnitt werden die einzelnen Teile von playfab_test.py ausführlich beschrieben.

Einfuhren
- Mit den PlayFab-Importen erhalten Sie Zugriff auf die APIs.
PlayFabSettings.TitleId = "144"
- 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.
Anfrage
- Die meisten PlayFab-API-Methoden erfordern Eingabeparameter, und diese Eingabeparameter werden in ein Wörterbuchobjekt gepackt.
  - LoginWithCustomIDRequest nimmt den obligatorischen Parameter von an, der CustomIdeinen Spieler eindeutig identifiziert und das zugeordnete Entitätstoken zurückgibt, und CreateAccount, was die Erstellung eines neuen Kontos mit diesem Aufruf ermöglicht.
  - 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:
Rückruf
- Erfolgreich
  - Wenn der API-Aufruf erfolgreich war, enthält der Erfolg die angeforderten Informationen, und der Fehler ist None.
  - Bei Anmeldeanforderungen enthält der Erfolg grundlegende Informationen zum Spieler, aber für die meisten Benutzer ist die Anmeldung einfach ein obligatorischer Schritt vor dem Aufrufen anderer APIs.
- Fehler
  - Wenn der API-Aufruf nicht erfolgreich war, enthält der Fehler einige Fehlerinformationen, und der Erfolg ist None.
  - API-Aufrufe können aus vielen Gründen fehlschlagen, und Sie sollten immer versuchen, den Fehler zu behandeln.
  - 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.
    - 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.
PlayFabClientAPI.LoginWithCustomID
- Löst den API-Aufruf synchron aus. Nach Abschluss des Vorgangs wird der Rückruf aufgerufen.

Freigeben über