アクティビティ バッチを取得
- [アーティクル]
-
-
ユーザーの一覧のマルチプレイヤー アクティビティのバッチを取得します。
この API は、クライアントやサービスでユーザーの一覧のアクティビティを一括で取得するためのものです。
この API は部分的な結果を返すことができます。任意のユーザーにはそのアクティビティの完全なセットがありますが、一部のユーザーにはアクティビティがまったくない場合もあります。 ユーザーのサブセットのアクティビティが見つかった場合は、それを返します。 アクティビティが見つからなかったユーザーの場合、そのユーザーの空のリストを返します。 内部エラーが発生したためにアクティビティを取得できなかったユーザーの場合は、null を返すため、クライアントは呼び出しをもう一度行う必要があります。 つまり、ユーザーはアクティビティのリスト、空のリスト、または NULL を持つことができます。
POST /titles/{titleId}/activities/query
URI パラメーター
| パラメーター |
受信 |
必須 |
種類 |
説明 |
| titleId |
path |
TRUE |
integer |
要求が送信されるゲームの titleId。 |
リクエストの本文
| 名前 |
必須 |
種類 |
説明 |
| users |
TRUE |
文字列の配列 |
アクティビティ情報を取得する必要があるユーザーの ID。 30 人までのユーザーがサポートされます。 |
| 名前 |
必須 |
種類 |
説明 |
| Authorization |
TRUE |
integer |
呼び出し元は、XBL 3.0 承認形式内で XToken を提供する必要があります。 たとえば、承認: XBL3.0 x=2553948354698;>暗号化されたトークン<) |
| Content-Type |
TRUE |
文字列 |
ContentType は application/json に設定する必要があります |
応答
| 名前 |
種類 |
説明 |
| 200 OK |
GetActivityBatchResponse |
戻り値のオブジェクトには、各ユーザーのアクティビティの一覧が含まれます。 ユーザーに現在アクティビティがない場合、そのユーザーのアクティビティ リストは空になります。 ユーザーのアクティビティを取得するサービスに問題が発生した場合、そのユーザーのアクティビティの一覧は nul lになります。 |
| 400 Bad Request |
ErrorResponse |
要求の処理中にエラーが発生しました。 考えられるエラー コード: "InvalidRequest - 要求のペイロードが無効です。"、"AuthorizationError: 呼び出し元はリソースへのアクセスを許可されていません。" |
| その他の状態コード |
ThrottledEntity |
要求が多すぎます。 Headers Retry-After: 整数 |
定義
ErrorResponse
| 名前 |
種類 |
説明 |
| debugMessage |
文字列 |
デバッグに使用できる可読版のエラー メッセージ。 |
| errorCode |
文字列 |
エラー コードの列挙型。 |
GetActivityBatchRequest
| 名前 |
種類 |
説明 |
| users |
文字列の配列 |
アクティビティ情報を取得する必要があるユーザーの ID。 30 人までのユーザーがサポートされます。 |
GetActivityBatchResponse
GetActivityResponse
| 名前 |
種類 |
説明 |
| connectionString |
文字列 |
接続文字列は、ゲームに参加するために接続しているクライアントに渡されるオブジェクトです。 接続文字列には通常、参加しているユーザーが接続できるようにするためのサーバー IP などの情報が含まれています。 接続文字列の長さは 512 文字に制限されています。 |
| currentPlayers |
integer |
マルチプレイヤー アクティビティでユーザーが既にプレイしているプレイヤーの数。 |
| groupId |
文字列 |
同じゲームの一部としてプレイしているすべてのユーザーをグループ化するための一意の識別子。 |
| joinRestriction |
JoinRestriction |
現在のプレイヤーに誰が参加できるかを決める設定。 |
| maxPlayers |
integer |
現在のアクティビティでこのプレイヤーとプレイできるプレイヤーの最大数。 |
| プラットフォーム |
プラットフォーム |
|
| sequenceNumber |
文字列 |
これは、クライアントが要求ごとに渡す必要のある単調に増加する数 (ulong) の文字列表現です。 これは、アクティビティの更新の順序を保証するために使用されます。 sequenceNumber の良い例は、増加することが保証されているため、クライアントの UNIX 時間です。 0 より大きくする必要があり、最大 ulong より大きくすることはできません。 |
| titleId |
integer |
アクティビティが要求されたゲームの titleId。 |
JoinRestriction
| 名前 |
種類 |
説明 |
| Followed |
文字列 |
|
| InviteOnly |
文字列 |
|
| [Public] |
文字列 |
|
| 名前 |
種類 |
説明 |
| Android |
文字列 |
|
| IOS |
文字列 |
|
| Nintendo |
文字列 |
|
| PlayStation |
文字列 |
|
| Scarlett |
文字列 |
|
| Win32 |
文字列 |
|
| WindowsOneCore |
文字列 |
|
| XboxOne |
文字列 |
|
ThrottledEntity
| 名前 |
種類 |
説明 |
| currentRequests |
文字列 |
現在のリクエスト数 - 同時接続数または割合。 |
| debugMessage |
文字列 |
デバッグに使用できる可読版のスロットル メッセージ。 |
| LimitType |
文字列 |
制限の種類、つまり同時接続数または割合。 |
| maxRequests |
文字列 |
許容される最大リクエスト数 - 同時接続数または割合。 |
| periodInSeconds |
文字列 |
割合または同時接続数の制限を超えたときに適用される秒単位の期間。 |
| version |
文字列 |
現在のスロットル契約バージョン。 |
UserActivity