Standardowe magazyny danych

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Ta strona zawiera dokumentację referencyjną dotyczącą pracy z standardowymi magazynami danych.Aby uzyskać więcej informacji na temat korzystania z API, zobacz obsługę żądań API dla magazynów danych i przewodnik użytkowania.

Datastores

https://apis.roblox.com/datastores

Następujące punkty końcowe są dostępne za pośrednictwem ścieżek odnoszących się do podstawowego adresu URL.

Lista przechowywanych danych

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

Zwraca listę przechowywanych danych doświadczenia.

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
cursor string

Zapewnij żądanie następnego zestawu danych. Zobacz Kursorzy.

limit number

Maksymalna liczba przedmiotów do zwrotu.Każde wezwanie odczytuje tylko jedną partycję, więc może zwrócić mniej niż podany wartość, gdy skończą się cele na jednej partycji.

prefix string

Zapewnij powrót tylko sklepów danych z tym prefiksem.

Żądanie

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"

Odpowiedź:

200 - OK
Zwraca: 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>

Zbiór przechowywanych danych w docelowym doświadczeniu.

nextPageCursor string

Wskazuje, że istnieje więcej danych dostępnych w żądanym ustawiaćwyników. Zobacz Kursorzy.

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • List Datastores

Entries

https://apis.roblox.com/datastores

Następujące punkty końcowe są dostępne za pośrednictwem ścieżek odnoszących się do podstawowego adresu URL.

Wyświetl wyniki listy

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

Zwraca listę kluczy wejściowych w sklepdanych.

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

scope string

Wartość domyślna to global . Zobacz zakresy .

allScopes boolean

Ustaw na prawdę, aby zwrócić klucze ze wszystkich zakresów.

prefix string

Zapewnij powrót tylko kluczy z tym prefiksem.

cursor string

Zapewnij żądanie następnego zestawu danych. Zobacz Kursorzy.

limit number

Maksymalna liczba przedmiotów do zwrotu.Każde wezwanie odczytuje tylko jedną partycję, więc może zwrócić mniej niż podany wartość, gdy skończą się cele na jednej partycji.

Żądanie

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"

Odpowiedź:

200 - OK
Zwraca: object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

Zbiór kluczy wejściowych w obrębie magazynu danych docelowego.

nextPageCursor string

Wskazuje, że istnieje więcej danych dostępnych w żądanym ustawiaćwyników. Zobacz Kursorzy.

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • List Entry Keys

Otrzymaj wejście

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

Zwraca wartość i metadane związane z wpisem.

Metadane można znaleźć w nagłówkach odpowiedzi takich jak obserwuje:

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]

| nagłówek | opis | |---|---| | content-md5 | Podstawowy 64-bitowy MD5 checksum treści.Zobacz Treść-MD5.| | roblox-entry-version | Wersja zwróconego wpisu.| | roblox-entry-created-time | Czas, w którym utworzono wpis.| | roblox-entry-version-created-time | Czas, w którym stworzono tę konkretną wersję.| | roblox-entry-attributes | Atrybuty oznaczone tagiem związanym z wejściem.Zserializowany obiekt mapy JSON.| | roblox-entry-userids | Rozdzielona przecinkami lista ID użytkownika Roblox oznaczona tagiem wejścia. |

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

scope string

Wartość domyślna to global . Zobacz zakresy .

Żądanie

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"

Odpowiedź:

200 - OK
Pomyślnie odzyskano wpis.
Zwraca: object

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • Read Entry

Ustaw wejście

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

Ustawia wartość, metadane i identyfikatory użytkownika związane z wpisem.

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

matchVersion string

Dostarcz aktualizację tylko wtedy, gdy obecna wersja pasuje do tego

exclusiveCreate boolean

Twórz wpis tylko wtedy, gdy nie istnieje.

scope string

Wartość domyślna to global . Zobacz zakresy .

roblox-entry-attributes string

Atrybuty, które mają być powiązane z nową wersją wpisu. Zaszyfrowane przez obiekty mapy JSON. Jeśli nie zostaną dostarczone, istniejące atrybuty zostaną wyczyszczone.

Header
roblox-entry-userids string

Lista oddzielona przecinkami z tagami ID użytkownika Roblox oznaczonymi danymi wejściowymi. Jeśli nie zostanie podana, istniejące ID użytkownika zostaną wyczyszczone.

Header
content-md5 string

MD5 podsumowanie kodowane w bazie-64 zawartości. Zobacz Content-MD5.

Header

Żądanie

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"

Odpowiedź:

200 - OK
Zwraca: object
version string

Nazwa wersji kwalifikującego się wpisu.

deleted boolean

Wskazuje, czy wpis został usunięty.

contentLength number

Długość treści.

createdTime string

Data i czas stworzenia wersji w formacie czasu ISO.

objectCreatedTime string

Data o czasie stworzenia przechowania danych w formacie czasu ISO.

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • Create Entry

  • Update Entry

Usuń wpis

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

Oznacza wejście jako usunięte, tworząc wersję nagrobku. Wejścia są usuwane na stałe po 30 dniach.

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

scope string

Wartość domyślna to global . Zobacz zakresy .

Żądanie

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"

Odpowiedź:

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • Delete Entry

Zwiększ zapis wstępny

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

Zwiększa wartość dla wpisu o określoną kwotę lub tworzy nowy wpis z tą kwotą. Powraca wpis i metadane.

Metadane można znaleźć w nagłówkach odpowiedzi takich jak obserwuje:

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]

| nagłówek | opis | |---|---| | content-md5 | Podstawowy 64-bitowy MD5 checksum treści.Zobacz Treść-MD5.| | roblox-entry-version | Wersja zwróconego wpisu.| | roblox-entry-created-time | Czas, w którym utworzono wpis.| | roblox-entry-version-created-time | Czas, w którym stworzono tę konkretną wersję.| | roblox-entry-attributes | Atrybuty oznaczone tagiem związanym z wejściem.Zserializowany obiekt mapy JSON.| | roblox-entry-userids | Rozdzielona przecinkami lista ID użytkownika Roblox oznaczona tagiem wejścia. |

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

incrementBy number

Ilość, o którą należy zwiększyć wpis, lub początkowa wartość, jeśli nie istnieje.

scope string

Wartość domyślna to global . Zobacz zakresy .

roblox-entry-attributes string

Atrybuty, które mają być powiązane z nową wersją wpisu. Zaszyfrowane przez obiekty mapy JSON. Jeśli nie zostaną dostarczone, istniejące atrybuty zostaną wyczyszczone.

Header
roblox-entry-userids string

Lista oddzielona przecinkami z ID użytkownika Roblox, z którym jest oznaczony wpis. Jeśli nie zostanie podana, istniejące ID użytkownika zostaną wyczyszczone.

Header

Żądanie

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"

Odpowiedź:

200 - OK
Zwraca najnowszą wersję wpisu po jej zwiększeniu.
Zwraca: object

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • Create Entry

  • Update Entry

Zdobądź wersję wejściową

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

Zwraca wartość i metadane określonej wersji wpisu.

Metadane można znaleźć w nagłówkach odpowiedzi takich jak obserwuje:

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]

| nagłówek | opis | |---|---| | content-md5 | Podstawowy 64-bitowy MD5 checksum treści.Zobacz Treść-MD5.| | roblox-entry-version | Wersja zwróconego wpisu.| | roblox-entry-created-time | Czas, w którym utworzono wpis.| | roblox-entry-version-created-time | Czas, w którym stworzono tę konkretną wersję.| | roblox-entry-attributes | Atrybuty oznaczone tagiem związanym z wejściem.Zserializowany obiekt mapy JSON.| | roblox-entry-userids | Rozdzielona przecinkami lista ID użytkownika Roblox oznaczona tagiem wejścia. |

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

versionId string

Wersja do sprawdzenia.

scope string

Wartość domyślna to global . Zobacz zakresy .

Żądanie

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"

Odpowiedź:

200 - OK
Pomyślnie odzyskano wpis.
Zwraca: object

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • Read Version

Limity

Na klucz API: żądanie 5000 co 60 s na adres IP

Wersje wpisu listy

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

Zwraca listę wersji dla wpisu.

Parametry

universeId number

Identyfikator doświadczenia z bazami danych, do których chcesz uzyskać dostęp.Możesz skopiować ID wszechświata swojego doświadczenia na panelu twórcy .

Path
Wymagane
datastoreName string

Nazwa sklepdanych.

entryKey string

Klucz identyfikujący wejście.

scope string

Wartość domyślna to global . Zobacz zakresy .

cursor string

Zapewnij żądanie następnego zestawu danych (patrz Kursorzy).

startTime string

Zapewnij, aby nie uwzględniać wersji starszych niż ta data i godzina.

endTime string

Zapewnij, aby nie uwzględniać wersji starszych niż ta data i godzina.

sortOrder string

Albo Ascending (wcześniejsze wersje najpierw) lub Descending (późniejsze wersje najpierw).

limit number

Maksymalna liczba przedmiotów do zwrotu.Każde wezwanie odczytuje tylko jedną partycję, więc może zwrócić mniej niż podany wartość, gdy skończą się cele na jednej partycji.

Żądanie

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"

Odpowiedź:

200 - OK
Zwraca: object
version string

Nazwa wersji kwalifikującego się wpisu.

deleted boolean

Wskazuje, czy wpis został usunięty.

contentLength number

Długość treści.

createdTime string

Data i czas stworzenia wersji w formacie czasu ISO.

objectCreatedTime string

Data o czasie stworzenia przechowania danych w formacie czasu ISO.

Wymagane uprawnienia

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.

  • List Versions

Obiekty

Następujące obiekty opisują ładunki, które są przyjmowane lub zwracane. Więcej informacji na temat tego, kiedy te obiekty są w użyciu, można znaleźć w poszczególnych punktach końcowych.

DataStore

Obiekt przechowywania danych z jego nazwą i czasem stworzenia.

Atrybuty

name string

Nazwa twojego sklepdanych.

createdTime string

Data o czasie stworzenia przechowania danych w formacie czasu ISO.

EntryVersion

Przedmiot wersji wejściowej zwrócony przez metodę List Entry Versions.

Atrybuty

version string

Nazwa wersji kwalifikującego się wpisu.

deleted boolean

Wskazuje, czy wpis został usunięty.

contentLength number

Długość treści.

createdTime string

Data i czas stworzenia wersji w formacie czasu ISO.

objectCreatedTime string

Data o czasie stworzenia przechowania danych w formacie czasu ISO.