คุณสามารถค้นหาทรัพย์สินของ Roblox ได้ภายนอก Studio โดยการเข้าถึง Creator Store API ใช้ Creator Store API เพื่อค้นหาทรัพย์สินใน Studio เช่น เมช โมเดล และเสียง และใช้ Marketplace API เพื่อค้นหาทรัพย์สินของอวาตาร์ใน Marketplace
แต่ละ API ต้องการ URL และพารามิเตอร์การค้นหาที่กำหนดเองสำหรับแคตตาล็อกเฉพาะ หากทั้ง URL และพารามิเตอร์ถูกต้อง API จะคืนค่าผลลัพธ์การค้นหาในรูปแบบ JSON
Creator Store API
สำหรับข้อมูลเกี่ยวกับการเรียกใช้งาน Creator Store API สำหรับการค้นหา ดูบริการ Toolbox ใน เอกสารอ้างอิง Open Cloud
Marketplace API
คุณสามารถค้นหารายการอวาตาร์จาก Marketplace โดยใช้ URL ต่อไปนี้: https://catalog.roblox.com/v1/search/items/details?[params]
คุณสามารถแทนที่ [params] ด้วย พารามิเตอร์การค้นหา ที่เหมาะสมเพื่อปรับแต่งการค้นหาของคุณ
พารามิเตอร์การค้นหา
คุณสามารถกำหนดพารามิเตอร์การค้นหาโดยการเพิ่มชุดพารามิเตอร์และค่าต่างๆ ลงใน URL โดยที่แต่ละพารามิเตอร์แยกจากกันด้วย &
ใช้พารามิเตอร์ต่อไปนี้ในการค้นหาใน Marketplace:
| พารามิเตอร์ | ประเภท | ตัวเลือกและค่า |
|---|---|---|
| หมวดหมู่ | byte | 0 = สนใจ 1 = ทั้งหมด 2 = ของสะสม 3 = เสื้อผ้า 4 = ส่วนต่างๆของร่างกาย 5 = อุปกรณ์ 11 = อุปกรณ์เสริม 12 = อนิเมชั่นอวาตาร์ 13 = การสร้างสรรค์จากชุมชน |
| ประเภทผู้สร้าง | byte | 1 = ผู้ใช้ 2 = กลุ่ม การค้นหาที่ใช้ ประเภทผู้สร้าง ยังต้องการพารามิเตอร์ CreatorTargetId ด้วย |
| CreatorTargetId | long | ID ของผู้ใช้หรือกลุ่ม ขึ้นอยู่กับประเภทผู้สร้างที่ระบุ การค้นหาที่ใช้ CreatorTargetId ยังต้องการพารามิเตอร์ ประเภทผู้สร้าง ด้วย |
| ชื่อผู้สร้าง | 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 ของรายการในการค้นหา |
| SortAggregation | byte | 1 = วันก่อน 3 = สัปดาห์ที่ผ่านมา 4 = เดือนที่ผ่านมา 5 = ตลอดเวลา |
| SortType | byte | 0 = ความเกี่ยวข้อง (ค่าเริ่มต้น) 1 = เพิ่มเป็นที่ชื่นชอบ 2 = ขาย 3 = อัปเดต 4 = ราคา เพิ่ม 5 = ราคา ลด |
| หมวดหมู่ย่อย | byte | 0 = สนใจ 1 = ทั้งหมด 2 = ของสะสม 3 = เสื้อผ้า 4 = ส่วนต่างๆของร่างกาย 5 = อุปกรณ์ 9 = หมวก 10 = ใบหน้า 12 = เสื้อ 13 = เสื้อยืด 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 = เสื้อยืดคลาสสิก 56 = เสื้อคลาสสิก 57 = กางเกงคลาสสิก 58 = อุปกรณ์เสริมเสื้อยืด 59 = อุปกรณ์เสริมเสื้อ 60 = อุปกรณ์เสริมกางเกง 61 = อุปกรณ์เสริมแจ็กเก็ต 62 = อุปกรณ์เสริมเสื้อสเวตเตอร์ 63 = อุปกรณ์เสริมกางเกงขาสั้น 64 = ชุดรวมรองเท้า 65 = อุปกรณ์เสริมกระโปรงชุด 66 = หัวที่สามารถเคลื่อนไหวได้ |
URL ต่อไปนี้จะค้นหารายการ "Gear" 10 รายการแรกใน "Accessories" ที่จัดเรียงตามเวลาทั้งหมด ("SortAggregation") และความเกี่ยวข้อง ("SortType") ที่สร้างโดย Roblox ("CreatorTargetId" และ "CreatorType"):
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 โดยใช้ฟิลด์ต่อไปนี้:
| ฟิลด์ | คำอธิบาย |
|---|---|
| assetType | หนึ่งในค่าประเภททรัพย์สินต่อไปนี้ (จะส่งกลับเฉพาะถ้ารายการเป็นทรัพย์สิน) 2 = เสื้อยืด 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 = อนิเมชั่นโพส |
| 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":"Restless Souls Bandana",
"description":"ผ้าพันคอนี้จะไม่ช่วยให้คุณกลมกลืนกับผีได้ แต่จะทำให้คุณดูดีอย่างน้อย",
"productId":41270974,
"genres":[
"Scary",
"Adventure"
],
"itemStatus":[],
"itemRestrictions":[],
"creatorType":"User",
"creatorTargetId":1,
"creatorName":"Roblox",
"price":300,
"favoriteCount":15943,
"offSaleDeadline":null
}
]
}