您可以通過訪問創作者商店 API 在 Studio 之外搜索 Roblox 的資產。使用 創作者商店 API 查詢 Studio 資產,例如網格、模型和音訊,還有使用 市場 API 查詢市場上的角色資產。
每個 API 都需要一個 URL 和具體目錄的自訂搜索參數。如果 URL 和參數都有效,API 將返回包含您搜索結果的 JSON 格式。
創作者商店 API
有關如何調用創作者商店 API 進行搜索的信息,請參見 Open Cloud 參考 中的工具箱服務。
市場 API
您可以使用以下 URL 查詢市場上的角色物品: https://catalog.roblox.com/v1/search/items/details?[params]
您可以用適當的 查詢參數 替換 [params],以自訂您的搜索。
查詢參數
您可以通過將一系列參數和值附加到 URL 來指定搜索參數,每個參數由 & 分隔。
使用以下參數查詢市場:
| 參數 | 類型 | 選項和值 |
|---|---|---|
| 類別 | byte | 0 = 推薦 1 = 全部 2 = 收藏品 3 = 服裝 4 = 身體部位 5 = 裝備 11 = 配飾 12 = 角色動畫 13 = 社區創作 |
| 創作者類型 | byte | 1 = 用戶 2 = 群組 使用 創作者類型 的查詢還需要 創作者目標 ID 參數。 |
| 創作者目標 ID | long | 根據提供的創作者類型的用戶或群組 ID。 使用 創作者目標 ID 的查詢也需要 創作者類型 參數。 |
| 創作者姓名 | string | 按創作者姓名進行搜索。如果未提供 Enum.CreatorType,則僅搜尋用戶。 |
| 游標 | string | 每個搜索響應包含 nextPageCursor 如果有下一頁和previousPageCursor如果有上一頁。將這些值中的任一個傳遞到下一次查詢的游標參數中,以獲取結果的下一頁或上一頁。如果其他查詢參數保持不變,游標是有效的。 |
| 類型 | byte | 指定搜索的類型。對於過濾類型,建議的方法是匹配目錄頁面的 URL。 1 = 城鎮與城市 2 = 中世紀 3 = 科幻 4 = 格鬥 5 = 恐怖 6 = 海軍 7 = 冒險 8 = 體育 9 = 喜劇 10 = 西部 11 = 軍事 13 = 建築 14 = FPS 15 = RPG |
| 關鍵字 | string | 標準關鍵字搜索。 |
| 限制 | int | 返回的結果數量。當前值限制為 10、28 和 30。 |
| 最大價格 | int | 查詢項目在 Robux 中的最高價格。 |
| 最小價格 | int | 查詢項目在 Robux 中的最低價格。 |
| 排序聚合 | byte | 1 = 過去一天 3 = 過去一週 4 = 過去一個月 5 = 累計 |
| 排序類型 | byte | 0 = 相關性(預設值) 1 = 喜愛數 2 = 銷售 3 = 更新 4 = 價格升序 5 = 價格降序 |
| 子類別 | byte | 0 = 推薦 1 = 全部 2 = 收藏品 3 = 服裝 4 = 身體部位 5 = 裝備 9 = 帽子 10 = 臉部 12 = 襯衫 13 = T恤 14 = 褲子 15 = 頭部 19 = 配飾 20 = 髮型配飾 21 = 臉部配飾 22 = 頸部配飾 23 = 肩膀配飾 24 = 前部配飾 25 = 後部配飾 26 = 腰部配飾 27 = 角色動畫 37 = 套裝 38 = 動畫套裝 39 = 動作動畫 40 = 社區創作 41 = 近戰 42 = 遠程 43 = 爆炸 44 = 增強 45 = 導航 46 = 音樂 47 = 社交 48 = 建築 49 = 交通 54 = 頭部配飾 55 = 經典 T 恤 56 = 經典襯衫 57 = 經典褲子 58 = T 恤配飾 59 = 襯衫配飾 60 = 褲子配飾 61 = 外套配飾 62 = 毛衣配飾 63 = 短褲配飾 64 = 鞋子套裝 65 = 裙子配飾 66 = 動態頭部 |
以下 URL 將在"配飾"中搜索前 10 個 "裝備" 項目,按所有時間 ("排序聚合") 和相關性 ("排序類型") 由 Roblox 創建("創作者目標 ID" 和 "創作者類型"):
https://catalog.roblox.com/v1/search/items/details?Category=11&Subcategory=5&CreatorTargetId=1&CreatorType=User&SortType=0&SortAggregation=5&Limit=10
回應字段
API 回應以 JSON 格式返回。響應在 data 鍵中提供資產詳細信息,使用以下字段:
| 字段 | 描述 |
|---|---|
| 資產類型 | 以下資產類型值之一(僅在項目為資產時返回)。 2 = T恤 8 = 帽子 11 = 襯衫 12 = 褲子 17 = 頭部 18 = 臉部 19 = 裝備 25 = 手臂 26 = 腿 27 = 身體 28 = 右臂 29 = 左臂 30 = 左腿 31 = 右腿 41 = 髮型配飾 42 = 臉部配飾 43 = 項鍊配飾 44 = 肩膀配飾 45 = 前部配飾 46 = 後部配飾 47 = 腰部配飾 48 = 爬行動畫 49 = 死亡動畫 50 = 掉落動畫 51 = 待機動畫 52 = 跳躍動畫 53 = 跑步動畫 54 = 游泳動畫 55 = 走路動畫 56 = 姿勢動畫 61 = 動作動畫 |
| 套裝類型 | 套裝類型 ID(僅在項目為套裝時返回)。可能的值為 身體部位 和 角色動畫。 |
| 創作者名稱 | 創作者的名稱。 |
| 創作者目標 ID | 創作者的 ID。 |
| 創作者類型 | 項目的創作者類型。 |
| 描述 | 項目描述。 |
| 喜愛數量 | 項目的喜愛數量。 |
| 類型 | 項目的類型列表。可能的值包括 所有、教程、恐怖、城鎮與城市、戰爭、搞笑、奇幻、冒險、科幻、海盜、FPS、RPG、運動、忍者 和 西部。 |
| ID | 項目的 ID。 |
| 項目限制 | 項目限制的列表。可能的值包括 滿十三歲、限量唯一、限量 和 Rthro。 |
| 項目狀態 | 項目狀態標誌的列表。可能的值包括 新、優惠、Xbox 獨佔、Amazon 獨佔、Google Play 獨佔、Ios 獨佔 和 優惠計時器。 |
| 項目類型 | 項目的類型。可能的值為 資產 或 套裝。 |
| 最低價格 | 項目的最低轉售價格(僅在項目可轉售時返回)。 |
| 名稱 | 項目的名稱。 |
| 價格 | 項目的標價(當前價格可能與轉售項目有所不同)。 |
| 價格狀態 | 未在售項目的價格狀態。可能的值為 免費、未在售 或 無轉售者。 |
| 購買數量 | 項目的購買數量。 |
| 可消耗單位數量 | 有限唯一項目的可消耗單位數量。 |
以下是單個項目的預期返回輸出示例:
{
"keyword": null,
"previousPageCursor": null,
"nextPageCursor": "2_1_c541d05046b5c1c78a5d386b5e302243",
"data": [
{
"id":527373900,
"itemType":
"Asset",
"assetType":42,
"name":"Ghostly Souls Bandana",
"description":"這條頭巾不能幫助您與鬼魂融合,但至少您會保持時尚。",
"productId":41270974,
"genres":[
"恐怖",
"冒險"
],
"itemStatus":[],
"itemRestrictions":[],
"creatorType":"用戶",
"creatorTargetId":1,
"creatorName":"Roblox",
"price":300,
"favoriteCount":15943,
"offSaleDeadline":null
}
]
}