คู่มือการใช้งานสำหรับการเผยแพร่สถานที่

API การเผยแพร่สถานที่ มีฟังก์ชันการทำงานที่คล้ายกับ การเผยแพร่สู่ Roblox ใน Studio โดยมีการควบคุมสิทธิ์และการทำงานอัตโนมัติในกระบวนการปล่อยอย่างต่อเนื่อง คุณสามารถใช้ API นี้ในการอัปเดตสถานที่ที่มีอยู่ของเกมไปเป็นเวอร์ชันใหม่ ทำให้มันเป็นประโยชน์สำหรับการทำงานเผยแพร่โดยอัตโนมัติ ตัวอย่างเช่น คุณสามารถเรียก API นี้จาก action ของ GitHub และให้มันผลักดันไฟล์สถานที่แบบไบนารีไปยัง Roblox โดยอัตโนมัติหลังจากการทดสอบการรวมสำเร็จ

ข้อจำกัด

• API นี้รองรับเฉพาะคำร้องขอ HTTPS เท่านั้น
• API การเผยแพร่สถานที่ไม่อัปเดตประเภทอินสแตนซ์บางประเภท หากเกมของคุณมีอินสแตนซ์ EditableImage, EditableMesh, PartOperation, SurfaceAppearance, หรือ BaseWrap ให้เผยแพร่จาก Studio หลังจากการแก้ไข

สถานที่ใน Roblox

เกมใน Roblox สามารถมีหลายสถานที่ โดยมี สถานที่เริ่มต้น หนึ่งแห่งเป็นจุดเข้าถึงของผู้ใช้ในเกมของคุณและสถานที่อื่นๆ ที่คุณสามารถ เคลื่อนย้ายผู้ใช้ระหว่าง ได้ คุณสามารถใช้ API เพื่อเผยแพร่สถานที่เริ่มต้นหรือสถานที่อื่น ๆ ของเกมของคุณพร้อมการควบคุมเวอร์ชัน

ก่อนที่คุณจะสามารถอัปเดตสถานที่ที่มีอยู่ของเกมได้ คุณต้องมี Place ID ของสถานที่และ Universe ID ของเกม Place ID ใช้ระบุสถานที่ และ Universe ID ใช้ระบุเกม แต่ละชนิดมีความเป็นเอกลักษณ์แม้ว่าเกมของคุณจะมีเพียงสถานที่เดียว

เผยแพร่สถานที่

ในการเผยแพร่สถานที่ที่มีอยู่ของเกมด้วย Place Publishing API:

1. สร้าง API key บน Creator Dashboard ให้แน่ใจว่าคุณได้ตั้งค่าดังต่อไปนี้:

   1. เพิ่ม universe-places ใน สิทธิ์การเข้าถึง
   2. เพิ่มการทำงาน Write ให้กับเกมที่คุณเลือก

2. รับ Universe ID ของเกมที่คุณต้องการเผยแพร่สถานที่

   1. ไปที่ Creator Dashboard.

   2. หาเกมที่มีสถานที่ที่คุณต้องการอัปเดต

   3. เลื่อนเมาส์ไปที่ภาพขนาดย่อของเกม คลิกปุ่ม ⋯ และเลือก Copy Universe ID

      

3. รับ Place ID ของสถานที่ที่คุณต้องการอัปเดต

   1. อยู่ที่หน้าที่ Creations บน Creator Dashboard และคลิกที่ภาพขนาดย่อของเกมที่ต้องการ
   2. ในเมนูด้านซ้าย คลิกแท็บ Places
   3. หาสถานที่ที่คุณต้องการอัปเดตและคลิกที่ภาพขนาดย่อของมัน
   4. Place ID จะอยู่ใน URL ที่ถูกเปลี่ยนเส้นทาง สำหรับตัวอย่าง ใน URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,จะระบุ **Place ID** ว่า111111`

4. เพิ่ม API Key ในส่วนหัว x-api-key ของคำร้อง POST ไปยัง API คำร้องตัวอย่างสองรายการด้านล่างอ้างอิงไฟล์สถานที่ XML ของ Roblox (.rbxlx) และไฟล์สถานที่แบบไบนารี (.rbxl)

   XML Place File Request
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/xml' \
   --data-binary @/home/placefiles/place1.rbxlx

   Binary Place File Request
   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/octet-stream' \
   --data-binary @/home/placefiles/place1.rbxl

   ในการรันคำสั่ง ให้แทนที่ {universeId} และ {placeId} ด้วย Universe ID และ Place ID ที่แท้จริงของเกมและสถานที่ที่คุณต้องการจะเผยแพร่

5. หากคุณส่งคำร้องของคุณถูกต้อง คุณจะได้รับการตอบกลับที่ประสบความสำเร็จโดยมีเลขเวอร์ชันของสถานที่ในรูปแบบดังต่อไปนี้:

   Example Response Body
   { "versionNumber": 7 }

6. (ตัวเลือก) ตรวจสอบการอัปโหลดใน Studio หรือที่ Creator Dashboard