アクティビティを削除する
- [アーティクル]
-
-
特定のタイトルをプレイしているユーザーのアクティビティを削除します。
この API を使用すると、ゲーム クライアントは特定のタイトルをプレイしているユーザーのアクティビティを削除できます。 タイトルは、マルチプレイヤー アクティビティが終了するとすぐに、ユーザーのアクティビティを削除する必要があります。 タイトルがアクティビティの削除に失敗した場合、ユーザーのアクティビティは最終的にプレゼンス チェックによってクリーンアップされる可能性があります。
DELETE /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 に設定する必要があります |
リクエストの本文
| 名前 |
必須 |
種類 |
説明 |
| sequenceNumber |
TRUE |
文字列 |
これは、クライアントが要求ごとに渡す必要のある単調に増加する数 (ulong) の文字列表現です。 これは、アクティビティの更新の順序を保証するために使用されます。 sequenceNumber の良い例は、増加することが保証されているため、クライアントの UNIX 時間です。 0 より大きくする必要があり、最大 ulong より大きくすることはできません。 |
応答
| 名前 |
種類 |
説明 |
| 204 No Content |
|
アイテムが削除されました。 |
| 400 Bad Request |
ErrorResponse |
要求の処理中にエラーが発生しました。 考えられるエラー コード: "RequestValidationError: 要求の検証に失敗しました。"、"AuthorizationError: 呼び出し元はリソースへのアクセスを許可されていません。" |
| その他の状態コード |
ThrottledEntity |
要求が多すぎます。 Headers Retry-After: 整数 |
定義
DeleteActivityRequest
| 名前 |
種類 |
説明 |
| sequenceNumber |
文字列 |
これは、クライアントが要求ごとに渡す必要のある単調に増加する数 (ulong) の文字列表現です。 これは、アクティビティの更新の順序を保証するために使用されます。 sequenceNumber の良い例は、増加することが保証されているため、クライアントの UNIX 時間です。 0 より大きくする必要があり、最大 ulong より大きくすることはできません。 |
ErrorResponse
| 名前 |
種類 |
説明 |
| debugMessage |
文字列 |
デバッグに使用できる可読版のエラー メッセージ。 |
| errorCode |
文字列 |
エラー コードの列挙型。 |
ThrottledEntity
| 名前 |
種類 |
説明 |
| currentRequests |
文字列 |
現在のリクエスト数 - 同時接続数または割合。 |
| debugMessage |
文字列 |
デバッグに使用できる可読版のスロットル メッセージ。 |
| LimitType |
文字列 |
制限の種類、つまり同時接続数または割合。 |
| maxRequests |
文字列 |
許容される最大リクエスト数 - 同時接続数または割合。 |
| periodInSeconds |
文字列 |
割合または同時接続数の制限を超えたときに適用される秒単位の期間。 |
| version |
文字列 |
現在のスロットル契約バージョン。 |