GET (/users/xuid({xuid})/scids/{scid}/stats?include=valuemetadata)
指定されたサービス構成内のユーザーの、指定された統計のリストを、統計値に関連付けられているメタデータを含めて取得します。
これらの URI のドメインは userstats.xboxlive.com です。
解説
?include=valuemetadata クエリ パラメーターを指定すると、レース トラックでタイムを出すのに使用した車種と色など、ユーザー統計値に関連付けられているすべてのメタデータを応答に含めることができます。
応答に値メタデータを含めるには、要求呼び出しの X-Xbl-Contract-Version ヘッダーの値を 3 に設定する必要もあります。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| xuid | GUID | 代わりにサービス構成にアクセスするユーザーの Xbox ユーザー ID (XUID)。 |
| scid | GUID | アクセス対象のリソースが含まれているサービス構成の ID。 |
クエリ文字列パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| statNames | 文字列 | ユーザー統計名のコンマ区切りのリスト。たとえば、次の URI は、URI に指定されたユーザー ID に代わって 4 つの統計情報が要求されていることをサービスに通知します。{::nomakrdown}https://userstats.xboxlive.com/users/xuid({xuid})/scids/{scid}/stats/wins,kills,kdratio,headshots?include=valuemetadata |
| include=valuemetadata | 文字列 | 応答に、ユーザー統計値に関連付けられている、すべての値メタデータを含めることを示します。 |
Authorization
コンテンツの分離とアクセス制御の各シナリオ用に実装された承認ロジックがあります。
- ランキングとユーザー統計はどちらも、呼び出し元が要求と共に有効な XSTS トークンを送信した場合に、任意のプラットフォームのクライアントから読み取ることができます。 書き込みは、プレイヤー データ システムでサポートされているクライアントに限定されます。
- タイトル開発者は、パートナー センターでオープンまたは制限付きとして統計をマークできます。 ランキングはオープン統計です。 オープン統計には、ユーザーがサンドボックスから承認されている場合に SmartGlass、iOS、Android、Windows、Windows Phone、および Web アプリケーションからアクセスできます。 サンドボックスへのユーザー承認はパートナー センターで管理されます。
チェックの疑似コードは次のようになります。
If (!checkAccess(serviceConfigId, resource, CLAIM[userid, deviceid, titleid]))
{
Reject request as Unauthorized
}
// else accept request.
必須の要求ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Authorization | 文字列 | HTTP 認証用の認証資格情報。 例の値:「XBL3.0 x=<userhash>;<token>」。 |
| X-Xbl-Contract-Version | 文字列 | 使用する API のバージョンを示します。 応答に値メタデータを含めるには、この値を "3" に設定する必要があります。 |
省略可能な要求ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| X-RequestedServiceVersion | この要求の送信先であるサービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。 既定値: 1。 |
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 理由 | 説明 |
|---|---|---|
| 200 | OK | セッションは正常に取得されました。 |
| 304 | 変更なし | リソースは最後の要求以降、変更されていません。 |
| 400 | Bad Request | サービスは無効な形式の要求を解釈できませんでした。 通常は、無効なパラメーターです。 |
| 401 | 未承認 | 要求にはユーザー認証が必要です。 |
| 403 | Forbidden | ユーザーまたはサービスに対して要求が許可されていません。 |
| 404 | Not Found | 指定されたリソースが見つかりませんでした。 |
| 406 | Not Acceptable | リソースのバージョンがサポートされていません。 |
| 408 | Request Timeout | リソースのバージョンがサポートされていません。MVC レイヤーによって拒否されます。 |
応答の本文
サンプル応答
{
"user": {
"xuid": "123456789",
"gamertag": "WarriorSaint",
"stats": [
{
"statname": "Wins",
"type": "Integer",
"value": 40,
"valuemetadata" : "{\"region\" : \"EU\", \"isRanked\" : true}"
},
{
"statname": "Kills",
"type": "Integer",
"value": 700,
"valuemetadata" : "{\"longestKillStreak" : 15, \"favoriteTarget\" : \"CrazyPigeon\"}"
},
{
"statname": "KDRatio",
"type": "Double",
"value": 2.23,
"valuemetadata" : "{\"totalKills\" : 700, \"totalDeaths\" : 314}"
},
{
"statname": "Headshots",
"type": "Integer",
"value": 173,
"valuemetadata" : ""
}
],
}
}