Toko Data yang Dipesan (Beta)

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

Halaman ini mencakup dokumentasi referensi untuk bekerja dengan toko data yang diperintahkan. Untuk informasi lebih lanjut tentang menggunakan API, lihat Menangani Permintaan API untuk Toko Data dan Panduan Penggunaan.

OrderedDataStores

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

Daftar

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

Mengembalikan daftar entri dari penyimpanan data yang dipesan.

Parameter

universeId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data target yang dipesan.

Path
Diperlukan
scope string

Nama ruang penyimpanan data. Lihat Scopes .

Path
Diperlukan
max_page_size number

Jumlah maksimum entri yang akan dikembalikan. Layanan mungkin mengembalikan kurang dari nilai ini.Nilai default adalah 10 .Nilai maksimal adalah 100 , dan setiap masukan di atas 100 diwajibkan menjadi 100 .

page_token string

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

order_by string

Arah penghitungan. Pesanan default adalah naik. Masukkan desc缀 untuk menurun.

filter string

Jangkauan nilai kualifikasi entri untuk dikembalikan. Lihat Filtre .

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
Oke
Memberikan nilai object
entries array<object>

Entri dari Scope yang ditentukan.

nextPageToken string

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika bagian ini diomong-omong, tidak ada halaman berikutnya.

Buat

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

Menciptakan entri baru dengan nilai konten yang diberikan.

Parameter

universeId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama ruang penyimpanan data. Lihat Scopes .

Path
Diperlukan
id string

Nama entri.

Diperlukan
CreateEntryRequest

Menciptakan entri baru dengan nilai yang diberikan.

Body
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
Oke
Memberikan nilai object
id string

Nama entri

path string

Jalan sumber daya permintaan.

value number

Nilai dari entri.

Mendapatkan

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

Mendapatkan dan mengembalikan entri yang ditentukan.

Parameter

universeId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama ruang 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
Oke
Memberikan nilai object
id string

Nama entri

path string

Jalan sumber daya permintaan.

value number

Nilai dari entri.

Hapus

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

Menghapus entri yang ditentukan.

Parameter

universeId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama ruang 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

Pembaruan

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

Mengubah nilai entri dan mengembalikan entri yang diperbarui.

Parameter

universeIdId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama ruang penyimpanan data. Lihat Scopes .

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan
UpdateEntryRequest

Meng更新提供 dengan nilai baru.

Body
Diperlukan
allow_missing boolean

Bendera untuk memungkinkan pembuatan entri jika entri tidak ada. Lihat Ijinkan Bayang-Bayang 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
Oke
Memberikan nilai object
id string

Nama entri

path string

Jalan sumber daya permintaan.

value number

Nilai dari entri.

Meningkatkan

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

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

Masalah dikenal:Nilai masuk dapat meningkatkan rentang yang valid dan ini dapat bertahan di backend.Nilai yang dikembalikan akan menjepit ke rentang yang valid.

Parameter

universeId string

Pengenal pengalaman dengan toko data yang Anda ingin akses. Lihat Pengenal Pengalaman di cara menyalinnya di Dashboard Pencipta.

Path
Diperlukan
orderedDataStore string

Nama toko data yang dipesan.

Path
Diperlukan
scope string

Nama ruang penyimpanan data. Lihat Scopes .

Path
Diperlukan
entry string

ID masuk.

Path
Diperlukan
incrementEntryRequest

Meningkatkan nilai masuk.

Body
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
Oke
Memberikan nilai object
id string

Nama entri

path string

Jalan sumber daya permintaan.

value number

Nilai dari entri.

Objek

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

CreateEntryRequest

Menciptakan entri baru dengan nilai yang diberikan.

Atribut

value number

Nilai untuk menetapkan entri baru. Jika nilai masukan melebihi nilai maksimum yang didukung oleh int64, yang adalah 9.223.372.036,854,775,807, permintaan gagal dengan kesalahan 400 Bad Request.

Entry

M mewakili entri.

Atribut

id string

Nama entri

path string

Jalan sumber daya permintaan.

value number

Nilai dari entri.

IncrementEntryRequest

Meningkatkan nilai masuk.

Atribut

amount number

Jumlah untuk meningkatkan nilai masuk. Jika nilai masuk melebihi nilai maksimum yang didukung oleh int64, yang adalah 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 Scope yang ditentukan.

nextPageToken string

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika bagian ini diomong-omong, tidak ada halaman berikutnya.

UpdateEntryRequest

Meng更新提供 dengan nilai baru.

Atribut

value number

Nilai untuk menghubungkan entri. Jika nilai masukan melebihi nilai maksimum yang didukung oleh int64, yang adalah 9.223.372.036,854,775,807, permintaan gagal dengan kesalahan 400 Bad Request.