指定されたユーザーに現在関連付けられているインベントリのセットを呼び出し元に返します。
これらの URI のドメインは inventory.xboxlive.com です。
解説
この呼び出しの一環として、ポリシーのチェック、実施、またはフィルター処理は実行されません。 呼び出し元は、返される結果の範囲を限定するために、クエリ パラメーターを渡すことができます。
呼び出し元は、次のように、以前の応答を介して提供された継続トークンを使用して、結果間をページ移動することができます: /users/me/inventory?continuationToken=continuationTokenString。
呼び出し元は、特定の項目に関する情報を確認するために、特定の項目の URL を使用して詳細 API を呼び出すこともできます。
クエリ文字列パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| availability | 文字列 | 返す項目の現在の利用可能性。 既定値は "Available" です。現在の日付が開始日と終了日の間にある項目が返されます。 その他の値には "All" と "Unavailable" が含まれます。"All" はすべての項目を返します。"Unavailable" は、現在の日付が開始日と終了日の間にないため使用できなくなっている項目を返します。 |
| container | 文字列 | オプション。 値をゲームのプロダクト ID に設定した場合、インベントリーからの結果にはゲームに関連するアイテムのみが含まれるようになります。 これは、サーバーからインベントリーを呼び出して、結果を特定のゲームのプロダクトにフィルタリングする場合に特に役立ちます。 |
| expandSatisfyingEntitlements | 文字列 | 応答の返された結果内に、ユーザーが持つすべての十分な資格が含まれているかどうかを示すフラグ。 既定値は "false" です。 このパラメーターが値 "true" を指定して使用されると、十分な資格を通してユーザーに付与された、バンドルされた項目などの任意の製品、Xbox One に移行された Xbox 360 での購入品、メンバーシップの特典などが結果に追加されます。 この値が "false" の場合、結果では、バンドルの ProductID などの親項目だけが返されて、含まれる項目それぞれは返されません。 注: "true" の値を指定してこのパラメーターを使用することは、URI に itemType パラメーターが 含まれていない場合にのみ可能です。それ以外の場合、HTTP 400 エラーが返されます。 |
| productIds | 文字列 | ユーザーのインベントリから取得する ProductIds の "," で区切られたコレクション。 指定した ProductID がユーザーのインベントリー結果内にない場合、その項目は API 呼び出しの結果には表示されません。 expandSatisfyingEntitlements パラメーターを true に設定してバンドルの productID を渡した場合、呼び出しの結果では (クエリ文字列でバンドルの ProductID を指定したかどうかにかかわらず)、そのバンドルに含まれるすべての項目が返されます。 |
| state | 文字列 | 返す項目の状態。 既定値は "all" です。すべての項目が返されます。 その他の値は "Enabled"、"Suspended"、"Expired"、"Cancelled"、"Renewed" です。"Enabled" は有効な項目のみが返されることを示します。"Suspended" は一時停止中の項目のみが返されることを示します。"Expired" は有効期限が切れている項目のみが返されることを示します。"Cancelled" は取り消された項目のみが返されることを示します。"Renewed" は更新された項目のみが返されることを示します。 |
これらに加えて、このリソースでは標準的なページング方法もサポートされています。
サンプル要求
この URI メソッドの完全修飾ドメイン名は https://inventory.xboxlive.com/users/me/inventory.
注:
考慮されるユーザーは指定されるトークンによって異なり、トークンには複数のユーザーが含まれることがあります。 1 人のユーザーのインベントリが必要な場合は、限定的に考慮する特定ユーザーのユーザー ハッシュも指定する必要があります。
.
応答の本文
呼び出しが成功した場合、サービスはインベントリ項目の配列を返します。 「inventoryItem (JSON)」を参照してください。
サンプル応答
{
"pagingInfo": {
"continuationToken": string,
"totalItems": int
},
"items":
{
"url": string,
"itemType": "Music",
"titleId": string,
"containers": string,
"obtained": DateTime,
"startDate": DateTime,
"endDate": DateTime,
"state": "Enabled"
}