Cửa hàng dữ liệu đã đặt (Beta)

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Trang này bao gồm tài liệu tham khảo cho việc làm việc với các cửa hàng dữ liệu đã được lưu. Để biết thêm thông tin về việc sử dụng API, hãy xem Làm việc với các yêu cầu API cho các cửa hàng dữ liệu và hướng dẫn sử dụng Lưu trữ dữ liệu.

OrderedDataStores

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

Danh sách

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

Trả lại một danh sách các hàng từ một cửa hàng dữ liệu đã được xếp hạng.

Tham Số

universeId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã đặt hàng.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
max_page_size number

Số lượng tối đa các kết quả để trả lại. Dịch vụ có thể trả lại ít hơn giá trị này. Giá trị mặc định là 10 . Giá trị tối đa là 100 và bất kỳ lần nhập nào trên 100 đều bị ép thành 100 .

page_token string

Một thẻ trang đã nhận được từ cuộc gọi trước đó List. Cung cấp này để lấy lại trang sau đó. Khi trả tiền, tất cả các tham số khác được cung cấp cho List phải khớp với cuộc gọi cung cấp thẻ trang.

order_by string

Hướng liệt kí. Mặc định là thứ tự tăng dần. Nhập một desc tiền đuôi để xuống.

filter string

Phạm vi các giá trị chấm điểm của các mục để trả lại. Tham khảo Bộ lọc .

Yêu Cầu

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

Phản Hồi

200 - OK
Đồng ý
Trả lại object
entries array<object>

Các vị trí từ phạm vi được chỉ định.

nextPageToken string

Một token, which can be sent as page_token để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

Tạo

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

Tạo một mục mới với giá trị nội dung được cung cấp.

Tham Số

universeId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã được yêu cầu.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
id string

Tên của mục.

Bắt Buộc
CreateEntryRequest

Tạo một mục mới với giá trị được cung cấp.

Body
Bắt Buộc

Yêu Cầu

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

Phản Hồi

200 - OK
Đồng ý
Trả lại object
id string

Tên của mục

path string

Con đường tài nguyên của yêu cầu.

value number

Giá trị của các thông số.

Lấy

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

Lấy và trả lại hàng đã định.

Tham Số

universeId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã được yêu cầu.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
entry string

ID nhập.

Path
Bắt Buộc

Yêu Cầu

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

Phản Hồi

200 - OK
Đồng ý
Trả lại object
id string

Tên của mục

path string

Con đường tài nguyên của yêu cầu.

value number

Giá trị của các thông số.

Xóa

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

Xóa mục đã được chỉ định.

Tham Số

universeId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã được yêu cầu.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
entry string

ID nhập.

Path
Bắt Buộc

Yêu Cầu

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

Phản Hồi

Cập Nhật

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

Cập nhật giá trị một điều kiện và trả lại điều kiện đã cập nhật.

Tham Số

universeIdId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã được yêu cầu.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
entry string

ID nhập.

Path
Bắt Buộc
UpdateEntryRequest

Cập nhật mục đã được cung cấp với giá trị mới.

Body
Bắt Buộc
allow_missing boolean

Cờ để cho phép tạo một hồ sơ nếu hồ sơ đó không tồn tại. Xem cho phép các cờ thiếu .

Yêu Cầu

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

Phản Hồi

200 - OK
Đồng ý
Trả lại object
id string

Tên của mục

path string

Con đường tài nguyên của yêu cầu.

value number

Giá trị của các thông số.

Tăng

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

Tăng giá trị của chìa khóa bằng số lượng cung cấp và trả lại các thông tin đã cập nhật.

Vấn đề đã biết: Giá trị nhập có thể tăng trên giới hạn hợp lệ và nó có thể tồn tại trong hậu cần. Các giá trị đã trả lại sẽ kẹp vào giới hạn hợp lệ.

Tham Số

universeId string

Nhận dạng của trải nghiệm với các cửa hàng dữ liệu đã được lưu trữ mà bạn muốn truy cập. Xem ID Universe trên cách sao chép nó trên Creator Dashboard .

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu đã được yêu cầu.

Path
Bắt Buộc
scope string

Tên của phạm vi lưu trữ dữ liệu. Xem Scopes .

Path
Bắt Buộc
entry string

ID nhập.

Path
Bắt Buộc
incrementEntryRequest

Tăng giá trị đầu vào.

Body
Bắt Buộc

Yêu Cầu

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

Phản Hồi

200 - OK
Đồng ý
Trả lại object
id string

Tên của mục

path string

Con đường tài nguyên của yêu cầu.

value number

Giá trị của các thông số.

Đối Tượng

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

CreateEntryRequest

Tạo một mục mới với giá trị được cung cấp.

Thuộc Tính

value number

Giá trị để cài đặt mới. Nếu giá trị nhập vượt quá giá trị tối đa được hỗ trợ bởi int64, which là 9,223,372,036,854,775,807, yêu cầu thất bại với một lỗi yêu cầu 400 Bad Request.

Entry

Đại diện cho một hàng.

Thuộc Tính

id string

Tên của mục

path string

Con đường tài nguyên của yêu cầu.

value number

Giá trị của các thông số.

IncrementEntryRequest

Tăng giá trị đầu vào.

Thuộc Tính

amount number

Số tiền tăng lên bởi giá trị nhập. Nếu giá trị nhập vượt quá giá trị tối đa được hỗ trợ bởi int64, which là 9,223,372,036,854,775,807, yêu cầu thất bại với một lỗi yêu cầu 400 Bad Request.

ListEntriesResponse

Một danh sách các vị trí trong bộ sưu tậpmục cha.

Thuộc Tính

entries array<object>

Các vị trí từ phạm vi được chỉ định.

nextPageToken string

Một token, which can be sent as page_token để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

UpdateEntryRequest

Cập nhật mục đã được cung cấp với giá trị mới.

Thuộc Tính

value number

Giá trị để cập nhật hồ sơ. Nếu giá trị nhập vượt quá giá trị tối đa được hỗ trợ bởi int64, which là 9,223,372,036,854,775,807, yêu cầu thất bại với một lỗi yêu cầu 400 Bad Request.