GET (/serviceconfigs/{scid}/hoppers/{name}/stats)
ホッパーの統計情報を取得します。
重要:
このメソッドは 103 以降のコントラクトで使用するためのもので、すべての要求でヘッダー要素 X-Xbl-Contract-Version: に 103 以降を指定する必要があります。
解説
この HTTP/REST メソッドは、サービス構成 ID (SCID) レベルで、名前付きホッパーから統計情報を取得します。 このメソッドは、Microsoft.Xbox.Services.Matchmaking.MatchmakingService.GetHopperStatisticsAsync API でラップすることができます。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| scid | GUID | セッションのサービス構成 ID (SCID)。 |
| name | 文字列 | ホッパーの名前。 |
Authorization
| 種類 | 必須かどうか | 説明 | 存在しない場合の応答 |
|---|---|---|---|
| XUID (ユーザー ID) | はい | 要求を行うユーザーは、チケットによって参照されるチケット セッションのメンバーである必要があります。 | 403 |
| 特権およびデバイス タイプ | ○ | ユーザーの deviceType が本体に設定されている場合、要求にマルチプレイヤー権限を持つユーザーだけがマッチメイキング サービスを呼び出せます。 | 403 |
| タイトル ID/購入証明書/デバイス タイプ | ○ | マッチ対象にするタイトルは、指定されたタイトル クレーム/デバイス タイプの組み合わせのマッチメイキングを許可する必要があります。 | 403 |
HTTP ステータス コード
サービスは、MPSD に適用される HTTP ステータス コードを返します。
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
応答の本文
| メンバー | 種類 | 説明 |
|---|---|---|
| hopperName | 文字列 | 選択されたホッパーの名前。 |
| waitTime | 32 ビット符号付き整数 | ホッパーの平均マッチング時間 (秒数を表す整数値)。 |
| population | 32 ビット符号付き整数 | ホッパー内のマッチを待機しているユーザー数。 |
サンプル応答
{
"hopperName":"contosoawesome2",
"waitTime":30,
"population":1
}