Penyimpanan data standar

*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 standar.Untuk informasi lebih lanjut tentang penggunaan API, lihat menangani permintaan API untuk penyimpanan data dan panduan penggunaan .

Datastores

https://apis.roblox.com/datastores

Endpoint berikut tersedia di jalur relatif terhadap base URL.

Toko Data Daftar

GET /v1/universes/{universeId}/standard-datastores

Mem返回列表 penyimpanan data pengalaman.

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

cursor string

Berikan untuk meminta set data berikutnya. Lihat Kursor.

limit number

Jumlah maksimum item untuk dikembalikan.Setiap panggilan hanya membaca satu partisi, sehingga dapat mengembalikan kurang dari nilai yang diberikan saat kehabisan tujuan di satu partisi.

prefix string

Berikan untuk mengembalikan hanya penyimpanan data dengan prefiks ini.

Permintaan

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "prefix=Player" \
-d "limit=5"

Respons

200 - OK

Memberikan nilai object

application/json

{
  "datastores": [
    {
      "name": "PlayerInventory",
      "createdTime": "2022-02-18T22:38:59.9244932Z"
    },
    {
      "name": "PlayerExperience",
      "createdTime": "2022-02-18T23:00:10.4773508Z"
    },
    {
      "name": "PlayerWeapons",
      "createdTime": "2022-02-18T23:00:22.3725681Z"
    },
    {
      "name": "PlayerArmor",
      "createdTime": "2022-02-18T22:59:33.8472882Z"
    },
    {
      "name": "PlayerHP",
      "createdTime": "2022-02-18T22:58:47.6904028Z"
    }
  ],
  "nextPageCursor": "..."
}

data array<object>

Serangkaian penyimpanan data di pengalaman target.

nextPageCursor string

Menunjukkan bahwa ada lebih banyak data yang tersedia dalam aturhasil yang diminta. Lihat Kursor.

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.

List Datastores

Entries

https://apis.roblox.com/datastores

Endpoint berikut tersedia di jalur relatif terhadap base URL.

Daftar Entri

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

Mem返回列 kunci entri dalam penyimpanan data.

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

scope string

Nilainya adalah global secara default. Lihat Skop .

allScopes boolean

Atur ke benar untuk mengembalikan kunci dari semua scope.

prefix string

Berikan untuk mengembalikan hanya kunci dengan prefiks ini.

cursor string

Berikan untuk meminta set data berikutnya. Lihat Kursor.

limit number

Jumlah maksimum item untuk dikembalikan.Setiap panggilan hanya membaca satu partisi, sehingga dapat mengembalikan kurang dari nilai yang diberikan saat kehabisan tujuan di satu partisi.

Permintaan

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "prefix=" \
-d "limit=5"

Respons

200 - OK

Memberikan nilai object

application/json

{
  "keys": [
    {
      "key": "269323"
    }
  ],
  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"
}

keys array<string>

Sebuah array kunci masuk dalam penyimpanan data target.

nextPageCursor string

Menunjukkan bahwa ada lebih banyak data yang tersedia dalam aturhasil yang diminta. Lihat Kursor.

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.

List Entry Keys

Dapatkan Entri

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Kembalikan nilai dan metadata yang terkait dengan entri.

metadata dapat ditemukan di header respons seperti mengikuti:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

| Kepala | Deskripsi | |---|---| | content-md5 | MD5 checksum dasar-64 dari konten.Lihat Konten-MD5 .| | roblox-entry-version | Versi entri yang dikembalikan.| | roblox-entry-created-time | Waktu saat entri dibuat.| | roblox-entry-version-created-time | Waktu ketika versi khusus ini dibuat.| | roblox-entry-attributes | Tag atribut yang ditagih dengan entri.Objek peta JSON ternormalisasi.| | roblox-entry-userids | Daftar terpisah koma dari ID pengguna Roblox yang ditagih dengan entri. |

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

scope string

Nilainya adalah global secara default. Lihat Skop .

Permintaan

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Respons

200 - OK

Berhasil mengambil entri.

Memberikan nilai object

204 - No Content

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.

Read Entry

Tetapkan Entri

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Tetapkan nilai, metadata, dan ID pengguna yang terkait dengan entri.

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

matchVersion string

Berikan untuk diperbarui hanya jika versi saat ini cocok dengan ini.

exclusiveCreate boolean

Buat entri hanya jika tidak ada.

scope string

Nilainya adalah global secara default. Lihat Skop .

roblox-entry-attributes string

Atribut yang harus dihubungkan dengan versi baru entri. Diterserial oleh objek peta JSON. Jika tidak disediakan, atribut yang ada dihapus.

Header

roblox-entry-userids string

Daftar terpisah koma dari ID pengguna Roblox yang ditagih dengan entri. Jika tidak disediakan, ID pengguna yang ada dihapus.

Header

content-md5 string

Checksum MD5 yang dienkode basis-64 dari konten. Lihat Konten-MD5 .

Header

Permintaan

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \
--header "x-api-key: ${API_KEY}" \
--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \
--header "content-type: application/json" \
--header "roblox-entry-userids: [269323]" \
--header "roblox-entry-attributes: {}" \
--d "value"

Respons

200 - OK

Memberikan nilai object

version string

Nama versi entri kualifikasi.

deleted boolean

Menunjukkan apakah entri telah dihapus.

contentLength number

Panjang konten.

createdTime string

Stempel waktu ketika versi dibuat dalam format waktu ISO.

objectCreatedTime string

Stempel waktu ketika penyimpanan data dibuat dalam format waktu ISO.

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.

Create Entry
Update Entry

Laporkan Entri

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Menandai entri sebagai dihapus dengan membuat versi batu nis. Entri dihapus secara permanen setelah 30 hari.

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

scope string

Nilainya adalah global secara default. Lihat Skop .

Permintaan

curl

curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Respons

204 - No Content

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.

Delete Entry

Peningkatan Entri

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Meningkatkan nilai untuk entri dengan jumlah yang ditentukan, atau membuat entri baru dengan jumlah itu. Kembalikan entri dan metadata.

metadata dapat ditemukan di header respons seperti mengikuti:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

incrementBy number

Jumlah yang harus ditingkatkan entri, atau nilai awal jika tidak ada.

scope string

Nilainya adalah global secara default. Lihat Skop .

roblox-entry-attributes string

Atribut yang harus dihubungkan dengan versi baru entri. Diterserial oleh objek peta JSON. Jika tidak disediakan, atribut yang ada dihapus.

Header

roblox-entry-userids string

Daftar terpisah koma dari ID pengguna Roblox yang ditagih dengan entri. Jika tidak disediakan, ID pengguna yang ada dihapus.

Header

Permintaan

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \
--header "x-api-key: ${API_KEY}" \
--header 'content-length: 0' \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "incrementBy=3"

Respons

200 - OK

Kembalikan versi terbaru dari entri setelah ditingkatkan.

Memberikan nilai object

204 - No Content

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.

Create Entry
Update Entry

Dapatkan Versi Masuk

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Kembalikan nilai dan metadata dari versi tertentu dari entri.

metadata dapat ditemukan di header respons seperti mengikuti:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

versionId string

Versi untuk diperiksa.

scope string

Nilainya adalah global secara default. Lihat Skop .

Permintaan

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Respons

200 - OK

Berhasil mengambil entri.

Memberikan nilai object

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.

Read Version

Batas

Per Kunci API: 5000 permintaan setiap 60 detik per Alamat IP

Versi Entri Daftar

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Kembalikan daftar versi untuk entri.

Parameter

universeId number

Pengenal pengalaman dengan penyimpanan data yang ingin Anda akses.Anda dapat menyalin ID Alam Semesta pengalaman Anda di Dashboard Pencipta .

Path

Diperlukan

datastoreName string

Nama toko data.

entryKey string

Kunci yang mengidentifikasi entri.

scope string

Nilainya adalah global secara default. Lihat Skop .

cursor string

Berikan untuk meminta set data berikutnya (lihat Kursor).

startTime string

Berikan untuk tidak termasuk versi sebelum waktu ini.

endTime string

Berikan untuk tidak termasuk versi setelah waktu ini timestamp.

sortOrder string

Entah Ascending (versi sebelumnya terlebih dahulu) atau Descending (versi berikutnya terlebih dahulu).

limit number

Jumlah maksimum item untuk dikembalikan.Setiap panggilan hanya membaca satu partisi, sehingga dapat mengembalikan kurang dari nilai yang diberikan saat kehabisan tujuan di satu partisi.

Permintaan

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "limit=5"

Respons

200 - OK

Memberikan nilai object

version string

Nama versi entri kualifikasi.

deleted boolean

Menunjukkan apakah entri telah dihapus.

contentLength number

Panjang konten.

createdTime string

Stempel waktu ketika versi dibuat dalam format waktu ISO.

objectCreatedTime string

Stempel waktu ketika penyimpanan data dibuat dalam format waktu ISO.

Kode Status lain

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.

List Versions

Objek

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

DataStore

Objek penyimpanan data dengan nama dan waktu penciptaannya.

Atribut

name string

Nama toko data Anda.

createdTime string

Stempel waktu ketika penyimpanan data dibuat dalam format waktu ISO.

EntryVersion

Objek versi entri yang dikembalikan oleh metode List Entry Versions.

Atribut

version string

Nama versi entri kualifikasi.

deleted boolean

Menunjukkan apakah entri telah dihapus.

contentLength number

Panjang konten.

createdTime string

Stempel waktu ketika versi dibuat dalam format waktu ISO.

objectCreatedTime string

Stempel waktu ketika penyimpanan data dibuat dalam format waktu ISO.

Penyimpanan data standar

Datastores

Toko Data Daftar

Parameter

Permintaan

Respons

Izin yang Diperlukan

Entries

Daftar Entri

Parameter

Permintaan

Respons

Izin yang Diperlukan

Dapatkan Entri

Parameter

Permintaan

Respons

Izin yang Diperlukan

Tetapkan Entri

Parameter

Permintaan

Respons

Izin yang Diperlukan

Laporkan Entri

Parameter

Permintaan

Respons

Izin yang Diperlukan

Peningkatan Entri

Parameter

Permintaan

Respons

Izin yang Diperlukan

Dapatkan Versi Masuk

Parameter

Permintaan

Respons

Izin yang Diperlukan

Batas

Versi Entri Daftar

Parameter

Permintaan

Respons

Izin yang Diperlukan

Objek

DataStore

Atribut

EntryVersion

Atribut

Di halaman ini