POST (/handles/query?include=relatedInfo)

関連するセッション情報を含む、セッションハンドルに対するクエリを作成します。

重要:
このメソッドは 2015 Multiplayer で使用され、そのマルチプレイヤーバージョン以降にのみ適用されます。テンプレートコントラクト 104/105 以降での使用を意図しており、すべてのリクエストにヘッダー要素 X-Xbl-Contract-Version: 104/105 以降が必要です。

解説
URI パラメーター
クエリ文字列パラメーター
HTTP ステータスコード
リクエスト本文
レスポンス本文

解説

この HTTP/REST メソッドは、“include” クエリ文字列で指定されたセッション情報を含むハンドルデータに対するクエリを作成します。クエリ文字列の値は、将来のクエリオプションをサポートするために拡張可能に設計されており、たとえば “?include=relatedInfo,session” のようなカンマ区切りリストをサポートします。この POST メソッドは Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForUsersAsync によってラップできます。このメソッドのリクエスト本文の type フィールドは “activity” に設定する必要があります。レスポンス本文の項目は Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails のプロパティに直接マッピングされます。

URI パラメーター

クエリ文字列パラメーター

クエリは、次の表のクエリ文字列パラメーターを使用して変更できます。 | パラメーター| 型| 説明| | --- | --- | --- | --- | | keyword| string| 取得対象のセッションまたはテンプレートに含まれている必要のあるキーワード (例: “foo”)。 | | xuid| 64-bit unsigned integer| クエリに含めるセッションの XBOX ユーザー ID (例: “123”)。既定では、ユーザーがセッションに含まれるためには、そのセッションでアクティブである必要があります。 | | reservations| boolean| ユーザーが予約プレイヤーとして設定されているがアクティブプレイヤーとして参加していないセッションを含めるには true。このパラメーターは、自分自身のセッションを問い合わせる場合、または特定のユーザーのセッションをサーバー間で問い合わせる場合にのみ使用されます。 | | inactive| boolean| ユーザーが承諾しているがアクティブにプレイしていないセッションを含めるには true。ユーザーが “ready” だが “active” でないセッションは非アクティブとしてカウントされます。 | | private| boolean| プライベートセッションを含めるには true。このパラメーターは、自分自身のセッションを問い合わせる場合、または特定のユーザーのセッションをサーバー間で問い合わせる場合にのみ使用されます。 | | visibility| string| セッションの可視性の状態。可能な値は Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility で定義されています。このパラメーターが “open” に設定されている場合、クエリはオープンセッションのみを含める必要があります。“private” に設定されている場合は、private パラメーターを true に設定する必要があります。 | | version| 32-bit signed integer| 含める最大セッションバージョン。たとえば、値 2 は、メジャーセッションバージョンが 2 以下のセッションのみを含めるように指定します。バージョン番号は、リクエストのコントラクトバージョンを 100 で割った剰余以下である必要があります。 | | take| 32-bit signed integer| 取得するセッションの最大数。この数は 0 から 100 の間である必要があります。 | private または reservations のいずれかを true に設定するには、セッションに対するサーバーレベルアクセス権が必要です。あるいは、これらの設定には、呼び出し元の XUID クレームが URI 内の XUID フィルターと一致することが必要です。それ以外の場合、該当するセッションが実際に存在するかどうかにかかわらず、HTTP/403 ステータスコードが返されます。

HTTP ステータスコード

サービスは、MPSD に適用される HTTP ステータスコードを返します。

リクエスト本文

サンプルリクエスト

ユーザーの “favorites” ソーシャルグラフに対するすべてのアクティビティを取得する場合、POST 本文は次のようになります。

{
  "type": "activity",
  "scid": "B5B1F71F-A328-4371-89E0-C3AD222D0E92"  // optional filter on scid
  "owners": {
     "people": {
       "moniker": "favorites",
       "monikerXuid": "3210"
     }
  }
}

レスポンス本文

結果は、それぞれに一意の ID が埋め込まれたハンドル構造体の配列として返されます。特定のセッション情報は relatedInfo オブジェクトで返されます。この情報は、この URI に対する通常の POST メソッドでは返されないことに注意してください。

サンプルレスポンス

{
	"results": [{
		"id": "11111111-ebe0-42da-885f-033860a818f6",
		"type": "activity",
		"version": 1,
		"sessionRef": {
			"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
			"templateName": "party",
			"name": "e3a836aeac6f4cbe9bcab985494d3175"
		},

    "titleId": "1234567",
    "ownerXuid": "3212",

    // Only if ?include=relatedInfo
		"relatedInfo": {
			"visibility": "open",
			"joinRestriction": "followed",
			"closed": true,
			"maxMembersCount": 8,
			"membersCount": 4,
		}
	},
	{
		"id": "11111111-ebe0-42da-885f-033860a818f7",
		"type": "activity",
		"version": 1,
		"sessionRef": {
			"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
			"templateName": "TitleStorageTestDefault",
			"name": "795fcaa7-8377-4281-bd7e-e86c12843632"
		},
    "titleId": "1234567",
    "ownerXuid": "3212",

    // Only if ?include=relatedInfo
		"relatedInfo": {
			"visibility": "open",
			"joinRestriction": "followed",
			"closed": false,
			"maxMembersCount": 8,
			"membersCount": 4,
		}
	}]
}

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

POST (/handles/query?include=relatedInfo)

POST (/handles/query?include=relatedInfo)

解説

URI パラメーター

クエリ文字列パラメーター

HTTP ステータスコード

リクエスト本文

サンプルリクエスト

レスポンス本文

サンプルレスポンス

関連項目

親

​POST (/handles/query?include=relatedInfo)

​解説

​URI パラメーター

​クエリ文字列パラメーター

​HTTP ステータス コード

​リクエスト本文

​サンプル リクエスト

​レスポンス本文

​サンプル レスポンス

​関連項目

親

POST (/handles/query?include=relatedInfo)

解説

URI パラメーター

クエリ文字列パラメーター

HTTP ステータスコード

リクエスト本文

サンプルリクエスト

レスポンス本文

サンプルレスポンス

関連項目