用户库存

Inventory API 允许您访问 Roblox 我的库存 页面上的大多数相同的信息。您可以检查用户是否拥有个人物品，并恢复玩家拥有的物品列表。

从 库存 API 回应包含以下类别中的物品：

• 服装 (饰品、裤子、经典服装、鞋子、衬衫)
• 购买和奖励（徽章、通行证、购买地点、私人服务器）
• 虚拟形象项目（虚拟形象动画、经典头像、表情、面部、头发、头）

在使用库存 API之前，您必须生成 API 钥匙或配置 OAuth 2为您的应App。此页面上的示例使用 API 钥匙。

检查物品所有权

如果要检查用户是否拥有特定物品（例如，限定，徽章，通行游戏通行证或私人服务器），请使用 filter 参数来检查一个或多个 ID 的列表。此代码示例检查三个资产 ID：

const https = require('node:https');

const userId = 11111111111;
const hostname = 'apis.roblox.com';
const path = `/cloud/v2/users/${userId}/inventory-items`;
const params = '?filter=assetIds=62724852,1028595,4773588762';

const url = 'https://' + hostname + path + params;

const apiKey = '123456789012345678901234567890123456789012345678';

const options = {
  headers: {
    'x-api-key': `${apiKey}`,
  },
};

https
  .get(url, options, (response) => {
    console.log('statusCode:', response.statusCode);
    let data = '';
    response.on('data', (d) => {
      data += d;
    });
    response.on('end', () => {
      if (response.statusCode === 200) {
        const jsonData = JSON.parse(data);
        console.log('Response Data:', JSON.stringify(jsonData, null, 2));
      } else {
        console.error('Error:', response.statusCode, response.statusMessage);
      }
    });
  })
  .on('error', (e) => {
    console.error(e);
  });

以下回应表示用户拥有三件物品之一：

{
  "inventoryItems": [
    {
      "path": "users/11111111111/inventory-items/VVNFUl9BU1NFVF9JRD0yMDAxMDUxMTkzODg",
      "assetDetails": {
        "assetId": "1028595",
        "inventoryItemAssetType": "CLASSIC_TSHIRT",
        "instanceId": "200105119388"
      }
    }
  ],
  "nextPageToken": ""
}

过滤项目

如果您想要显示，例如，仅显示用户拥有的收藏品，请使用上述代码，只是用不同的 filter 参数。

const params = '?filter=onlyCollectibles=true;inventoryItemAssetTypes=*';

使用分号分开的列表混合和匹配过滤器。 这里有几个例子：

filter=onlyCollectibles=true;inventoryItemAssetTypes=HAT,CLASSIC_PANTS

filter=badgeIds=111111,222222;gamePassIds=777777;privateServerIds=999999

filter=gamePasses=true;badges=true

大多数 API 调用不需要任何特定权限，但几个过滤器需要 Inventory 读取权限。有关更多信息，请参阅过滤器。

结果页

如果响应包含 nextPageToken 的值，请在 pageToken 参数的下一个请求中使用该值。有关更多信息，请参阅页码。

如果结果数是 maxPageSize (例如，您有 50 个结果和一个 maxPageSize 的 25)，您可以遇到一个情况，在您的回应包含一个 nextPageToken 的价值，但使用该代币返回的请求无结果：

GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25&pageToken=cccDDD
{
    "inventoryItems": [],
    "nextPageToken": ""
}

在实现页面在您的App用程序时，最佳实践是检查不仅仅是一个非空的 nextPageToken ，而且还是一个非空的 inventoryItems 数组。