Kho lưu trữ dữ liệu được xếp hạng (bản 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 để làm việc với các kho dữ liệu được xếp hạng.Để biết thêm thông tin về việc sử dụng API, xem xử lý yêu cầu API cho các kho dữ liệu và hướng dẫn sử dụng .

OrderedDataStores

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

Danh sách

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

Trả về một danh sách các bản ghi từ một cửa hàng dữ liệu được xếp hạng.

Tham Số

universeId string

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

Tên của cửa hàng dữ liệu mục tiêu được đặt hàng.

Path
Bắt Buộc
scope string

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

Path
Bắt Buộc
max_page_size number

Số lượng tối đa các mục để trả về.Dịch vụ có thể trả về í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ỳ đầu vào nào trên 100 bị buộc thành 100 .

page_token string

Một token trang nhận được từ cuộc gọi trước List .Cung cấp này để lấy lại trang tiếp theo.Khi paginate, tất cả các tham số khác được cung cấp cho List phải phù hợp với cuộc gọi cung cấp token trang.

order_by string

Hướng liệt kê. Thứ tự mặc định là tăng dần. Nhập một chữ saufix desc để xuống dốc.

filter string

Phạm vi các giá trị đủ điều kiện của các mục để trả về. Xem 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
OK
Trả lại object
entries array<object>

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

nextPageToken string

Một token, có thể được gửi như page_token để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

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

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

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

Path
Bắt Buộc
scope string

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

Path
Bắt Buộc
id string

Tên của mục nhập.

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
OK
Trả lại object
id string

Tên của mục nhập

path string

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

value number

Giá trị của mục nhập.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Ghi

Nhận

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

Nhận và trả lại các thành phần được chỉ định.

Tham Số

universeId string

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

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

Path
Bắt Buộc
scope string

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

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
OK
Trả lại object
id string

Tên của mục nhập

path string

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

value number

Giá trị của mục nhập.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

Xóa

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

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

Tham Số

universeId string

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

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

Path
Bắt Buộc
scope string

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

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

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Ghi

Cập nhật

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

Cập nhật giá trị của một cái nhập và trả lại cái nhập đã cập nhật.

Tham Số

universeId string

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

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

Path
Bắt Buộc
scope string

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

Path
Bắt Buộc
entry string

ID nhập.

Path
Bắt Buộc
allow_missing boolean

Cờ để cho phép tạo một bản ghi nếu bản ghi không tồn tại. Xem Cho phép cờ bị 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
OK
Trả lại object
id string

Tên của mục nhập

path string

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

value number

Giá trị của mục nhập.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Ghi

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ố tiền cung cấp và trả lại mục đã cập nhật.

Vấn đề đã biết: Giá trị nhập có thể tăng quá phạm vi hợp lệ và điều này có thể tồn tại ở phía sau. Các giá trị trả về sẽ bị giới hạn trong phạm vi hợp lệ.

Tham Số

universeId string

ID của trải nghiệm với cửa hàng dữ liệu được xếp hạng mà bạn muốn truy cập.Xem ID Vũ trụ trên cách sao chép nó trên Bảng điều khiển Nhà sáng tạo.

Path
Bắt Buộc
orderedDataStore string

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

Path
Bắt Buộc
scope string

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

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>:increment' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "amount": <long> 

}'

Phản Hồi

200 - OK
OK
Trả lại object
id string

Tên của mục nhập

path string

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

value number

Giá trị của mục nhập.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Ghi

Đố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ị để đặt mục mới.Nếu giá trị nhập vượt quá giá trị tối đa được hỗ trợ bởi int64, đó là 9,223,372,036,854,775,807, yêu cầu thất bại với lỗi 400 Bad Request.

Entry

Đại diện cho một mục.

Thuộc Tính

id string

Tên của mục nhập

path string

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

value number

Giá trị của mục nhập.

IncrementEntryRequest

Tăng giá trị nhập.

Thuộc Tính

amount number

Số tiền để tăng 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, đó là 9,223,372,036,854,775,807, yêu cầu thất bại với lỗi 400 Bad Request.

ListEntriesResponse

Một danh sách các bài viết trong bộ sưu tập cha.

Thuộc Tính

entries array<object>

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

nextPageToken string

Một token, có thể được gửi như 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 một giá trị mới.

Thuộc Tính

value number

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