将当前与提供的用户关联的库存集返回给调用方。
这些 URI 的域是 inventory.xboxlive.com
。
备注
此调用不包含任何策略检查、强制执行或筛选。 调用方可以选择传递查询参数,以便缩小返回结果的范围。
调用方可以使用通过之前响应提供的延续令牌 (/users/me/inventory?continuationToken=continuationTokenString) 来分页浏览结果。
调用方可以使用特定项目 URL 调用详细信息 API,以便查看有关特定项目的信息。
查询字符串参数
参数 | 类型 | 说明 |
---|---|---|
availability | 字符串 | 要返回的项目的当前可用性。 默认为“可用”,将返回当前日期在开始日期和结束日期范围之内的项目。 其他值包括“所有”(将返回所有项目)和“不可用”(将返回当前日期在开始日期和结束日期范围之外的项目,因此该值当前不可用)。 |
container | 字符串 | 可选。 如果你将值设置为游戏的产品 ID,则库存结果仅包含与该游戏相关的项目。 当从服务器调用库存以筛选特定游戏产品的结果时,这尤其有用。 |
expandSatisfyingEntitlements | 字符串 | 一个标志,指示响应是否包含用户在返回的结果中拥有的所有令人满意的权利。 默认值为“false”。 当使用值为“true”的此参数时,通过令人满意的权利(例如捆绑项目、迁移到 Xbox One 的 Xbox 360 购买、订阅权益等)授予用户的任何产品都会添加到结果中。 当值为“false”时,只在结果中返回捆绑包的 ProductID 等父项,而不返回单个包含的项目。 注意:仅当 URI 中不包含 itemType 参数时,才支持使用值为“true”的此参数,否则将收到 HTTP 400 错误。 |
productIds | 字符串 | 你想要专门从用户库存中检索的 ProductId 的集合,以‘,’分隔。 如果用户的库存结果中未提供 ProductID,则该项目将不会显示在 API 调用的结果中。 如果你传入捆绑包的 productID 并将 expandSatisfyingEntitlements 参数设置为 true,则捆绑包中包含的所有项目都会在调用结果中返回(无论你是否在查询字符串中指定其 productId)。 |
state | 字符串 | 要返回的项目的状态。 默认值为“所有”,将返回所有项目。 其他值有“已启用”(表示应只返回已启用的项目)、“已暂停”(表示应只返回已暂停的项目)、“已过期”(表示应只返回已过期的项目)、“已取消”(表示应只返回已取消的项目)以及“已续订”(表示应只返回已续订的项目)。 |
除这些之外,该资源还支持标准分页机制。
示例请求
此 URI 方法的完全限定的域名为 https://inventory.xboxlive.com/users/me/inventory.
注意:
考虑哪些用户取决于所提供的令牌,可能包括多个用户。 如果你想要单个用户的库存,还必须为你想专门考虑的特定用户提供用户哈希。
.
响应正文
如果调用成功,该服务将返回一系列库存项目。 请参阅 inventoryItem (JSON)。
示例响应
{
"pagingInfo": {
"continuationToken": string,
"totalItems": int
},
"items":
{
"url": string,
"itemType": "Music",
"titleId": string,
"containers": string,
"obtained": DateTime,
"startDate": DateTime,
"endDate": DateTime,
"state": "Enabled"
}