Sortowane magazyny danych (beta)

*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 uporządkowanymi 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.

OrderedDataStores

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

Lista

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

Zwraca listę wpisów z uporządkowanego sklepdanych.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa przeznaczonego sklepu danych docelowego.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
max_page_size number

Maksymalna liczba wpisów do zwrotu.Usługa może zwrócić mniej niż tę wartość.Domyślną wartością jest 10 .Maksymalna wartość to 100 , a każde wpisanie powyżej 100 jest zmuszane do 100 .

page_token string

Żeton strony otrzymany z poprzedniego wezwania List.Dostarcz to, aby odzyskać następną stronę.Podczas paginowania wszystkie pozostałe parametry dostarczone do List muszą pasować do wezwania, które dostarcza token strony.

order_by string

Kierunek enumeracji. Domyślny porządek to wzrost. Wprowadź prefiks desc dla spadku.

filter string

Zakres kwalifikujących się wartości wpisów do zwrotu. Zobacz filtry.

Żądanie

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

Odpowiedź:

200 - OK
OK
Zwraca: object
entries array<object>

Wpisy z określonego zakresu.

nextPageToken string

Token, który można wysłać jako page_token aby odzyskać następną stronę. Jeśli to pole zostanie pominięte, nie ma następnych stron.

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.

  • Odczyt

Tworzyć

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

Tworzy nową pozycję z podaną wartością zawartości.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa zamówionego sklepu danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
id string

Nazwa wpisu.

Wymagane

Żądanie

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>
}'

Odpowiedź:

200 - OK
OK
Zwraca: object
id string

Nazwa wpisu

path string

Ścieżka zasobów z prośba.

value number

Wartość wpisu.

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.

  • Zapis

Otrzymaj

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

Zdobywa i zwraca określone wejście.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa zamówionego sklepu danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
entry string

ID wejścia.

Path
Wymagane

Żądanie

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

Odpowiedź:

200 - OK
OK
Zwraca: object
id string

Nazwa wpisu

path string

Ścieżka zasobów z prośba.

value number

Wartość wpisu.

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.

  • Odczyt

Usuń

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

Usuwa określony wpis.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa zamówionego sklepu danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
entry string

ID wejścia.

Path
Wymagane

Żądanie

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

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.

  • Zapis

Aktualizacja

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

Aktualizuje wartość rekordu i zwraca zaktualizowany rekord.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa zamówionego sklepu danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
entry string

ID wejścia.

Path
Wymagane
allow_missing boolean

Flaga, aby umożliwić utworzenie wpisu, jeśli wpis nie istnieje. Zobacz Pozwolenie na brakujące flagi.

Żądanie

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>
}'

Odpowiedź:

200 - OK
OK
Zwraca: object
id string

Nazwa wpisu

path string

Ścieżka zasobów z prośba.

value number

Wartość wpisu.

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.

  • Zapis

Zwiększenie

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

Zwiększa wartość klucza o podany kwant i zwraca zaktualizowany wpis.

Znany problem: wartości wejściowe mogą wzrosnąć poza ważnym zakresem i może to utrzymać się w tylnej części. Powracające wartości będą pasować do ważnego zakresu.

Parametry

universeId string

Identyfikator doświadczenia z przechowywanymi danymi zamówionymi, do których chcesz uzyskać dostęp.Zobacz ID wszechświata na temat tego, jak go skopiować na Pulpicie nawigacyjnym twórcy.

Path
Wymagane
orderedDataStore string

Nazwa zamówionego sklepu danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Zakresy.

Path
Wymagane
entry string

ID wejścia.

Path
Wymagane

Żądanie

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>
}'

Odpowiedź:

200 - OK
OK
Zwraca: object
id string

Nazwa wpisu

path string

Ścieżka zasobów z prośba.

value number

Wartość wpisu.

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.

  • Zapis

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.

CreateEntryRequest

Tworzy nową pozycję z podaną wartością.

Atrybuty

value number

Wartość do ustawienia nowego wpisu.Jeśli wartość wejściowa przekracza maksymalną wartość wspieraną przez int64, która wynosi 9,223,372,036,854,775,807, żądanie kończy się błędem 400 Bad Request.

Entry

Reprezentuje wejście.

Atrybuty

id string

Nazwa wpisu

path string

Ścieżka zasobów z prośba.

value number

Wartość wpisu.

IncrementEntryRequest

Zwiększenie wartości wejściowej.

Atrybuty

amount number

Ilość, którą należy zwiększyć o wartość wejściową.Jeśli wartość wejściowa przekracza maksymalną wartość wspieraną przez int64, która wynosi 9,223,372,036,854,775,807, żądanie kończy się błędem 400 Bad Request.

ListEntriesResponse

Lista wpisów w kolekcjamacierzystej.

Atrybuty

entries array<object>

Wpisy z określonego zakresu.

nextPageToken string

Token, który można wysłać jako page_token aby odzyskać następną stronę. Jeśli to pole zostanie pominięte, nie ma następnych stron.

UpdateEntryRequest

Aktualizuje wpis dostarczony za pomocą nowej wartości.

Atrybuty

value number

Wartość do aktualizacji wpisu.Jeśli wartość wejściowa przekracza maksymalną wartość wspieraną przez int64, która wynosi 9,223,372,036,854,775,807, żądanie kończy się błędem 400 Bad Request.