> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET (/users/xuid({xuid})/scids/{scid}/stats/{statname)/people/{all|favorite})

> GET (/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite})

# GET (/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite})

現在のユーザーの既知のすべての連絡先、またはそのユーザーが「お気に入り」として指定した連絡先のみの統計値 (スコア) をランク付けして、ソーシャル ランキングを返します。
これらの URI のドメインは `leaderboards.xboxlive.com` です。

* [備考](#ID4EV)
* [URI パラメーター](#ID4EAB)
* [クエリ文字列パラメーター](#ID4ELB)
* [認可](#ID4EQD)
* [必須リクエスト ヘッダー](#ID4EGE)
* [任意のリクエスト ヘッダー](#ID4EXF)
* [リクエスト本文](#ID4ETG)
* [HTTP ステータス コード](#ID4ECEAC)
* [必須レスポンス ヘッダー](#ID4E1HAC)
* [任意のレスポンス ヘッダー](#ID4EDJAC)
* [レスポンス本文](#ID4EDKAC)

## 備考

ランキング API はすべて読み取り専用であるため、(HTTPS 経由の) GET 動詞のみをサポートします。これらは、Player Data システム経由で書き込まれた個々のユーザー統計から派生した、インデックス付きプレイヤー統計のランク付きかつソート済みの「ページ」を反映します。ランキングのインデックス全体はかなり大きくなる可能性があり、呼び出し元がその全体を要求することは決してありません。そのため、この URI は、呼び出し元がランキングに対してどのようなビューを取得したいかを具体的に指定できるように、複数のクエリ文字列引数をサポートしています。

GET 操作はリソースを変更しないため、1 回実行しても複数回実行しても同じ結果を生成します。

## URI パラメーター

| パラメーター | 型 | 説明 |
| - | - | - |
| xuid | string | ユーザーの識別子。 |
| scid | string | アクセス対象のリソースを含むサービス構成の識別子。 |
| statname | string | アクセス対象のユーザー統計リソースの一意識別子。 |
| all または favorite | enumeration | 現在のユーザーの既知のすべての連絡先の統計値 (スコア) をランク付けするか、そのユーザーが「お気に入り」として指定した連絡先のみをランク付けするかを指定します。 |

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

| パラメーター | 型 | 説明 |
| - | - | - |
| maxItems | 32 ビット符号なし整数 | 結果ページで返すランキング レコードの最大数。指定されない場合、既定値 (10) が返されます。maxItems の最大値はまだ未定義ですが、大きなデータ セットは避けたいため、この値はチューナー UI が 1 回の呼び出しで扱える最大セットを対象とするのが望ましいです。 |
| skipToRank | 32 ビット符号なし整数 | 指定したランキングの順位から始まる結果ページを返します。残りの結果はランクによってソートされた順序で返されます。このクエリ文字列は継続トークンを返すことがあり、続く「次のページ」の結果を取得するために後続のクエリに渡すことができます。 |
| skipToUser | string | 指定した gamer xuid の周辺のランキング結果ページを返します (そのユーザーのランクやスコアに関係なく)。ページは、定義済みビューの場合は指定ユーザーがページの最終位置に、統計ランキング ビューの場合は中央に配置されるように、パーセンタイル ランクで並べられます。この種類のクエリには **continuationToken** は提供されません。 |
| continuationToken | string | 前の呼び出しで **continuationToken** が返された場合、呼び出し元はそのトークンを「そのまま」クエリ文字列に渡して、次のページの結果を取得できます。 |
| sort | string | プレイヤーの一覧を値の小さい順 ("ascending") でランク付けするか、値の大きい順 ("descending") でランク付けするかを指定します。これは省略可能なパラメーターで、既定値は降順です。 |

## 認可

XUID による認可が必要です。

コンテンツの分離とアクセス制御のシナリオに対して認可ロジックが実装されています。

ランキングとユーザー統計は、呼び出し元がリクエストに有効な XSTS トークンを提出する限り、任意のプラットフォームのクライアントから読み取ることができます。書き込みは当然、Player Data システムでサポートされているクライアントに限定されます。

タイトル開発者は パートナー センター で統計を open または restricted に指定できます。ランキングは open 統計です。Open 統計は、ユーザーがサンドボックスへのアクセスを認可されている限り、SmartGlass、iOS、Android、Windows、Windows Phone、Web アプリケーションからアクセスできます。ユーザーのサンドボックスへのアクセス認可は パートナー センター を通じて管理されます。

## 必須リクエスト ヘッダー

| ヘッダー | 説明 |
| - | - |
| Authorization | 文字列。HTTP 認証のための認証資格情報。値の例: "XBL3.0 x=\<userhash>;\<token>"。 |
| Content-Type | 文字列。リクエスト本文の MIME タイプ。値の例: "application/json"。 |
| X-RequestedServiceVersion | このリクエストを送信する対象の XBOX Live サービスのビルド名/番号。ヘッダーの有効性や認証トークン内のクレームなどが検証された後に、リクエストは指定のサービスにルーティングされます。既定値: 1。 |
| Accept | 文字列。受け入れ可能な Content-Type。値の例: "application/json"。 |

## 任意のリクエスト ヘッダー

| ヘッダー | 説明 |
| - | - |
| If-None-Match | 文字列。クライアントがキャッシュをサポートしている場合に使用するエンティティ タグ。値の例: "686897696a7c876b7e"。 |

## リクエスト本文

適切に表示するために、呼び出し元が受け取るデータを理解しやすくするため、各ユーザーの各統計値は、表示すべき形式の文字列として返され、リクエストの accept-language ヘッダーで指定されたロケールに合わせて書式設定されます。また、そのランキングの statname に対して、ローカライズされた「表示名」も返されます。

### 必須メンバー

| メンバー | 型 | 説明 |
| - | - | - |
| **pagingInfo** | section | 任意。ページ内の最後のエントリのランクが totalItems より低い場合に返されます。また、リクエストで skipToUser が指定されている場合も、このセクションは返されません。 |
| continuationToken | string | 必須。必要に応じて、その URI の次のページの結果を取得するために "continuationToken" クエリ パラメーターに戻して指定する値を示します。pagingInfo が返されない場合、取得すべき「次のページ」のデータはありません。 |
| totalItems | 64 ビット符号なし整数 | 必須。ランキングのエントリの合計数。 |
| **leaderboardInfo** | section | 必須。常に返されます。要求されたランキングに関するメタデータが含まれます。 |
| displayName | string | 必須。定義済みランキングのローカライズされた表示名。値の例: "Total flags captured"。 |
| totalCount | string | 必須。ランキングのエントリの合計数。 |
| columns | array | 必須。 |
| displayName | string | 必須。ランキングの列に対応します。 |
| statName | string | 必須。ランキングの列に対応します。 |
| type | string | 必須。ランキングの列に対応します。 |
| **userList** | section | 必須。常に返されます。要求されたランキングの実際のユーザー スコアが含まれます。 |
| gamertag | string | 必須。ランキング エントリのユーザーに対応します。 |
| xuid | 32 ビット符号付き整数 | 必須。ランキング エントリのユーザーに対応します。 |
| percentile | string | 必須。ランキング エントリのユーザーに対応します。 |
| rank | string | 必須。ランキング エントリのユーザーに対応します。 |
| values | array | 必須。コンマ区切りの各値は、ランキングの列に対応します。 |

## HTTP ステータス コード

サービスは、このリソースに対するこのメソッドでのリクエストに応じて、このセクション内のいずれかのステータス コードを返します。XBOX Live Services で使用される標準的な HTTP ステータス コードの完全な一覧については、[標準 HTTP ステータス コード](https://docs.xbox.com/ja-jp/reference/live/rest/additional/httpstatuscodes.md) を参照してください。

| コード | 理由フレーズ | 説明 |
| - | - | - |
| 200 | OK | セッションは正常に取得されました。 |
| 304 | Not Modified | |
| 400 | Bad Request | サービスは形式が正しくないリクエストを解釈できませんでした。通常はパラメーターが無効です。 |
| 401 | Unauthorized | リクエストにはユーザー認証が必要です。 |
| 403 | Forbidden | このユーザーまたはサービスにはリクエストが許可されていません。 |
| 404 | Not Found | 指定されたリソースが見つかりませんでした。 |
| 406 | Not Acceptable | リソースのバージョンはサポートされていません。MVC 層で拒否されるべきです。 |
| 408 | Request Timeout | サービスは形式が正しくないリクエストを解釈できませんでした。通常はパラメーターが無効です。 |

## 必須レスポンス ヘッダー

| ヘッダー | 型 | 説明 |
| - | - | - |
| Content-Type | string | レスポンス本文の MIME タイプ。値の例: "application/json"。 |
| Content-Length | string | レスポンスで送信されるバイト数。値の例: "232"。 |

## 任意のレスポンス ヘッダー

| ヘッダー | 型 | 説明 |
| - | - | - |
| ETag | string | キャッシュ最適化に使用されます。値の例: "686897696a7c876b7e"。 |

## レスポンス本文

ソーシャル ランキングのリクエスト (ページングなし):

`https://leaderboards.xboxlive.com/users/xuid(2533274916402282)/scids/c1ba92a9-0000-0000-0000-000000000000/stats/EnemyDefeats/people/all?sort=descending`

### レスポンス例

```json theme={null}
{
    "pagingInfo": null,
    "leaderboardInfo": {
        "displayName": "Kills",
        "totalCount": 3,
        "columns": [
            {
                "displayName": "Kills",
                "statName": "enemydefeats",
                "type": "integer"
            }
        ]
    },
    "userList": [
        {
            "gamertag":"xxxSniper39",
            "xuid":"1234567890123555",
            "percentile":1.0,
            "rank":1,
            "values": [
                "47"
            ]
        },
        {
            "gamertag":"WarriorSaint",
            "xuid":"2533274916402282",
            "percentile":0.66,
            "rank":2,
            "values": [
                "42"
            ]
        },
        {
            "gamertag":"WhockaWhocka",
            "xuid":"1234567890123666",
            "percentile":0.33,
            "rank":3,
            "values": [
                "12"
            ]
        }
    ]
}

```

## 関連項目

##### 親

[/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite}](https://docs.xbox.com/ja-jp/reference/live/rest/uri/leaderboard/uri-usersxuidscidstatnamepeople.md)


## Related topics

- [/users/xuid({xuid})/scids/{scid}/stats/{statname)/people/{all|favorite}](https://docs.xbox.com/ja-jp/reference/live/rest/uri/leaderboard/uri-usersxuidscidstatnamepeople.md)
- [GET (/users/xuid({xuid})/scids/{scid}/stats)](https://docs.xbox.com/ja-jp/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsget.md)
- [GET (/users/xuid({xuid})/scids/{scid}/stats?include=valuemetadata)](https://docs.xbox.com/ja-jp/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsgetvaluemetadata.md)
- [/users/xuid({xuid})/scids/{scid}/stats](https://docs.xbox.com/ja-jp/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstats.md)
- [GET (/users/xuid({xuid})/achievements/{scid}/{achievementid})](https://docs.xbox.com/ja-jp/reference/live/rest/uri/achievements/uri-usersxuidachievementsscidachievementidget.md)
