Panduan penggunaan untuk penerbitan tempat

API penerbitan tempat menawarkan fungsionalitas yang mirip dengan penerbitan ke Roblox di Studio, dengan kontrol izin tambahan dan otomatisasi dalam alur kerja rilis berkelanjutan. Anda dapat menggunakan API ini untuk memperbarui tempat yang ada dari sebuah game ke versi baru, menjadikannya berguna untuk mengotomatiskan alur kerja penerbitan Anda. Misalnya, Anda dapat memanggil API ini dari aksi GitHub dan secara otomatis mengunggah file tempat biner ke Roblox setelah pengujian integrasi berhasil.

Batasan

• API ini hanya mendukung permintaan HTTPS.
• API penerbitan tempat tidak memperbarui jenis instance tertentu. Jika game Anda mengandung instance EditableImage, EditableMesh, PartOperation, SurfaceAppearance, atau BaseWrap, terbitkan dari Studio setelah memodifikasinya.

Tempat di Roblox

Game di Roblox dapat memiliki beberapa tempat, dengan satu tempat awal sebagai titik masuk pengguna ke game Anda dan tempat lain yang opsional yang dapat Anda teleportasikan pengguna antar tempat. Anda dapat menggunakan API untuk menerbitkan baik tempat awal atau tempat lain dari game Anda dengan kontrol versi.

Sebelum Anda dapat memperbarui tempat yang ada dari sebuah game, Anda memerlukan Place ID tempat tersebut dan Universe ID game tersebut. Place ID mengidentifikasi tempat dan Universe ID mengidentifikasi game. Masing-masing adalah unik meskipun game Anda hanya memiliki satu tempat.

Menerbitkan tempat

Untuk menerbitkan tempat yang ada dari sebuah game dengan Place Publishing API:

1. Buat kunci API di Creator Dashboard. Pastikan Anda melakukan pengaturan berikut:

   1. Tambahkan universe-places ke Izin Akses.
   2. Tambahkan operasi Tulis ke game yang Anda pilih.

2. Dapatkan Universe ID dari game di mana Anda ingin menerbitkan tempat.

   1. Navigasikan ke Creator Dashboard.

   2. Temukan game dengan tempat yang ingin Anda perbarui.

   3. Arahkan kursor ke thumbnail game, klik tombol ⋯, dan pilih Salin Universe ID.

      

3. Dapatkan Place ID dari tempat yang ingin Anda perbarui.

   1. Tetap di halaman Kreasi di Creator Dashboard dan klik thumbnail game target.
   2. Di menu navigasi sebelah kiri, klik tab Tempat.
   3. Temukan tempat yang ingin Anda perbarui dan klik thumbnail-nya.
   4. Place ID ada di URL yang dialihkan. Misalnya, di URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,, **Place ID** adalah 111111`.

4. Tambahkan Kunci API di header x-api-key dari permintaan POST ke API. Dua contoh permintaan berikut merujuk pada file tempat XML Roblox (.rbxlx) dan file tempat biner (.rbxl).

   Permintaan File Tempat XML

   $ 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

   Permintaan File Tempat Biner

   $ 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

   Untuk menjalankan perintah, ganti {universeId} dan {placeId} dengan Universe ID dan Place ID yang sebenarnya dari game dan tempat yang ingin Anda terbitkan.

5. Jika Anda mengirim permintaan Anda dengan benar, Anda akan menerima respons tubuh sukses dengan nomor versi tempat dalam format berikut:

   Contoh Respons Tubuh

   { "versionNumber": 7 }

6. OPSIONAL

   Verifikasi unggahan di Studio atau di Creator Dashboard.