GET /players

エンドポイント: GET /v1/pdapi/players

認証: ベアラートークン

許可: REST.Players.Read

目的

既知のプレーヤーを識別情報とステータス情報とともにリストします。これを使用して、管理ツール用のプレーヤーセレクターを構築します。

なし。

なし。

リクエスト本文がありません。

Field	Type	Description
`Meta`	object	Player list counts.
`Players`	object[]	Known players with identifying, guild, status, and location information.

Meta object schema:

Field	Type	Description
`PlayerCount`	integer	Number of player accounts returned.
`OnlineCount`	integer	Number of returned players currently online.

Players[] item schema:

Field	Type	Description
`Name`	string	Current or saved player name.
`IP`	string	Player IP address, or an empty string when unavailable.
`PlayerUID`	string	Player UID used by Palworld save data.
`UserId`	string	Platform user ID, or an empty string when unavailable.
`GuildName`	string	Guild name, or an empty string when unavailable.
`GuildUUID`	string	Guild UUID, or a zero GUID when unavailable.
`Status`	string	Saved player account state.
`WorldLocation`	object	Current or last saved world coordinates.
`MapLocation`	object	Converted map coordinates.

Location object schema:

エラー本体は次の形状を使用します。

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}

HTTP	エラーコード	それが起こったとき
`401`	`INVALID_TOKEN`	`Authorization` ヘッダーが欠落しているか、形式が不正であるか、構成されたベアラートークンと一致しません。
`403`	`MISSING_PERMISSION`	トークンは有効ですが、このエンドポイント権限が含まれていません。
`400`	`INVALID_JSON`	リクエスト本文が指定されましたが、JSON として解析できませんでした。
`400`	`REQUEST_FAILED`	ゲームスレッドコールバックが例外をスローしたか、共有プレーヤー/リソースリゾルバーが失敗しました。
`500`	`REQUEST_TIMEOUT`	内部ゲームスレッドコールバックは 5 秒以内に完了しませんでした。
`500`	`PLAYER_MANAGER_UNAVAILABLE`	サーバーは Palworld プレーヤーマネージャーにアクセスできませんでした。

GET /v1/pdapi/players

GET /v1/pdapi/players