クリエイターストア APIにアクセスして、Studio の外部で Roblox のアセットを検索できます。クリエイターストアAPI を使用して、メッシュ、モデル、オーディオなどのスタジオアセットをクエリーし、マーケットプレイスAPI を使用して、マーケットプレイス上のアバターアセットをクエリーします。
それぞれの API には、特定のカタログに対する URL とカスタム検索パラメータが必要です。両方の URL とパラメータが有効である場合、API はサーチ索結果の JSON 形式を返します。
クリエイターストアAPI
検サーチのためにクリエイターストア APIに電話をかける方法については、オープンクラウドの参照 でツールボックスサービスを参照してください。
マーケットプレイス API
アバターアイテムをマーケットプレイスから以下の URL を使用してクエリーできます: https://catalog.roblox.com/v1/search/items/details?[params]
[params] を適切な クエリパラメータ に置き換えて、検サーチをカスタマイズできます。
クエリパラメータ
URLに一連のパラメータと値を追加して、検索パラメータを指定できます。それぞれ & で区切られます。
マーケットプレイスをクエリーするには、次のパラメータを使用します：
| パラメタ | 種類 | オプションと値 |
|---|---|---|
| カテゴリ | バイト | = 特集 = すべて = コレクション = 服装 = ボディパーツ = ギア > = アバターアニメーション > = コミュニティ作品 > = アバターアニメーション |
| 作成者タイプ | バイト | 1 = ユーザー 2 = グループ |
| クリエイタ名 | 文字列 | クリエーター名で検索。Enum.CreatorType が提供されていない場合、検索はユーザーのみです。 |
| クリエイターターゲットID | 長 | 提供されたクリエイタータイプに応じて、ユーザーまたはグループのID。 |
| カーソル | 文字列 | それぞれの検索応答には、次のページがある場合の nextPageCursor と、前のページがある場合の previousPageCursor が含まれています。次のクエリのカーソルパラメータにこれらの値のいずれかを渡して、結果の次のページまたは前のページを取得します。他のクエリパラメータが同じままである場合、カーソルは有効です。 |
| ジャンル | バイト | 検サーチの種類を指定します。ジャンルでフィルタリングする推奨されるアプローチは、カタログページの URL と一致することです。1 = 町と都市 2 = 中世 3 = SciFi 4 = 戦闘 5 = ホラー 6 = ナビゲーション 7 = アドベンチャー 8 = スポーツ 9 = コメディ 10 = 西洋 11 = 軍事 13 = ビルド 14 = FPS 15 = RPG |
| キーワード | 文字列 | 標準のキーワード検サーチ。 |
| 制限 | 整数 | 返す結果の数。現在、値は 10、28、30 に制限されています。 |
| 最大価格 | 整数 | クエリのアイテムの最大価格 Robux。 |
| 最低価格 | 整数 | クエリのアイテムの最低価格 Robux。 |
| 集計をソート | バイト | 1 = 過去の日 3 = 過去の週 4 = 過去の月 5 = すべての時間 |
| ソートタイプ | バイト | = 関連性 (デフォルト) = お気に入り = 販売 = 更新 = 価格アセント = 価格ディスク = 価格アセントの更新 |
| サブカテゴリ | バイト | Japanese English: Featured = 衣装 = コンテンションのパッケース= コンテンション= コンテント= コンテン= コンテン= コンテン= コンテン= コンテン= コンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテンテン |
次の URL は、すべての時間 ("ソート聚合") と関連性 ("ソートタイプ") によって並べ替えられた「アクセサリ」の最初の 10 個の「ギア」アイテムを検索します：Roblox によって作成された ("CreatorTargetId")：
https://catalog.roblox.com/v1/search/items/details?Category=11&Subcategory=5&CreatorTargetId=1&SortType=0&SortAggregation=5&Limit=10
応答フィールド
API レスポンスは JSON 形式で返されます。レスポンスは次のフィールドを使用してアセットの詳細を提供します: data キー:
| フィールド | 説明 |
|---|---|
| アセットタイプ | 次のアセットタイプ値の 1つ（アイテムがアセットの場合にのみ返されます）: = Tシャツ = 帽子 = シャツ = パンツ = 頭 = 顔 = ギア = アーム = 腰 = 右腕 = 帽子 = ネックアクセサリー = 首アクセリー = ジャンプアニメーション = ジャンプアニメーション = ジャンプアニメーション = スタイルアニメーション = スタイルアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーションアニメーンアニメーションアニメーションアニメーンアニメーンアニメーンアニメーションアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーンアニメーニメーンアニメーニメーニメーンアニメーニメーンアニメーンアニメーニメーンアニメーニメーニメーニメーニメーンアニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニメーニーニメーニメーニメーニメーニメーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーニーンアニーニーニーンアニーンアニーンアニーニーンアニーンアニーンアニーンアニーニーンアニーニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニーンアニー |
| 束型タイプ | バンドルタイプ ID (アイテムがバンドルの場合のみ返されます)。可能な値は BodyParts と AvatarAnimations です。 |
| クリエイター名 | クリエイターの名前。 |
| クリエイターターゲットID | クリエイターの ID。 |
| クリエイタータイプ | アイテムの作成者タイプ。 |
| 詳細明 | アイテムの説詳細。 |
| お気に入り数 | アイテムのお気に入り数。 |
| ジャンル | アイテムのジャンルのリスト。可能な値には、All、Tutorial、Scary、TownAndCity、War、Funny、Fantasy、Adventure、SciFi、Pirate、FPS、RPG、Sports、Ninja、そしてWildWestがあります。 |
| id | アイテムのID。 |
| アイテム制限 | アイテムの制限のリスト。可能な値には ThirteenPlus、LimitedUnique、Limited、および Rthro があります。 |
| アイテムステータス | アイテムのステータスフラグのリスト。可能な値には New , Sale , XboxExclusive , AmazonExclusive , GooglePlayExclusive , IosExclusive , そして SaleTimer があります。 |
| アイテムタイプ | アイテムタイプ。可能な値は Asset または Bundle です。 |
| 最低価格 | アイテムの最低販売価格 (アイテムが販売可能な場合にのみ返却)。 |
| 名前 | アイテム名。 |
| 料金 | アイテムのリスト価格 (現在の価格は、アイテムが再販可能である場合は異なる可能性があります)。 |
| 価格Status | 販売されていないアイテムの価格ステータス。可能な値は Free 、OffSale 、または NoResellers です。 |
| 購入数 | アイテムの購入数。 |
| 使用可能なユニットForConsumption | 限られたユニークなアイテムの消費に使用可能なユニット。 |
次は、単一のアイテムの期待される返却出力の例です：
{
"keyword": null,
"previousPageCursor": null,
"nextPageCursor": "2_1_c541d05046b5c1c78a5d386b5e302243",
"data": [
{
"id":527373900,
"itemType":
"Asset",
"assetType":42,
"name":"Restless Souls Bandana",
"description":"This bandana won't help you blend in with ghosts, but at least you'll be stylish.",
"productId":41270974,
"genres":[
"Scary",
"Adventure"
],
"itemStatus":[],
"itemRestrictions":[],
"creatorType":"User",
"creatorTargetId":1,
"creatorName":"Roblox",
"price":300,
"favoriteCount":15943,
"offSaleDeadline":null
}
]
}