ポスト サーバー最近遊んだプレイヤー

  • [アーティクル]

最近遊んだプレイヤーのユーザーのリストのセットに追加またはリストのセットを更新します (一方向)。 これは基本的にサーバー用のクライアント API のバッチ API です。

この API を使用すると、ゲーム サーバーは、ユーザーの最近のプレーヤーのリストに追加したり、既存の最近のプレーヤーのエントリを更新したりできます。 各ユーザーの最近のプレーヤー リストは単方向です。

POST /titles/{titleId}/recentplayers/server

URI パラメーター

パラメーター 受信 必須 種類 説明
titleId path TRUE integer 要求の送信先ゲームの titleId。

要求ヘッダー

名前 必須 種類 説明
Authorization TRUE integer 呼び出し元は、XBL 3.0 承認形式内で XToken を提供する必要があります。 たとえば、承認: XBL3.0 x=2553948354698;>暗号化されたトークン<)
Content-Type TRUE 文字列 ContentType は application/json に設定する必要があります

リクエストの本文

名前 必須 種類 説明
recentPlayersByXuid TRUE ServerRecentPlayersByXuid[] XUID とその最近のプレーヤーを表すオブジェクトの配列。 少なくとも 1 つ、最大 20 の XUID ントリが必要です。

応答

名前 種類 説明
204 No Content 最近のプレイヤーのリクエストは正常に送信されました。
400 Bad Request ErrorResponse 要求の処理中にエラーが発生しました。 考えられるエラー コード: "RequestValidationError: 要求の検証に失敗しました。"、"AuthorizationError: 呼び出し元はリソースへのアクセスを許可されていません。"
その他の状態コード ThrottledEntity 要求が多すぎます。 Headers Retry-After: 整数

定義

EncounterType

最近出会ったプレイヤーの種類。 このフィールドはオプションであり、既定値は [既定] です。 [既定] には規定の意味はありません。この値を適切に解釈するのは呼び出し元の責任です。

名前 種類 説明
既定値 文字列
Opponent 文字列
Teammate 文字列

ErrorResponse

名前 種類 説明
debugMessage 文字列 デバッグに使用できる可読版のエラー メッセージ。
errorCode 文字列 エラー コードの列挙型。

ネットワーク

名前 種類 説明
XboxLive 文字列

ServerRecentPlayersByXuid

名前 種類 説明
recentPlayers UnidirectionalRecentPlayer[] このユーザーの最近遊んだプレーヤーの配列。 最近遊んだプレイヤーは少なくとも 1 人、最大 100 人である必要があります。
xuid 文字列 ユーザーの XUID (基数 10 の整数)。

ServerRecentPlayersRequest

名前 種類 説明
recentPlayersByXuid ServerRecentPlayersByXuid[] XUID とその最近のプレーヤーを表すオブジェクトの配列。 少なくとも 1 つ、最大 20 の XUID ントリが必要です。

ThrottledEntity

名前 種類 説明
currentRequests 文字列 現在のリクエスト数 - 同時接続数または割合。
debugMessage 文字列 デバッグに使用できる可読版のスロットル メッセージ。
LimitType 文字列 制限の種類、つまり同時接続数または割合。
maxRequests 文字列 許容される最大リクエスト数 - 同時接続数または割合。
periodInSeconds 文字列 割合または同時接続数の制限を超えたときに適用される秒単位の期間。
version 文字列 現在のスロットル契約バージョン。

UnidirectionalRecentPlayer

名前 種類 説明
encounterType EncounterType 最近出会ったプレイヤーの種類。 このフィールドはオプションであり、既定値は [既定] です。 [既定] には規定の意味はありません。この値を適切に解釈するのは呼び出し元の責任です。
id 文字列 別のユーザーの ID (XUID 基数 10 の整数)。
network Network 他のユーザーが遭遇したネットワーク。
timestamp 文字列