GET (/users/{userId}/profile/settings/people/{userList})
People モニカー サポートを使用して、ユーザーのプロフィールを取得します。
これらの URI のドメインは profile.xboxlive.com
です。
解説
userList と userIds は同時に使用できないパラメーターです。 両方またはどちらか一方が指定されている場合は、BadRequest が返されます。 userList は、要求で複数の名前付きリストを使用できるシナリオを将来的に保証するのための配列です。 userIds は、XUID の 10 進数文字列で構成されます。JSON は 64 ビットの符号なし整数のシリアル化が得意ではありません。 最後に、Xbox One での設定は、64 ビットの符号なし整数や XONLINE_PROFILE_ASDF のようなわかりにくい定数ではなく、人が読んで理解できる普通の名前を使った、名前付きの設定です。
URI パラメーター
パラメーター | 型 | 説明 |
---|---|---|
userId | 文字列 | 'xuid(12345)'、'gt(myGamertag)'、または 'me' を指定できます。 |
userList | 文字列 | 設定を取得するユーザーの名前付きリスト。 現在、サポートされているリストは People のみです。 |
クエリ文字列パラメーター
パラメーター | 型 | 説明 |
---|---|---|
settings | 文字列 | 設定名のコンマ区切りのリスト。 |
必須の要求ヘッダー
ヘッダー | 型 | 説明 |
---|---|---|
x-xbl-contract-version | 32 ビット符号付き整数 | 値 = 2 |
content-type | 文字列 | 値 = application/json |
リクエストの本文
サンプル要求
GET /users/me/profile/settings/people/people?settings=GameDisplayName,GameDisplayPicRaw,Gamerscore,Gamertag
応答の本文
応答は ReadMultiSettingsResponseV2 オブジェクトです。 呼び出し元のユーザーのフレンドは 1 人だけであると想定しています。
{
"profileUsers":[
{
"id":"2533274791381930",
"settings":[
{
"id":"GameDisplayName",
"value":"John Smith"
},
{
"id":"GameDisplayPicRaw",
"value":"http://images-eds.xboxlive.com/image?url=z951ykn43p4FqWbbFvR2Ec.8vbDhj8G2Xe7JngaTToBrrCmIEEXHC9UNrdJ6P7KIN0gxC2r1YECCd3mf2w1FDdmFCpSokJWa2z7xtVrlzOyVSc6pPRdWEXmYtpS2xE4F&format=png&w=64&h=64"
},
{
"id":"Gamerscore",
"value":"0"
},
{
"id":"Gamertag",
"value":"CracklierJewel9"
}
]
}
]
}
関連項目
親
/users/{userId}/profile/settings/people/{userList}?settings={settings}