Jalur sumber daya entri penyimpanan data.
Format:
- universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}
- universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}.
*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.
Entri kunci-nilai di penyimpanan data.
Jalur sumber daya entri penyimpanan data.
Format:
Stempel waktu ketika entri penyimpanan data dibuat. String ini diformat sebagai Timestamp.
ID revisi dari entri toko data.
Revisi baru dilakukan setiap kali entri penyimpanan data diubah dengan cara apa pun.
Format adalah string arbitrer. Contoh: "foo".
Stempel waktu ketika revisi dibuat. String ini diformat sebagai Timestamp.
Status entri toko data.
Nilai yang mungkin:
| Nilai | Deskripsi | | --- | --- | | STATE_UNSPECIFIED | Nilai default.Nilai ini digunakan jika negara diabaikan.| | AKTIF | Status default dari entri penyimpanan data baru yang dibuat.| | DIHAPUS | Entri penyimpanan data ditandai sebagai dihapus. Pada beberapa titik di masa depan, itu akan dihapus secara permanen. |. Nilai yang mungkin:
Checksum ini dihitung oleh server berdasarkan nilai bidang lain, dan dapat dikirim pada permintaan update dan penghapusan (dan mungkin pada metode khusus tertentu) untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.
Nilai dari entri.
Nilai JSON dapat berupa null, boolean, string, number, array, atau object.
ID sumber daya entri.
Ini cocok dengan segmen terakhir dari jalur sumber daya, dan hanya disediakan untuk kenyamanan.
Pengguna yang terkait dengan entri.
Satu set atribut acak yang terkait dengan entri.
https://apis.roblox.com
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
Mem返回 daftar entri dari penyimpanan data.
Hanya bidang path dan id yang diisi; gunakan GetDataStoreEntry untuk mengambil bidang lain.
Spesifikasikan scope liar ( - ) untuk daftar entri dari semua scope.
ID alam semesta.
ID penyimpanan data.
Jumlah maksimum entri penyimpanan data untuk dikembalikan.Layanan mungkin kembali kurang dari nilai ini.Jika tidak ditentukan, paling banyak 10 entri penyimpanan data dikembalikan.Nilai maksimum adalah 256 dan nilai lebih tinggi ditetapkan ke 256.
Token halaman, diterima dari panggilan sebelumnya, untuk mengambil halaman berikutnya.
Saat paginasi, semua parameter lain yang disediakan untuk panggilan berikutnya harus cocok dengan panggilan yang memberikan token halaman.
Bidang ini dapat ditetapkan untuk memfilter sumber daya yang dikembalikan.
Bidang filter mendukung subset yang sangat kecil dari CEL:
Contoh filter: id.startsWith("foo").
Jika benar, sumber daya yang ditandai untuk penghapusan tertunda akan dimasukkan dalam hasil.
Daftar DataStoreEntries dalam koleksi orangtua.
DataStoreEntries dari DataStore atau DataStoreScope yang ditentukan.
Token yang dapat Anda kirim sebagai parameter pageToken untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?maxPageSize=10&pageToken={string}&filter={string}&showDeleted={boolean}' \
-H 'x-api-key: {your-api-key}'
{
"dataStoreEntries": [
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
],
"nextPageToken": "string"
}
Membuat entri dengan ID dan nilai yang disediakan.
Kembalikan 400 Permintaan Buruk jika entri ada.
ID alam semesta.
ID penyimpanan data.
ID untuk digunakan untuk entri penyimpanan data, yang akan menjadi komponen terakhir dari jalur sumber daya penyimpanan data.
Nilai ini harus menjadi string karakter 1-50. Kami sangat menyarankan menggunakan hanya huruf kecil, angka numerik, dan hyphen.
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?id=my-entry' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"etag": "string",
"value": "JSON value",
"users": [
"string"
],
"attributes": "object"
}'
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
Mendapatkan entri yang ditentukan.
Untuk mendapatkan entri pada revisi tertentu, tambahkan @<revisionId> ke akhir jalur.
Sebagai contoh, untuk mendapatkan my-entry di ID revisi 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 , gunakan jalur /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 .
Jika ID entri Anda berisi satu atau lebih karakter @ , dan Anda ingin mendapatkan versi terbaru daripada pada revisi tertentu, tambahkan ID revisi khusus @latest ke akhir jalur.Jika tidak, bagian dari ID entri setelah terakhir @ akan diinterpretasikan sebagai ID revisi.
Sebagai contoh, untuk mendapatkan revisi terbaru dari my-entry , gunakan jalur /v2/universes/1234/data-stores/5678/entries/my@entry@latest .
Untuk mendapatkan entri yang saat ini pada waktu tertentu, tambahkan @latest:<timestamp> ke akhir jalur, di mana <timestamp> dibentuk menjadi RFC-3339.Waktu yang diberikan harus setelah zaman Unix (1/1/1970) dan tidak lebih dari sepuluh menit di masa depan.
Sebagai contoh, untuk mendapatkan revisi dari my-entry yang saat ini pada 12/2/2024 pada 06:00 UTC, gunakan jalur /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z .
ID alam semesta.
ID penyimpanan data.
ID masuk.
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
-H 'x-api-key: {your-api-key}'
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
Menandai entri yang ditentukan untuk dihapus.
Entri tidak akan dihapus segera; sebaliknya, bidang state akan disetel ke DELETED. Penghapusan permanen terjadi setelah 30 hari.
Pada keberhasilan,返回 200 OK. Jika entri tidak ada,返回 404 Not Found.
ID alam semesta.
ID penyimpanan data.
ID masuk.
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
-H 'x-api-key: {your-api-key}'
Memperbarui nilai, atribut, dan pengguna entri.
Memperbarui revisi spesifik entri adalah tidak didukung .Jika Anda menyebutkan ID revisi di jalur dan allow_missing adalah true , permintaan pembaruan akan membuat entri baru dengan prefiks @<revisionId> sebagai bagian dari kunci.
Pembaruan parsial adalah tidak didukung .Jika atribut atau pengguna tidak disediakan saat menyetel nilai, mereka akan dihapus.Nilai harus selalu disediakan saat memperbarui entri.
ID alam semesta.
ID penyimpanan data.
ID masuk.
Jika diatur ke benar, dan entri penyimpanan data tidak ditemukan, entri penyimpanan data dibuat.
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}?allowMissing={boolean}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"etag": "string",
"value": "JSON value",
"users": [
"string"
],
"attributes": "object"
}'
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
Meningkatkan nilai entri yang ditentukan. Kedua nilai yang ada dan jumlah peningkatan harus menjadi bilangan bulat.
Jika entri tidak ada, membuat entri dengan nilai yang ditentukan.
Meningkatkan revisi spesifik entri adalah tidak didukung .Jika Anda menentukan ID revisi di jalur, permintaan peningkatan akan membuat entri baru dengan prefiks @<revisionId> sebagai bagian dari kunci.
Masalah yang dikenal: nilai dapat ditingkatkan melewati rentang nilai yang valid.Ketika ini terjadi, nilai yang dikembalikan akan dikunci ke rentang yang valid, tetapi backend dapat mempertahankan nilai asli.Perilaku ini dipertahankan karena alasan kompatibilitas mundur, tetapi bisa berubah di versi masa depan dari API ini.
ID alam semesta.
ID penyimpanan data.
ID masuk.
Jumlah yang digunakan untuk meningkatkan nilai entri. Baik nilai yang ada maupun jumlah peningkatan harus menjadi bilangan bulat.
Pengguna yang terkait dengan entri.
Jika ini tidak disediakan, ID pengguna yang ada dihapus.
Satu set atribut acak yang terkait dengan entri.
Jika ini tidak disediakan, atribut yang ada dihapus.
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"amount": "number",
"users": [
"string"
],
"attributes": "object"
}'
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
Daftar revisi entri penyimpanan data.
Metode ini men返回 parsial data store entri.
Secara khusus, hanya bidang , , , , , dan yang diisi.Kedua bidang path dan id akan memiliki prefiks @<version>.
Untuk mendapatkan entri lengkap pada revisi, Anda dapat menggunakan bidang yang disediakan path dengan metode GetDataStoreEntry , yaitu GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version> .
ID alam semesta.
ID penyimpanan data.
ID masuk.
Jumlah revisi maksimum untuk dikembalikan per halaman.
Layanan mungkin kembali kurang dari jumlah revisi maksimum.Jika tidak ditentukan, paling banyak 10 revisi dikembalikan.Nilai maksimum adalah 100 nilai dan nilai yang lebih tinggi ditetapkan ke 100.
Token halaman, diterima dari panggilan sebelumnya, untuk mengambil halaman berikutnya.
Saat paginasi, semua parameter lain yang disediakan untuk panggilan berikutnya harus cocok dengan panggilan yang memberikan token halaman.
Mendukung subset berikut dari CEL:
Sebagai contoh:
"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".
Daftar revisi entri penyimpanan data.
Revisi data_store_entry.
Token yang Anda kirim sebagai parameter pageToken untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
{
"dataStoreEntries": [
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
],
"nextPageToken": "string"
}