Przechowywanie danych z zamówienia (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ę odniesienia do pracy z przechowywaniami danych zleconych. For more information on using the API, see Przygotowanie API do danych and the Przewodnik po użyciu.

OrderedDataStores

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

Lista

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

Zwraca listę wpisów z przechowywania danych zamówionych.

Parametry

universeId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa celu, dla którego zamówiono przechowywanie danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
max_page_size number

Maksymalna liczba wpisów do zwrócenia. Usługa może zwrócić mniej niż wartość ten. Domyślną wartością jest 10 . Maksymalna wartość jest 100 , a każdy wpis ponad 100 jest zmuszony do 100 .

page_token string

Token strony otrzymany z poprzedniego wezwania List. Dostarcz to, aby odzyskać następną stronę. Gdy paguje, wszystkie pozostałe parametry dostarczone dla List muszą zgadzać się z wezwaniem dostarczającym token strony.

order_by string

Kierunek Sortowania. Domyślnie jest w górę. Wpisz desc zapisek dla Sortowania w dół.

filter string

Zakres kwalifikujących wartości wpisów do zwrócenia. 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>

Wejścia z określonego zakresu.

nextPageToken string

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

Tworzyć

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

Tworzy nową pozycję z dostępną wartością treści.

Parametry

universeId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa przechowywanej danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
id string

Nazwa pozycji.

Wymagane
CreateEntryRequest

Tworzy nową pozycję z danymi dostarczonymi.

Body
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 pozycji

path string

Droga zasobu prośba.

value number

Wartość wpisu.

Zdobądź

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

Zdobywa i zwraca określony wpis.

Parametry

universeId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa przechowywanej danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
entry string

ID zapisu.

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 pozycji

path string

Droga zasobu prośba.

value number

Wartość wpisu.

Usuń

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

Usuwa określony wpis.

Parametry

universeId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa przechowywanej danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
entry string

ID zapisu.

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ź:

Aktualizacja

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

Aktualizuje wartość wpisu i zwraca aktualizowany wpis.

Parametry

universeIdId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa przechowywanej danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
entry string

ID zapisu.

Path
Wymagane
UpdateEntryRequest

Aktualizuje wpis z nową wartością.

Body
Wymagane
allow_missing boolean

Flaga dozwalająca utworzenie wpisu, jeśli wpis nie istnieje. Zobacz Dozwól Missing Flags.

Żą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 pozycji

path string

Droga zasobu prośba.

value number

Wartość wpisu.

Przychód

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

Zwiększa wartość klucza o podanych kwotach i zwraca aktualizowaną pozycję.

Znany problem: wartości wpisu mogą przekroczyć zakres ważny, a ten stan trwa w tle. Zwrócone wartości będą skalibrowane na zakres ważny.

Parametry

universeId string

Zidentyfikator doświadczenia z przechowywanymi danymi, które chcesz uzyskać dostęp do. Zobacz identyfikator uniwersum na jakim sposób kopiować go na Creator Dashboard.

Path
Wymagane
orderedDataStore string

Nazwa przechowywanej danych.

Path
Wymagane
scope string

Nazwa zakresu przechowywania danych. Zobacz Scopes .

Path
Wymagane
entry string

ID zapisu.

Path
Wymagane
incrementEntryRequest

Zwiększa wartość wpisu.

Body
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 pozycji

path string

Droga zasobu prośba.

value number

Wartość wpisu.

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 danymi dostarczonymi.

Atrybuty

value number

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

Entry

Reprezentuje wejście.

Atrybuty

id string

Nazwa pozycji

path string

Droga zasobu prośba.

value number

Wartość wpisu.

IncrementEntryRequest

Zwiększa wartość wpisu.

Atrybuty

amount number

Ilość do zwiększenia przez wartość wejścia. Jeśli wartość wejścia przekracza maksymalną wartość wspieraną przez int64, która jest 9 223 372 036 854 775 807, wniosek kończy się błędem 400 Bad Request.

ListEntriesResponse

Lista wpisów w kolekcjarodzicielskiej.

Atrybuty

entries array<object>

Wejścia z określonego zakresu.

nextPageToken string

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

UpdateEntryRequest

Aktualizuje wpis z nową wartością.

Atrybuty

value number

Wartość do uaktualnienia zapisu. Jeśli wartość wejścia przekracza maksymalną wartość wspieraną przez int64, która to 9,223,372,036,854,775,807, wniosek kończy się błędem 400 Bad Request.