アクティビティを更新する

[アーティクル]
05/09/2023

特定のタイトルをプレイしているユーザーのアクティビティを設定または更新します。この API を使用すると、ゲームクライアントまたはサーバーは、特定のタイトルをプレイするユーザーのマルチプレイヤーアクティビティを設定/更新できます。ユーザーがマルチプレイヤーアクティビティでアクティブになるとすぐに、アクティビティを設定する必要があります。 Xbox Live ユーザーは、他のユーザー (通常はフレンド) のアクティビティの変更をサブスクライブでき、これらの更新は RTA を介して Xbox クライアントにプッシュされます。

PUT /titles/{titleId}/users/{xuid}/activities

URI パラメーター

パラメーター	受信	必須	種類	説明
titleId	path	TRUE	integer	要求が送信されるゲームの titleId。
xuid	path	TRUE	文字列	現在の要求で参照されているユーザーの XUID。 XUID は、基数 10 の整数として表されます。

要求ヘッダー

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

リクエストの本文

名前	必須	種類	説明
connectionString	TRUE	文字列	接続文字列は、ゲームに参加するために接続しているクライアントに渡されるオブジェクトです。接続文字列には通常、参加しているユーザーが接続できるようにするためのサーバー IP などの情報が含まれています。接続文字列の長さは 512 文字に制限されています。
joinRestriction	TRUE	JoinRestriction	現在のプレイヤーに誰が参加できるかを決める設定。
sequenceNumber	TRUE	文字列	これは、クライアントが要求ごとに渡す必要のある単調に増加する数 (ulong) の文字列表現です。これは、アクティビティの更新の順序を保証するために使用されます。 sequenceNumber の良い例は、増加することが保証されているため、クライアントの UNIX 時間です。 0 より大きくする必要があり、最大 ulong より大きくすることはできません。
currentPlayers		integer	マルチプレイヤーアクティビティでユーザーが既にプレイしているプレイヤーの数。
groupId		文字列	同じゲームの一部としてプレイしているすべてのユーザーをグループ化するための一意の識別子。
maxPlayers		integer	現在のアクティビティでこのプレイヤーとプレイできるプレイヤーの最大数。
プラットフォーム		プラットフォーム

応答

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

ErrorResponse

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

JoinRestriction

現在のプレイヤーに誰が参加できるかを決める設定。

名前	種類	説明
Followed	文字列
InviteOnly	文字列
[Public]	文字列

プラットフォーム

名前	種類	説明
Android	文字列
IOS	文字列
Nintendo	文字列
PlayStation	文字列
Scarlett	文字列
Win32	文字列
WindowsOneCore	文字列
XboxOne	文字列

SetActivityRequest

アクティビティのプラットフォームが要求内で設定されている場合、そのプラットフォームでのみ参加できます。プラットフォームが設定されていない場合、ゲームをプレイできるすべてのプラットフォームでアクティビティに参加できます。

名前	種類	説明
connectionString	文字列	接続文字列は、ゲームに参加するために接続しているクライアントに渡されるオブジェクトです。接続文字列には通常、参加しているユーザーが接続できるようにするためのサーバー IP などの情報が含まれています。接続文字列の長さは 512 文字に制限されています。
currentPlayers	integer	マルチプレイヤーアクティビティでユーザーが既にプレイしているプレイヤーの数。
groupId	文字列	同じゲームの一部としてプレイしているすべてのユーザーをグループ化するための一意の識別子。
joinRestriction	JoinRestriction	現在のプレイヤーに誰が参加できるかを決める設定。
maxPlayers	integer	現在のアクティビティでこのプレイヤーとプレイできるプレイヤーの最大数。
プラットフォーム	プラットフォーム
sequenceNumber	文字列	これは、クライアントが要求ごとに渡す必要のある単調に増加する数 (ulong) の文字列表現です。これは、アクティビティの更新の順序を保証するために使用されます。 sequenceNumber の良い例は、増加することが保証されているため、クライアントの UNIX 時間です。 0 より大きくする必要があり、最大 ulong より大きくすることはできません。

ThrottledEntity

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

次の方法で共有