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

# GET (/users/xuid({xuid})/achievements)

> GET (/users/xuid({xuid})/achievements)

# GET (/users/xuid({xuid})/achievements)

タイトルで定義された実績、ユーザーが解除した実績、または進行中の実績のリストを取得します。
これらの URI のドメインは `achievements.xboxlive.com` です。

* [URI パラメーター](#ID4EX)
* [クエリ文字列パラメーター](#ID4ECB)
* [認可](#ID4ENF)
* [必須リクエスト ヘッダー](#ID4ESG)
* [任意のリクエスト ヘッダー](#ID4ESH)
* [リクエスト本文](#ID4EIBAC)
* [レスポンス本文](#ID4ETBAC)

## URI パラメーター

| パラメーター | 型 | 説明 |
| - | - | - |
| xuid | 64 ビット符号なし整数 | アクセスされる (リソースの) 対象ユーザーの XBOX User ID (XUID)。認証済みユーザーの XUID と一致している必要があります。 |

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

\| パラメーター| 必須| 型| 説明|
\| --- | --- | --- | --- | --- | --- | --- |
\| **skipItems**| いいえ| 32 ビット符号付き整数| 指定した項目数の後から項目を返します。たとえば、**skipItems="3"** にすると、取得される 4 番目の項目から取得します。 |
\| **continuationToken**| いいえ| string| 指定した継続トークンから始まる項目を返します。 |
\| **maxItems**| いいえ| 32 ビット符号付き整数| コレクションから返される項目の最大数。**skipItems** や **continuationToken** と組み合わせて、項目の範囲を返すことができます。**maxItems** が指定されていない場合、サービスは既定値を提供することがあります。また、最後のページの結果がまだ返されていなくても、**maxItems** より少ない件数を返すことがあります。 |
\| **titleId**| いいえ| string| 返される結果のフィルター。カンマ区切りの 10 進数タイトル識別子を 1 つ以上受け付けます。|
\| **unlockedOnly**| いいえ| Boolean 値| 返される結果のフィルター。**true** に設定した場合、ユーザーが解除した実績のみを返します。既定は **false** です。|
\| **possibleOnly**| いいえ| Boolean 値| 返される結果のフィルター。**true** に設定した場合、可能な結果をすべて返しますが、解除メタデータは返さず、XMS からの実績情報のみを返します。既定は **false** です。|
\| **types**| いいえ| string| 返される結果のフィルター。"Persistent" または "Challenge" を指定できます。既定はサポートされているすべての種類です。|
\| **orderBy**| いいえ| string| 結果を返す順序を指定します。"Unordered"、"Title"、"UnlockTime"、"EndingSoon" のいずれかを指定できます。既定は "Unordered" です。|

## 認可

\| クレーム| 必須?| 説明| 欠落時の動作|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| User| 呼び出し元が認可された XBOX LIVE ユーザーであること。| 呼び出し元は XBOX LIVE 上の有効なユーザーである必要があります。| 403 Forbidden|

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

\| ヘッダー| 型| 説明|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| Authorization| string| HTTP 認証のための認証資格情報。値の例: "XBL3.0 x=\<userhash>;\<token>"。|

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

\| ヘッダー| 型| 説明|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| **X-RequestedServiceVersion**| string| このリクエストを送信する対象の XBOX LIVE サービスのビルド名/番号。ヘッダーの有効性や認証トークン内のクレームなどが検証された後に、リクエストは指定のサービスにルーティングされます。既定値: 1。|
\| **x-xbl-contract-version**| 32 ビット符号なし整数| 存在し、2 に設定されている場合、この API の V2 バージョンが使用されます。それ以外の場合は V1 になります。|
\| **Accept-Language**| string| 希望するロケールおよびフォールバックのリスト (例: fr-FR、fr、en-GB、en-WW、en-US)。Achievements サービスは、一致するローカライズされた文字列が見つかるまでリストを順に処理します。見つからない場合は、ユーザー トークンで定義された場所 (ユーザーの IP アドレスに由来) との一致を試みます。それでも一致するローカライズ文字列が見つからない場合は、タイトルの開発者/発行者が提供する既定の文字列が使用されます。 |

## リクエスト本文

このリクエストの本文にはオブジェクトは送信されません。

## レスポンス本文

呼び出しが成功すると、サービスは [Achievement (JSON)](https://devdocs.xbox.com/ja-jp/reference/live/rest/json/json-achievementv2) オブジェクトの配列と [PagingInfo (JSON)](https://devdocs.xbox.com/ja-jp/reference/live/rest/json/json-paginginfo) オブジェクトを返します。

### サンプル レスポンス

```cpp theme={null}
{
    "achievements":
    [{
        "id":"3",
        "serviceConfigId":"b5dd9daf-0000-0000-0000-000000000000",
        "name":"Default NameString for Microsoft Achievements Sample Achievement 3",
        "titleAssociations":
        [{
                "name":"Microsoft Achievements Sample",
                "id":3051199919,
                "version":"abc"
        }],
        "progressState":"Achieved",
        "progression":
        {
                "achievementState":"Achieved",
                "requirements":null,
                "timeUnlocked":"2013-01-17T03:19:00.3087016Z",
        },
        "mediaAssets":
        [{
                "name":"Icon Name",
                "type":"Icon",
                "url":"http://www.xbox.com"
        }],
        "platform":"D",
        "isSecret":true,
        "description":"Default DescriptionString for Microsoft Achievements Sample Achievement 3",
        "lockedDescription":"Default UnachievedString for Microsoft Achievements Sample Achievement 3",
        "productId":"12345678-1234-1234-1234-123456789012",
        "achievementType":"Challenge",
        "participationType":"Individual",
        "timeWindow":
        {
                "startDate":"2013-02-01T00:00:00Z",
                "endDate":"2100-07-01T00:00:00Z"
        },
        "rewards":
        [{
                "name":null,
                "description":null,
                "value":"10",
                "type":"Gamerscore",
                "valueType":"Int"
        },
        {
                "name":"Default Name for InAppReward for Microsoft Achievements Sample Achievement 3",
                "description":"Default Description for InAppReward for Microsoft Achievements Sample Achievement 3",
                "value":"1",
                "type":"InApp",
                "valueType":"String"
        }],
        "estimatedTime":"06:12:14",
        "deeplink":"aWFtYWRlZXBsaW5r",
        "isRevoked":false
        }],
        "pagingInfo":
        {
                "continuationToken":null,
                "totalRecords":1
        }
}
         
```

## 関連項目

##### 親

[/users/xuid({xuid})/achievements](https://devdocs.xbox.com/ja-jp/reference/live/rest/uri/achievements/uri-achievementsusersxuidachievementsv2)

##### リファレンス

[Achievement (JSON)](https://devdocs.xbox.com/ja-jp/reference/live/rest/json/json-achievementv2)

[PagingInfo (JSON)](https://devdocs.xbox.com/ja-jp/reference/live/rest/json/json-paginginfo)

[ページング パラメーター](https://devdocs.xbox.com/ja-jp/reference/live/rest/additional/pagingparameters)


## Related topics

- [XblAchievementsGetAchievementAsync](https://devdocs.xbox.com/fr/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementasync.md)
- [XblAchievementsGetAchievementsForTitleIdAsync](https://devdocs.xbox.com/zh-TW/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementsfortitleidasync.md)