Kho dữ liệu tiêu chuẩn

*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 tiêu chuẩn.Để 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 .

Datastores

https://apis.roblox.com/datastores

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Danh sách kho dữ liệu

GET /v1/universes/{universeId}/standard-datastores

Trả về một danh sách các kho lưu dữ liệu kinh nghiệm.

Tham Số

universeId number

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

Path
Bắt Buộc
cursor string

Cung cấp để yêu cầu bộ dữ liệu tiếp theo. Xem Con trỏ.

limit number

Số lượng tối đa các mục để trả lại.Mỗi cuộc gọi chỉ đọc một phân vùng, vì vậy nó có thể trả về ít hơn giá trị đã cho khi hết mục tiêu trên một phân vùng.

prefix string

Cung cấp để trả về chỉ các kho dữ liệu có tiền tối này.

Yêu Cầu

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "prefix=Player" \

-d "limit=5"

Phản Hồi

200 - OK
Trả lại object
application/json
{

  "datastores": [

    {

      "name": "PlayerInventory",

      "createdTime": "2022-02-18T22:38:59.9244932Z"

    },

    {

      "name": "PlayerExperience",

      "createdTime": "2022-02-18T23:00:10.4773508Z"

    },

    {

      "name": "PlayerWeapons",

      "createdTime": "2022-02-18T23:00:22.3725681Z"

    },

    {

      "name": "PlayerArmor",

      "createdTime": "2022-02-18T22:59:33.8472882Z"

    },

    {

      "name": "PlayerHP",

      "createdTime": "2022-02-18T22:58:47.6904028Z"

    }

  ],

  "nextPageCursor": "..."

}
data array<object>

Một loạt các kho dữ liệu trong trải nghiệm mục tiêu.

nextPageCursor string

Chỉ ra rằng có nhiều dữ liệu hơn có sẵn trong bộ kết quả yêu cài đặt. Xem Cursors .

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

  • Liệt Kê Kho Dữ Liệu

Entries

https://apis.roblox.com/datastores

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Danh sách các mục

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

Trả về một danh sách các chìa khóa nhập trong một kho dữ cửa hàng.

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

scope string

Giá trị mặc định là global . Xem Phạm vi .

allScopes boolean

Đặt thành true để trả về chìa khóa từ tất cả các phạm vi.

prefix string

Cung cấp trả lại chỉ các chìa khóa có tiền tố này.

cursor string

Cung cấp để yêu cầu bộ dữ liệu tiếp theo. Xem Con trỏ.

limit number

Số lượng tối đa các mục để trả lại.Mỗi cuộc gọi chỉ đọc một phân vùng, vì vậy nó có thể trả về ít hơn giá trị đã cho khi hết mục tiêu trên một phân vùng.

Yêu Cầu

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "prefix=" \

-d "limit=5"

Phản Hồi

200 - OK
Trả lại object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

Một mảng các chìa khóa nhập trong kho dữ cửa hàngmục tiêu.

nextPageCursor string

Chỉ ra rằng có nhiều dữ liệu hơn có sẵn trong bộ kết quả yêu cài đặt. Xem Cursors .

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

  • Liệt Kê Khóa Mục Nhập

Nhận được Entry

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Trả về giá trị và metadata liên quan đến một cái nhập.

metadata có thể được tìm thấy trong các tiêu đề phản hồi như theo dõi:

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| Tiêu đề | Mô tả | |---|---| | content-md5 | Giá trị kiểm tra MD5 cơ bản-64 của nội dung.Xem Nội dung-MD5 .| | roblox-entry-version | Phiên bản của mục trả về.| | roblox-entry-created-time | Thời gian mà lượt truy cập được tạo ra.| | roblox-entry-version-created-time | Thời gian mà phiên bản này đặc biệt được tạo ra.| | roblox-entry-attributes | Thuộc tính được gắn với entry.Đối tượng bản đồ JSON được serialize.| | roblox-entry-userids | Danh sách phân tách bằng phím của ID người dùng Roblox được gắn với thẻ nhập. |

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

scope string

Giá trị mặc định là global . Xem Phạm vi .

Yêu Cầu

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

Phản Hồi

200 - OK
Thành công trong việc lấy lại mục.
Trả lại object

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 Mục Nhập

Đặt thông số nhập

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Đặt giá trị, metadata và ID người dùng liên quan đến một bản ghi.

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

matchVersion string

Chỉ cung cấp để cập nhật nếu phiên bản hiện tại phù hợp với điều này

exclusiveCreate boolean

Tạo bản ghi chỉ nếu nó không tồn tại.

scope string

Giá trị mặc định là global . Xem Phạm vi .

roblox-entry-attributes string

Thuộc tính được liên kết với phiên bản mới của mục. Được serialize bởi các đối tượng bản đồ JSON. Nếu không được cung cấp, các thuộc tính hiện tại sẽ được xóa bỏ.

Header
roblox-entry-userids string

Danh sách phân tách bằng phím cách của ID người dùng Roblox được gắn thẻ với lượt truy cập. Nếu không được cung cấp, các ID người dùng hiện tại sẽ bị xóa bỏ.

Header
content-md5 string

Kiểm tra MD5 cơ bản-64 của nội dung được mã hóa. Xem Nội dung-MD5 .

Header

Yêu Cầu

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \

--header "x-api-key: ${API_KEY}" \

--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \

--header "content-type: application/json" \

--header "roblox-entry-userids: [269323]" \

--header "roblox-entry-attributes: {}" \

--d "value"

Phản Hồi

200 - OK
Trả lại object
version string

Tên phiên bản của các thành phần đủ điều kiện.

deleted boolean

Chỉ ra liệu mục nhập đã bị xóa hay chưa.

contentLength number

Chiều dài của nội dung.

createdTime string

Thời gian chạy của khi phiên bản được tạo trong định dạng thời gian ISO.

objectCreatedTime string

Thời gian của khi kho dữ liệu được tạo ra trong định dạng thời gian ISO.

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

  • Tạo Mục Nhập

  • Cập Nhật Mục Nhập

Xóa mục nhập

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Đánh dấu lượt truy cập đã bị xóa bằng cách tạo phiên bản mộ của nó. Các lượt truy cập bị xóa vĩnh viễn sau 30 ngày.

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

scope string

Giá trị mặc định là global . Xem Phạm vi .

Yêu Cầu

curl
curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

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

  • Xóa Mục Nhập

Nhập tăng Increment

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Tăng giá trị cho một cái nhập bằng một số tiền nhất định, hoặc tạo một cái nhập mới với số tiền đó. Trả về cái nhập và metadata.

metadata có thể được tìm thấy trong các tiêu đề phản hồi như theo dõi:

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| Tiêu đề | Mô tả | |---|---| | content-md5 | Giá trị kiểm tra MD5 cơ bản-64 của nội dung.Xem Nội dung-MD5 .| | roblox-entry-version | Phiên bản của mục trả về.| | roblox-entry-created-time | Thời gian mà lượt truy cập được tạo ra.| | roblox-entry-version-created-time | Thời gian mà phiên bản này đặc biệt được tạo ra.| | roblox-entry-attributes | Thuộc tính được gắn với entry.Đối tượng bản đồ JSON được serialize.| | roblox-entry-userids | Danh sách phân tách bằng phím của ID người dùng Roblox được gắn với thẻ nhập. |

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

incrementBy number

Số tiền mà lượng nhập phải được tăng, hoặc giá trị khởi động nếu nó không tồn tại.

scope string

Giá trị mặc định là global . Xem Phạm vi .

roblox-entry-attributes string

Thuộc tính được liên kết với phiên bản mới của mục. Được serialize bởi các đối tượng bản đồ JSON. Nếu không được cung cấp, các thuộc tính hiện tại sẽ được xóa bỏ.

Header
roblox-entry-userids string

Một danh sách phân cách bằng dấu phẩy các ID người dùng Roblox mà lời nhập được gắn với. Nếu không được cung cấp, các ID người dùng hiện tại sẽ bị xóa.

Header

Yêu Cầu

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \

--header "x-api-key: ${API_KEY}" \

--header 'content-length: 0' \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "incrementBy=3"

Phản Hồi

200 - OK
Trả lại phiên bản mới nhất của mục sau khi nó đã được tăng.
Trả lại object

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

  • Tạo Mục Nhập

  • Cập Nhật Mục Nhập

Nhận phiên bản nhập

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Trả về giá trị và metadata của một phiên bản cụ thể của một bài viết.

metadata có thể được tìm thấy trong các tiêu đề phản hồi như theo dõi:

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| Tiêu đề | Mô tả | |---|---| | content-md5 | Giá trị kiểm tra MD5 cơ bản-64 của nội dung.Xem Nội dung-MD5 .| | roblox-entry-version | Phiên bản của mục trả về.| | roblox-entry-created-time | Thời gian mà lượt truy cập được tạo ra.| | roblox-entry-version-created-time | Thời gian mà phiên bản này đặc biệt được tạo ra.| | roblox-entry-attributes | Thuộc tính được gắn với entry.Đối tượng bản đồ JSON được serialize.| | roblox-entry-userids | Danh sách phân tách bằng phím của ID người dùng Roblox được gắn với thẻ nhập. |

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

versionId string

Phiên bản để kiểm tra.

scope string

Giá trị mặc định là global . Xem Phạm vi .

Yêu Cầu

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Phản Hồi

200 - OK
Thành công trong việc lấy lại mục.
Trả lại object

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 Phiên Bản

Giới Hạn

Mỗi Khóa API: 5000 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Danh sách phiên bản nhập

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Trả về một danh sách các phiên bản cho một cái nhập.

Tham Số

universeId number

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

Path
Bắt Buộc
datastoreName string

Tên của kho dữ cửa hàng.

entryKey string

Chìa khóa xác định mục nhập.

scope string

Giá trị mặc định là global . Xem Phạm vi .

cursor string

Cung cấp để yêu cầu bộ dữ liệu tiếp theo (xem Cursors ).

startTime string

Cung cấp để không bao gồm các phiên bản trước thời gian này.

endTime string

Cung cấp để không bao gồm các phiên bản sau thời gian này.

sortOrder string

Hoặc Ascending (phiên bản trước đó trước tiên) hoặc Descending (phiên bản sau trước tiên).

limit number

Số lượng tối đa các mục để trả lại.Mỗi cuộc gọi chỉ đọc một phân vùng, vì vậy nó có thể trả về ít hơn giá trị đã cho khi hết mục tiêu trên một phân vùng.

Yêu Cầu

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "limit=5"

Phản Hồi

200 - OK
Trả lại object
version string

Tên phiên bản của các thành phần đủ điều kiện.

deleted boolean

Chỉ ra liệu mục nhập đã bị xóa hay chưa.

contentLength number

Chiều dài của nội dung.

createdTime string

Thời gian chạy của khi phiên bản được tạo trong định dạng thời gian ISO.

objectCreatedTime string

Thời gian của khi kho dữ liệu được tạo ra trong định dạng thời gian ISO.

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

  • Liệt Kê Các Phiên Bản

Đố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.

DataStore

Các đối tượng lưu trữ dữ liệu với tên và thời gian tạo.

Thuộc Tính

name string

Tên của kho dữ cửa hàngcủa bạn.

createdTime string

Thời gian của khi kho dữ liệu được tạo ra trong định dạng thời gian ISO.

EntryVersion

Các đối tượng phiên bản nhập lại bởi phương pháp List Entry Versions.

Thuộc Tính

version string

Tên phiên bản của các thành phần đủ điều kiện.

deleted boolean

Chỉ ra liệu mục nhập đã bị xóa hay chưa.

contentLength number

Chiều dài của nội dung.

createdTime string

Thời gian chạy của khi phiên bản được tạo trong định dạng thời gian ISO.

objectCreatedTime string

Thời gian của khi kho dữ liệu được tạo ra trong định dạng thời gian ISO.