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

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

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

URI パラメーター
クエリ文字列パラメーター
Authorization
必須の要求ヘッダー
省略可能な要求ヘッダー
リクエストの本文
応答の本文

URI パラメーター

パラメーター	型	説明
xuid	64 ビット符号なし整数	アクセスするリソースを持つユーザーの Xbox ユーザー ID (XUID)。認証されたユーザーの XUID と一致する必要があります。

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

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

Authorization

クレーム	必須かどうか	説明	存在しない場合の動作
ユーザー	呼び出し元は、権限がある Xbox LIVE ユーザーです。	呼び出し元は、Xbox LIVE の有効なユーザーである必要があります。	403 Forbidden

必須の要求ヘッダー

ヘッダー	型	説明
Authorization	文字列	HTTP 認証用の認証資格情報。例の値: "XBL3.0 x=<userhash>;<token>"。

省略可能な要求ヘッダー

ヘッダー	型	説明
X-RequestedServiceVersion	文字列	この要求の送信先である Xbox LIVE サービスのビルド名/番号。要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。既定値: 1。
x-xbl-contract-version	32 ビット符号なし整数	存在していて 2 に設定されている場合は、この API の V2 バージョンが使用されます。それ以外の場合は、V1 が使用されます。
Accept-Language	文字列	目的のロケールとフォールバックのリスト (fr-FR、fr、en-GB、en-WW、en-US など)。実績サービスは、一致するローカライズされた文字列が見つかるまでリストを処理します。見つからない場合は、ユーザーの IP アドレスを元に取得した、ユーザーのトークンで定義されている場所との一致を試みます。それでもまだ一致するローカライズされた文字列が見つからない場合は、タイトルのデベロッパー/パブリッシャーによって提供された既定の文字列を使用します。

リクエストの本文

この要求の本体で送信されるオブジェクトはありません。

応答の本文

呼び出しが成功した場合、サービスは Achievement (JSON) オブジェクトの配列および PagingInfo (JSON) オブジェクトを返します。

サンプル応答

{
    "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
        }
}

次の方法で共有