*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.

DataStoreEntry

Wpis kluczowo-wartościowy w magazynie danych.

  • ŚCIEŻKI DO ZASOBÓW
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries

Atrybuty

pathstring

Ścieżka zasobów wejścia do magazynu danych.

Formaty:

  • 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}.
createTimestring
Tylko dane wyjściowe

Data stworzenia zapisu w bazie danych. timestamp, gdy zapis został utworzony. Ten ciąg jest sformatowany jako Timestamp.

revisionIdstring
Nieodwołalny
Tylko dane wyjściowe

ID rewizji wpisu w magazynie danych.

Nowa rewizja jest wdrażana za każdym razem, gdy dane przechowywane w bazie danych są w jakikolwiek sposób zmieniane.

Format to dowolna ciąg znaków. Przykład: "foo".

revisionCreateTimestring
Tylko dane wyjściowe

Data stworzenia czasu rewizji. Ten ciąg jest sformatowany jako Timestamp.

stateEnum<string>
Tylko dane wyjściowe

Stan wejścia do magazynu danych.

Możliwe wartości:

| Wartość | Opis | | --- | --- | | STAT_UNSPECIFIED | Domyślna wartość.Ta wartość jest używana, jeśli stan jest pomijany.| | AKTYWNY | Domyślny stan wpisu nowo utworzonego magazynu danych.| | USUNIĘTE | Wejście do przechowywania danych jest oznaczone jako usunięte.W pewnym momencie w przyszłości zostanie ono permanentnie usunięte. |. Możliwe wartości:

etagstring

Ta suma kontrolna jest obliczana przez serwer na podstawie wartości innych pól i może być wysyłana na żądania aktualizacji i usuwania (a potencjalnie na pewne niestandardowe metody) w celu zapewnienia, że klient ma aktualną wartość przed kontynuacją.

valueJSON value

Wartość wpisu.

Wartość JSON może być typu „null”, „boolean”, „string”, „number”, „array” lub „object”.

idstring
Tylko dane wyjściowe

ID zasobu wejścia.

To pasuje do ostatniego segmentu ścieżki zasobów i jest dostarczane wyłącznie dla wygody.

usersarray<string>

Użytkownicy powiązani z wpisem.

attributesobject

Losowy zestaw atrybutów związanych z wejściem.

Podstawowy adres URL
https://apis.roblox.com
Zasób DataStoreEntry
{

  "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"

}

DataStoreEntry

Wyświetl rekordy przechowywania danych
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

Zwraca listę wpisów z magazynu danych.

Tylko pola path i id są wypełnione; użyj GetDataStoreEntry, aby odzyskać inne pola.

Określ zakres dzikiej karty ( - ) aby wymienić wpisy ze wszystkich zakresów.

Zakresy
universe-datastores.objects:list
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

Parametry zapytania
maxPageSizenumber

Maksymalna liczba wpisów w magazynie danych do zwrotu.Usługa może zwrócić mniej niż tę wartość.Jeśli nie określono, zwracane są maksymalnie 10 wpisów przechowywania danychMaksymalna wartość wynosi 256, a wyższe wartości są ustawione na 256.

pageTokenstring

Żeton strony, otrzymany z poprzedniego wezwania, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do następnego wezwania muszą pasować do wezwania, które dostarczyło token strony.

filterstring

Pole to można ustawić w celu filtrowania zasobów zwrotnych.

Pole filter wspiera bardzo mały podzbiór CEL:

  • Wspierany jest tylko pole id.
  • Dostępna jest tylko funkcja startsWith ; nie są wspierane żadne inne operatorzy ani wbudowane.

Przykładowy filtr: id.startsWith("foo").

showDeletedboolean

Jeśli prawda, zasoby oznaczone do usunięcia w oczekiwaniu zostaną uwzględnione w wynikach.

Odpowiedź:

Lista DataStoreEntries w kolekcji macierzystej.

dataStoreEntriesarray<DataStoreEntry>

DataStoreEntries z określonego DataStore lub DataStoreScope.

nextPageTokenstring

Token, który możesz wysłać jako parametr pageToken w celu odzyskania następnej strony. Jeśli to pole zostanie pominięte, nie ma następnych stron.

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
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}'
Odpowiedź:
{

  "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"

}

DataStoreEntry

Utwórz wpis w magazynie danych
Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

Tworzy wpis z podanym ID i wartością.

Zwraca 400 zły żądanie, jeśli wpis istnieje.

Zakresy
universe-datastores.objects:create
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

Parametry zapytania
idstring

ID do użycia dla wpisu magazynu danych, który stanie się ostatecznym składnikiem ścieżki zasobów wpisu magazynu danych.

Wartość ta powinna być ciągiem znaków 1-50 znaków. Polecamy używanie tylko małych liter, cyfr i spacji.

Treść żądaniaDataStoreEntry
Odpowiedź:DataStoreEntry
POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
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"

}'
Odpowiedź:
{

  "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"

}

DataStoreEntry

Zdobądź wpis do przechowywania danych
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Zdobywa określone wejście.

Aby uzyskać wpis w określonej wersji, dodaj @<revisionId> na końcu ścieżki.

Na przykład, aby uzyskać my-entry przy ID przeglądu 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, użyj ścieżki /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01.

Jeśli ID wejścia zawiera jedną lub więcej znaków @, a chcesz uzyskać najnowszą wersję zamiast w dowolnej konkretnej wersji, dodaj specjalny identyfikator wersji @latest do końca ścieżki.W przeciwnym razie segment ID wejścia po ostatnim @ zostanie zinterpretowany jako identyfikator wersji.

Na przykład, aby uzyskać najnowszą rewizję my-entry, użyj ścieżki /v2/universes/1234/data-stores/5678/entries/my@entry@latest.

Aby uzyskać wejście, które było aktualne w określonym czasie, dodaj @latest:<timestamp> na końcu ścieżki, gdzie <timestamp> jest w formacie RFC-3339.Podany czas musi być po epokach Unixa (1/1/1970) i nie więcej niż dziesięć minut w przyszłości.

Na przykład, aby uzyskać rewizję my-entry, która była aktualna w dniu 12/2/2024 o 06:00 UTC, użyj ścieżki /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z.

Zakresy
universe-datastores.objects:read
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

entry_idstring
Wymagane

ID wejścia.

Odpowiedź:DataStoreEntry
GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
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}'
Odpowiedź:
{

  "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"

}

DataStoreEntry

Usuń wpis w magazynie danych
Beta

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Oznacza określone wejście do usunięcia.

Wpisy nie są natychmiast usuwane; zamiast tego pole state zostanie ustawione na DELETED. Stałe usunięcie następuje po 30 dniach.

Po powodzeniu zwraca 200 OK. Jeśli wpis nie istnieje, zwraca 404 Nie znaleziono.

Zakresy
universe-datastores.objects:delete
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

entry_idstring
Wymagane

ID wejścia.

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
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}'

DataStoreEntry

Aktualizacja rekordu przechowywania danych
Beta

PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Aktualizuje wartość, atrybuty i użytkowników wpisu.

Aktualizowanie konkretnych zmian w rejestrze jest niewspierane .Jeśli określisz identyfikator wersji w ścieżce i allow_missing jest true, wniosek o aktualizację zamiast tego stworzy nową pozycję z prefiksem @<revisionId> jako częścią klucza.

Częściowe aktualizowanie jest niewspierane .Jeśli atrybuty lub użytkownicy nie są dostarczane przy aktualizacji wartości, zostaną one wyczyszczone.Wartość musi być zawsze podana przy aktualizacji wpisu.

Zakresy
universe-datastores.objects:update
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

entry_idstring
Wymagane

ID wejścia.

Parametry zapytania
allowMissingboolean

Jeśli ustawiono na prawdę, a wpis w magazynie danych nie został znaleziony, tworzony jest wpis w magazynie danych.

Treść żądaniaDataStoreEntry
Odpowiedź:DataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
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"

}'
Odpowiedź:
{

  "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"

}

DataStoreEntry

Zwiększenie rekordu przechowywania danych
Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

Zwiększa wartość określonego wpisu. Zarówno istniejąca wartość, jak i wartość wzrostu muszą być liczbami całkowitymi.

Jeśli wpis nie istnieje, tworzy wpis z określoną wartością.

Zwiększanie konkretnych rewizji wpisu jest niewspierane .Jeśli określisz identyfikator wersji w ścieżce, wniosek o zwiększenie stworzy nową pozycję z prefiksem @<revisionId> jako częścią klucza.

Znany problem: wartość może zostać zwiększona poza ważnym zakresem wartości.Kiedy tak się stanie, zwrócona wartość zostanie przycięta do ważnego zakresu, ale tylny serwer może utrzymać oryginalną wartość.Zachowanie to jest utrzymywane z powodów kompatybilności wstecznej, ale może się zmienić w przyszłej wersji tego API.

Zakresy
universe-datastores.objects:createuniverse-datastores.objects:update
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

entry_idstring
Wymagane

ID wejścia.

Treść żądania
amountnumber

Ilość, z jaką należy zwiększyć wartość wejściową. Zarówno istniejąca wartość, jak i wartość wzrostu muszą być liczbami całkowitymi.

usersarray<string>

Użytkownicy powiązani z wpisem.

Jeśli nie zostanie to zapewnione, istniejące ID użytkownika zostaną wyczyszczone.

attributesobject

Losowy zestaw atrybutów związanych z wejściem.

Jeśli nie zostanie to zapewnione, istniejące atrybuty zostaną wyczyszczone.

Odpowiedź:DataStoreEntry
POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment
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"

}'
Odpowiedź:
{

  "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"

}

DataStoreEntry

Lista rewizji wpisu przechowania danych
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

Lista zmian w zapisie przechowywania danych.

Metoda ta zwraca częściowe wpisy do przechowywania danych.

W szczególności tylko pola path, id, createTime, revisionCreateTime, revisionId, etag i state są wypełnione.Zarówno pola path i id będą miały prefiks @<version>.

Aby uzyskać pełny wpis w wersji, możesz użyć pola path dostarczonego z metodą GetDataStoreEntry, tj. GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version>.

Zakresy
universe-datastores.versions:list
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

data_store_idstring
Wymagane

ID przechowywania danych.

entry_idstring
Wymagane

ID wejścia.

Parametry zapytania
maxPageSizenumber

Maksymalna liczba zmian do zwrotu na stronę.

Usługa może zwrócić mniej niż maksymalną liczbę zmian.Jeśli nie określono, zwracane jest maksymalnie 10 rewizji.Maksymalna wartość to 100 wartości, a wyższe wartości są ustawione na 100.

pageTokenstring

Żeton strony, otrzymany z poprzedniego wezwania, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do następnego wezwania muszą pasować do wezwania, które dostarczyło token strony.

filterstring

Wspiera następujący podzbiór CEL:

  • Wspierane są tylko operatorzy &&, <= i >=.
  • Wspierany jest tylko pole revision_create_time.

Na przykład:

"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".

Odpowiedź:

Lista zmian w wpisie magazynu danych.

nextPageTokenstring

Token, który wysyłasz jako parametr pageToken w celu odzyskania następnej strony. Jeśli to pole zostanie pominięte, nie ma następnych stron.

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions
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}'
Odpowiedź:
{

  "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"

}