Robloxのアセットをスタジオの外で検索するには、クリエイター ストア API にアクセスします。クリエイター ストア API を使用して、メッシュ、モデル、オーディオなどのスタジオ アセットをクエリし、マーケットプレイス API を使用してマーケットプレイスのアバター アセットをクエリします。
各 API には、特定のカタログ用の URL とカスタム検索パラメータが必要です。URL とパラメータの両方が有効な場合、API は検索結果を JSON 形式で返します。
クリエイター ストア API
検索のためにクリエイター ストア API を呼び出す方法については、Open Cloud reference の Toolbox Service を参照してください。
マーケットプレイス 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 = グループ CreatorType を使用したクエリは、CreatorTargetId パラメーターも必要です。 |
| クリエイターターゲットID | long | 指定された CreatorType に応じたユーザーまたはグループの ID. CreatorTargetId を使用したクエリは、CreatorType パラメーターも必要です。 |
| クリエイター名 | 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 = 過去1日 3 = 過去1週間 4 = 過去1か月 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 は、Roblox(CreatorTargetId および CreatorType)によって作成された、すべての時間にわたる関連性(SortAggregation および SortType)でソートされた「アクセサリー」の「ギア」アイテムの最初の 10 件を検索します。
応答フィールド
API の応答は JSON 形式で返されます。応答は、次のフィールドを使用して data キーのアセットの詳細を提供します:
| フィールド | 説明 |
|---|---|
| assetType | 以下のアセットタイプのいずれかの値 (アイテムがアセットの場合のみ返されます)。 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 = エモートアニメーション |
| bundleType | バンドルタイプ ID (アイテムがバンドルの場合のみ返されます)。可能な値は BodyParts と AvatarAnimations です。 |
| creatorName | クリエイターの名前。 |
| creatorTargetId | クリエイターの ID。 |
| creatorType | アイテムのクリエイタータイプ。 |
| description | アイテムの説明。 |
| favoriteCount | アイテムのお気に入りのカウント。 |
| genres | アイテムのジャンルのリスト。可能な値には All、Tutorial、Scary、TownAndCity、War、Funny、Fantasy、Adventure、SciFi、Pirate、FPS、RPG、Sports、Ninja、および WildWest が含まれます。 |
| id | アイテムの ID。 |
| itemRestrictions | アイテムの制限のリスト。可能な値には ThirteenPlus、LimitedUnique、Limited、および Rthro が含まれます。 |
| itemStatus | アイテムのステータス フラグのリスト。可能な値には New、Sale、XboxExclusive、AmazonExclusive、GooglePlayExclusive、IosExclusive、および SaleTimer が含まれます。 |
| itemType | アイテムのタイプ。可能な値は Asset または Bundle です。 |
| lowestPrice | アイテムの最低再販価格 (アイテムが再販可能な場合のみ返されます)。 |
| name | アイテム名。 |
| price | アイテムのリスティング価格 (アイテムが再販可能な場合、現在の価格は異なる場合があります)。 |
| priceStatus | 販売されていないアイテムの価格状況。可能な値は Free、OffSale、または NoResellers です。 |
| purchaseCount | アイテムの購入カウント。 |
| unitsAvailableForConsumption | 限定ユニークアイテムの消費可能なユニット。 |
以下は、単一アイテムの予想される返却出力の例です:
{
"keyword": null,
"previousPageCursor": null,
"nextPageCursor": "2_1_c541d05046b5c1c78a5d386b5e302243",
"data": [
{
"id":527373900,
"itemType":
"Asset",
"assetType":42,
"name":"落ち着かない魂のバンダナ",
"description":"このバンダナはあなたを幽霊に溶け込ませることはできませんが、少なくともスタイリッシュです。",
"productId":41270974,
"genres":[
"Scary",
"Adventure"
],
"itemStatus":[],
"itemRestrictions":[],
"creatorType":"User",
"creatorTargetId":1,
"creatorName":"Roblox",
"price":300,
"favoriteCount":15943,
"offSaleDeadline":null
}
]
}