*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

InventoryItem

ユーザーのインベント持ち物リストにアイテムを表現します。

属性

pathstring

インベントリアイテムのリソースパス。

形式: users/{user_id}/inventory-items/{inventory_item_id}.

以下のうちの一つの details:

assetDetailsobject

このアイテムがアセットの場合、満たされます。.

badgeDetailsobject

このアイテムがバッジである場合、満たされます。.

gamePassDetailsobject

このアイテムがゲームパスである場合、満たされます。.

privateServerDetailsobject

このアイテムがプライベートサーバーの場合、満たされます。.

addTimestring
出力のみ

アイテムがユーザーのインベントリに追加された時間。たとえば、ユーザーがプライベートサーバーを購入した時や、バッジを授与された時などです。

このフィールドは現在、パスには満たされていません。. この文字列は Timestamp としてフォーマットされています。

ベース URL

https://apis.roblox.com
InventoryItem リソース

{
"path": "users/123/inventory-items/some-inventory-item-id",
"assetDetails": {
"assetId": "12928981934",
"inventoryItemAssetType": "INVENTORY_ITEM_ASSET_TYPE_UNSPECIFIED",
"instanceId": "173413781720",
"collectibleDetails": {
"itemId": "521cca19-75bb-4e05-a0af-633b1532c24d",
"instanceId": "a8a27d38-ee51-4cf4-8b0a-485d0dfd8607",
"instanceState": "COLLECTIBLE_ITEM_INSTANCE_STATE_UNSPECIFIED",
"serialNumber": 160
}
},
"addTime": "2023-07-05T12:34:56Z"
}

InventoryItem

List Inventory Items
ベータ版

GET /cloud/v2/users/{user_id}/inventory-items

ユーザーのインベントリのインベントリアイテムをリストします。

返されたインベントリアイテムは、ターゲットユーザーの 設定 > プライバシー > 私のインベントリを見ることができる人 の選択によります:

  • ユーザーが「誰も」にインベントリの可視性を付与した場合、どのスコープを持っているか、または誰が作成したかに関係なく、APIキーまたは OAuth2 トークンを使用してターゲットのインベントリを表示できます。
  • ユーザーが「誰も」に在庫の可視性を付与していない場合:
    • ターゲットユーザーによって作成された API キーで インベントリ: 読み込み 権限を持つ目的のインベントリをまだ見ることができます。
    • ターゲットユーザーが user.inventory-item:read スコープの権限をリクエストするアプリを許可する場合、OAuth2 トークンでインベントリを表示できます。

レート制限:

  • API キー - API キー所有者ごとに 100 リクエスト/分 (ユーザーまたはグループが可能)。オーナーの API キー全体でレート制限が適用されます。
  • OAuth2 トークン - OAuth2 アクセストークンごとに 20 リクエスト/分
リクエストパスのパラメータ
user_idstring
必須

ユーザーID。.

クエリのパラメータ
maxPageSizenumber

返すインベントリアイテムの最大数。サービスはこの値より少なく返す可能性があります。指定されない場合、最大 10の在庫アイテムが返されます。最大値は 100 で、より高い値は 100 に設定されます。.

pageTokenstring

前の呼び出しから受信したページトークンで、後のページを取得します。

ページをページングするとき、次の呼び出しに提供された他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。.

filterstring

このフィールドは、返された資源をフィルタするために設定できます。

詳しくは、フィルタリング ドキュメントを参照してください。.

レスポンス

親コレクションのインベントリアイテムのリスト。

inventoryItemsarray<InventoryItem>

指定されたユーザからのインベントリアイテム。.

nextPageTokenstring

次のページを取得するための pageToken パラメータとして送信できるトークン。このフィールドが省略されると、後続のページはありません。.

GET /cloud/v2/users/{user_id}/inventory-items

curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}/inventory-items?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
レスポンス

{
"inventoryItems": [
{
"path": "users/123/inventory-items/some-inventory-item-id",
"assetDetails": {
"assetId": "12928981934",
"inventoryItemAssetType": "INVENTORY_ITEM_ASSET_TYPE_UNSPECIFIED",
"instanceId": "173413781720",
"collectibleDetails": {
"itemId": "521cca19-75bb-4e05-a0af-633b1532c24d",
"instanceId": "a8a27d38-ee51-4cf4-8b0a-485d0dfd8607",
"instanceState": "COLLECTIBLE_ITEM_INSTANCE_STATE_UNSPECIFIED",
"serialNumber": 160
}
},
"addTime": "2023-07-05T12:34:56Z"
}
],
"nextPageToken": "string"
}