Toko data yang diperintahkan (beta)

*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Halaman ini termasuk dokumentasi referensi untuk bekerja dengan penyimpanan data yang diperintahkan.Untuk informasi lebih lanjut tentang penggunaan API, lihat menangani permintaan API untuk penyimpanan data dan panduan penggunaan .

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

Daftar

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Kembalikan daftar entri dari toko data yang diperintahkan.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data target yang diperintahkan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
max_page_size number

Jumlah maksimum entri untuk dikembalikan.Layanan dapat kembali kurang dari nilai ini.Nilai default adalah 10 .Nilai maksimum adalah 100 , dan setiap input di atas 100 dipaksa menjadi 100 .

page_token string

Token halaman yang diterima dari panggilan sebelumnya List .Berikan ini untuk mengambil halaman berikutnya.Saat paginasi, semua parameter lain yang disediakan ke List harus cocok dengan panggilan yang memberikan token halaman.

order_by string

Arah enumerasi. Urutan default adalah menaik. Masukkan sufiks desc untuk turun.

filter string

Kisaran nilai kualifikasi entri untuk dikembalikan. Lihat Filter.

Permintaan

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \

 --header 'x-api-key: <insert-api-key>'

Respons

200 - OK
OK
Memberikan nilai object
entries array<object>

Entri dari Lingkup yang ditentukan.

nextPageToken string

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Buat

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Membuat entri baru dengan nilai konten yang disediakan.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
id string

Nama entri.

Diperlukan

Permintaan

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Respons

200 - OK
OK
Memberikan nilai object
id string

Nama entri

path string

Jalur sumber daya dari permintaan.

value number

Nilai dari entri.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Tulis

Dapatkan

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Mendapatkan dan mengembalikan entri yang ditentukan.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan

Permintaan

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Respons

200 - OK
OK
Memberikan nilai object
id string

Nama entri

path string

Jalur sumber daya dari permintaan.

value number

Nilai dari entri.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Menghapus

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Menghapus entri yang ditentukan.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan

Permintaan

curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Respons

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Tulis

Pembaruan

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Memperbarui nilai entri dan mengembalikan entri yang diperbarui.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan
allow_missing boolean

Bendera untuk mengizinkan pembuatan entri jika entri tidak ada. Lihat Izinkan bendera yang hilang.

Permintaan

curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Respons

200 - OK
OK
Memberikan nilai object
id string

Nama entri

path string

Jalur sumber daya dari permintaan.

value number

Nilai dari entri.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Tulis

Peningkatan

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Meningkatkan nilai kunci dengan jumlah yang disediakan dan mengembalikan entri yang diperbarui.

Masalah yang dikenal: Nilai entri dapat meningkat melewati rentang yang valid dan ini dapat bertahan di backend. Nilai yang dikembalikan akan mengikat ke rentang yang valid.

Parameter

universeId string

Pengenal pengalaman dengan toko data terstruktur yang ingin Anda akses.Lihat ID Alam Semesta pada cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama scope penyimpanan data. Lihat Scopes.

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan

Permintaan

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "amount": <long> 

}'

Respons

200 - OK
OK
Memberikan nilai object
id string

Nama entri

path string

Jalur sumber daya dari permintaan.

value number

Nilai dari entri.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Tulis

Objek

Objek berikut mendeskripsikan muatan yang diterima atau diberikan. Lihat masing-masing endpoint untuk mengetahui informasi selengkapnya tentang waktu penggunaan objek ini.

CreateEntryRequest

Membuat entri baru dengan nilai yang diberikan.

Atribut

value number

Nilai untuk menetapkan entri baru.Jika nilai input melebihi nilai maksimum yang didukung oleh int64, yaitu 9,223,372,036,854,775,807, permintaan gagal dengan kesalahan 400 Bad Request.

Entry

Mewakili entri.

Atribut

id string

Nama entri

path string

Jalur sumber daya dari permintaan.

value number

Nilai dari entri.

IncrementEntryRequest

Meningkatkan nilai entri.

Atribut

amount number

Jumlah untuk meningkatkan oleh nilai entri.Jika nilai input melebihi nilai maksimum yang didukung oleh int64, yaitu 9,223,372,036,854,775,807, permintaan gagal dengan kesalahan 400 Bad Request.

ListEntriesResponse

Daftar Entri dalam koleksi orang tua.

Atribut

entries array<object>

Entri dari Lingkup yang ditentukan.

nextPageToken string

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

UpdateEntryRequest

Memperbarui entri yang disediakan dengan nilai baru.

Atribut

value number

Nilai untuk memperbarui entri.Jika nilai input melebihi nilai maksimum yang didukung oleh int64, yaitu 9,223,372,036,854,775,807, permintaan gagal dengan kesalahan 400 Bad Request.