Zum Inhalt

GET /players

Endpunkt: GET /v1/pdapi/players

Auth: Bearer-Token

Berechtigung: REST.Players.Read

Zweck

Listet bekannte Spieler mit Identifikations- und Statusinformationen. Nutze dies, um Spielerauswahlen für Admin-Tools zu bauen.

Pfadparameter

Keine.

Query-Parameter

Keine.

Request-Body

Kein Request-Body.

Antwortschema

Schema der 200-Antwort

Feld Typ Beschreibung
Meta object Anzahlen der Spielerliste.
Players object[] Bekannte Spieler mit Kennungs-, Gilden-, Status- und Positionsinformationen.

Schema des Meta-Objekts:

Feld Typ Beschreibung
PlayerCount integer Anzahl der zurückgegebenen Spielerkonten.
OnlineCount integer Anzahl der zurückgegebenen Spieler, die derzeit online sind.

Schema eines Players[]-Eintrags:

Feld Typ Beschreibung
Name string Aktueller oder gespeicherter Spielername.
IP string IP-Adresse des Spielers oder eine leere Zeichenfolge, wenn nicht verfügbar.
PlayerUID string Von den Palworld-Speicherdaten verwendete Spieler-UID.
UserId string Plattform-Benutzer-ID oder eine leere Zeichenfolge, wenn nicht verfügbar.
GuildName string Gildenname oder eine leere Zeichenfolge, wenn nicht verfügbar.
GuildUUID string Gilden-UUID oder eine Null-GUID, wenn nicht verfügbar.
Status string Gespeicherter Status des Spielerkontos.
WorldLocation object Aktuelle oder zuletzt gespeicherte Weltkoordinaten.
MapLocation object Umgerechnete Kartenkoordinaten.

Schema des Positionsobjekts:

Feld Typ Beschreibung
x number X-Koordinate.
y number Y-Koordinate.
z number Z-Koordinate.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}
HTTP Fehlercode Wann es passiert
401 INVALID_TOKEN Der Authorization-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
403 MISSING_PERMISSION Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.
400 INVALID_JSON Ein Request-Body wurde gesendet, konnte aber nicht als JSON gelesen werden.
400 REQUEST_FAILED Der Game-Thread-Callback hat eine Ausnahme ausgelöst oder ein gemeinsamer Spieler-/Ressourcen-Resolver ist fehlgeschlagen.
500 REQUEST_TIMEOUT Der interne Game-Thread-Callback wurde nicht innerhalb von 5 Sekunden abgeschlossen.
500 PLAYER_MANAGER_UNAVAILABLE Der Server konnte nicht auf den Palworld Player Manager zugreifen.

Beispiele

Alle bekannten Spieler auflisten

GET /v1/pdapi/players

Eine Spielerauswahl im Adminbereich aktualisieren

GET /v1/pdapi/players

Szenarien

  • Eine Auswahlliste der Online- und bekannten Spieler erstellen.
  • Vor dem Aufruf von Belohnungs-, Straf- oder Inventarendpunkten die richtige UserId oder PlayerUID ermitteln.
  • Vor einer Nachricht oder geplanten Wartungswarnung prüfen, wer online ist.