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

DataStoreEntry

Một cái nhập key-value trong một kho dữ liệu.

  • ĐƯỜNG DẪN TÀI NGUYÊN
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries

Thuộc Tính

pathstring

Con đường tài nguyên của lưu trữ dữ liệu nhập.

Định dạng:

  • universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}
  • universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}.
createTimestring
Chỉ Xuất

Thời gian chạy khi lưu trữ dữ liệu được tạo ra. Chuỗi này được định dạng là Dấu thời gian.

revisionIdstring
Bất Biến
Chỉ Xuất

ID sửa đổi của mục nhập cửa hàng dữ liệu.

Một phiên bản mới được cam kết bất cứ khi nào lưu trữ dữ liệu bị thay đổi theo bất kỳ cách nào.

Định dạng là một chuỗi ngẫu nhiên. Ví dụ: "foo".

revisionCreateTimestring
Chỉ Xuất

Thời gian chạy khi phiên bản được tạo. Chuỗi này được định dạng là Dấu thời gian.

stateEnum<string>
Chỉ Xuất

Tình trạng của lưu trữ dữ liệu nhập.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | STATE_UNSPECIFIED | Giá trị mặc định.Giá trị này được sử dụng nếu trạng thái bị bỏ qua.| | HOẠT ĐỘNG | Tình trạng mặc định của một đầu vào kho lưu trữ dữ liệu mới tạo.| | ĐÃ XÓA | Thành phần lưu trữ dữ liệu được đánh dấu là bị xóa.Tại một thời điểm nào đó trong tương lai, nó sẽ bị xóa vĩnh viễn. |. Giá trị có thể:

etagstring

Checksum này được tính toán bởi máy chủ dựa trên giá trị của các trường khác, và có thể được gửi trong các yêu cầu cập nhật và xóa (và có thể tiềm ẩn trên một số phương pháp tùy chỉnh cụ thể) để đảm bảo khách hàng có giá trị mới nhất trước khi tiến hành.

valueJSON value

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

Giá trị JSON có thể là null, boolean, string, number, array hoặc object.

idstring
Chỉ Xuất

ID tài nguyên của mục.

Điều này phù hợp với phần cuối cùng của con đường tài nguyên và chỉ được cung cấp để tiện lợi.

usersarray<string>

Người dùng liên quan đến mục nhập.

attributesobject

Một bộ các thuộc tính ngẫu nhiên liên quan đến mục nhập.

URL Cơ Sở
https://apis.roblox.com
Tài nguyên DataStoreEntry
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Danh sách các bản ghi Kho dữ liệu
Bản Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

Trả về một danh sách các bản ghi từ một kho dữ liệu.

Chỉ các trường path và id được lấp đầy; sử dụng GetDataStoreEntry để lấy lại các trường khác.

Xác định phạm vi hoang dã ( - ) để liệt kê các mục từ tất cả các phạm vi.

Phạm Vi
universe-datastores.objects:list
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

Tham Số Truy Vấn
maxPageSizenumber

Số lượng tối đa các điểm lưu trữ dữ liệu để trả về.Dịch vụ có thể trả về ít hơn giá trị này.Nếu không được xác định, tối đa 10 lượt truy cập kho dữ liệu được trả về.Giá trị tối đa là 256 và giá trị cao hơn được đặt thành 256.

pageTokenstring

Một token trang, nhận từ cuộc gọi trước, để lấy lại trang tiếp theo.

Khi paginate, tất cả các tham số khác được cung cấp cho cuộc gọi tiếp theo phải phù hợp với cuộc gọi cung cấp token trang.

filterstring

Trường này có thể được đặt để lọc các tài nguyên được trả về.

Trường filter hỗ trợ một phần rất nhỏ của CEL:

  • Chỉ có trường id hỗ trợ.
  • Chỉ có chức năng startsWith có sẵn; không có nhà vận hành khác hoặc xây dựng bên trong được hỗ trợ.

Ví dụ bộ lọc: id.startsWith("foo").

showDeletedboolean

Nếu đúng, tài nguyên được đánh dấu cho việc xóa chờ sẽ được bao gồm trong kết quả.

Phản Hồi

Một danh sách các DataStoreEntries trong bộ sưu tập cha.

dataStoreEntriesarray<DataStoreEntry>

Các DataStoreEntries từ DataStore hoặc DataStoreScope được chỉ định.

nextPageTokenstring

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

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?maxPageSize=10&pageToken={string}&filter={string}&showDeleted={boolean}' \

  -H 'x-api-key: {your-api-key}'
Phản Hồi
{

  "dataStoreEntries": [

    {

      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

      "createTime": "2023-07-05T12:34:56Z",

      "revisionId": "string",

      "revisionCreateTime": "2023-07-05T12:34:56Z",

      "state": "STATE_UNSPECIFIED",

      "etag": "string",

      "value": "JSON value",

      "id": "string",

      "users": [

        "string"

      ],

      "attributes": "object"

    }

  ],

  "nextPageToken": "string"

}

DataStoreEntry

Tạo cửa hàng dữ liệu nhập
Bản Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

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

Trả về một yêu cầu tồi 400 nếu mục tồn tại.

Phạm Vi
universe-datastores.objects:create
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

Tham Số Truy Vấn
idstring

ID để sử dụng cho lưu trữ dữ liệu, sẽ trở thành thành phần cuối cùng trong con đường tài nguyên của lưu trữ dữ liệu.

Giá trị này nên là một chuỗi 1-50 ký tự. Chúng tôi khuyên bạn nên sử dụng chỉ các chữ cái thấp hơn, các chữ số và dấu gạch ngang.

Yêu Cầu Cơ ThểDataStoreEntry
Phản HồiDataStoreEntry
POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?id=my-entry' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "etag": "string",

  "value": "JSON value",

  "users": [

    "string"

  ],

  "attributes": "object"

}'
Phản Hồi
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Nhận được lưu trữ dữ liệu Entry
Bản Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Nhận được các thành phần được định.

Để lấy bản ghi tại một phiên bản cụ thể, thêm @<revisionId> vào cuối đường dẫn.

Ví dụ, để có được my-entry tại ID bản sửa đổi 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, sử dụng con đường /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 .

Nếu ID nhập của bạn chứa một hoặc nhiều ký tự @ và bạn muốn nhận phiên bản mới nhất thay vì tại bất kỳ phiên bản cụ thể nào, hãy thêm ID phiên bản đặc biệt @latest vào cuối con đường.Nếu không, phần của ID nhập sau cùng @ sẽ được giải thích là một ID phiên bản.

Ví dụ, để có được phiên bản mới nhất của my-entry, hãy sử dụng con đường /cloud/v2/universes/1234/data-stores/5678/entries/my@entry@latest.

Để lấy các thành phần hiện tại tại một thời điểm cụ thể, thêm @latest:<timestamp> vào cuối đường dẫn, nơi <timestamp> được định dạng theo tiêu chuẩn RFC-3339.Thời gian được cung cấp phải là sau kỷ nguyên Unix (1/1/1970) và không quá mười phút trong tương lai.

Ví dụ, để lấy phiên bản của my-entry hiện tại vào ngày 12/2/2024 lúc 06:00 UTC, hãy sử dụng con đường /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z .

Phạm Vi
universe-datastores.objects:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

entry_idstring
Bắt Buộc

ID nhập.

Phản HồiDataStoreEntry
GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'
Phản Hồi
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Xóa lưu trữ dữ liệu Entry
Bản Beta

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Đánh dấu vào lượt truy cập được chỉ định để xóa.

Các mục không bị xóa ngay lập tức; thay vào đó, trường state sẽ được đặt thành DELETED. Xóa vĩnh viễn xảy ra sau 30 ngày.

Khi thành công, trả về 200 OK. Nếu mục không tồn tại, trả về 404 Not Found.

Phạm Vi
universe-datastores.objects:delete
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

entry_idstring
Bắt Buộc

ID nhập.

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'

DataStoreEntry

Cập nhật lưu trữ cơ sở dữ liệu Entry
Bản Beta

PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Cập nhật giá trị, thuộc tính và người dùng của một cái nhập.

Cập nhật các sửa đổi cụ thể của mục là không được hỗ trợ .Nếu bạn xác định một ID phiên bản trong đường dẫn và allow_missing là true, yêu cầu cập nhật sẽ thay vào đó tạo một lượt truy cập mới với chữ @<revisionId> làm phần của chìa khóa.

Cập nhật một phần không được hỗ trợ . Nếu các thuộc tính hoặc người dùng không được cung cấp khi cập nhật giá trị, chúng sẽ được xóa.Giá trị phải luôn được cung cấp khi cập nhật một bản ghi.

Phạm Vi
universe-datastores.objects:update
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

entry_idstring
Bắt Buộc

ID nhập.

Tham Số Truy Vấn
allowMissingboolean

Nếu được đặt thành true, và không tìm thấy được lưu trữ dữ liệu, một lưu trữ dữ liệu được tạo ra.

Yêu Cầu Cơ ThểDataStoreEntry
Phản HồiDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}?allowMissing={boolean}' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "etag": "string",

  "value": "JSON value",

  "users": [

    "string"

  ],

  "attributes": "object"

}'
Phản Hồi
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Tăng cường lưu trữ dữ liệu cửa hàng nhập
Bản Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

Tăng giá trị của mục được chỉ định. Cả giá trị hiện tại và số tăng phải là số lẻ.

Nếu mục không tồn tại, tạo một mục với giá trị được định.

Tăng các sửa đổi cụ thể của mục là không được hỗ trợ .Nếu bạn xác định một ID phiên bản trong đường dẫn, yêu cầu tăng sẽ tạo một lượt truy cập mới với chữ sau @<revisionId> là một phần của chìa khóa.

Vấn đề đã biết: giá trị có thể được tăng quá phạm vi giá trị hợp lệ.Khi điều này xảy ra, giá trị trả về sẽ bị giữ lại trong phạm vi hợp lệ, nhưng backend có thể giữ nguyên giá trị ban đầu.Hành vi này được duy trì vì lý do tương thích ngược, nhưng có thể thay đổi trong phiên bản API trong tương lai.

Phạm Vi
universe-datastores.objects:createuniverse-datastores.objects:update
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

entry_idstring
Bắt Buộc

ID nhập.

Yêu Cầu Cơ Thể
amountnumber

Số tiền để tăng giá trị nhập. Cả giá trị hiện tại và số tăng phải là số lẻ.

usersarray<string>

Người dùng liên quan đến mục nhập.

Nếu không có, các ID người dùng hiện tại sẽ bị xóa.

attributesobject

Một bộ các thuộc tính ngẫu nhiên liên quan đến mục nhập.

Nếu không có, các thuộc tính hiện có sẽ bị xóa.

Phản HồiDataStoreEntry
POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "amount": "number",

  "users": [

    "string"

  ],

  "attributes": "object"

}'
Phản Hồi
{

  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

  "createTime": "2023-07-05T12:34:56Z",

  "revisionId": "string",

  "revisionCreateTime": "2023-07-05T12:34:56Z",

  "state": "STATE_UNSPECIFIED",

  "etag": "string",

  "value": "JSON value",

  "id": "string",

  "users": [

    "string"

  ],

  "attributes": "object"

}

DataStoreEntry

Danh sách sửa đổi lưu trữ cửa hàng dữ liệu
Bản Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

Danh sách sửa đổi của lưu trữ dữ liệu bản ghi.

Phương thức này trả về các đầu vào lưu trữ dữ liệu một phần.

Đặc biệt, chỉ có các trường path , id , createTime , revisionCreateTime , revisionId , etag và state có được điền vào.Cả hai trường path và id sẽ có một chữ sau @<version>.

Để có được toàn bộ lượt truy cập tại một phiên bản, bạn có thể sử dụng trường path cung cấp với phương pháp GetDataStoreEntry, tức là GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>.

Phạm Vi
universe-datastores.versions:list
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

data_store_idstring
Bắt Buộc

ID kho dữ liệu.

entry_idstring
Bắt Buộc

ID nhập.

Tham Số Truy Vấn
maxPageSizenumber

Số lượng sửa đổi tối đa để trả lại mỗi trang.

Dịch vụ có thể trả về ít hơn số lượng sửa đổi tối đa.Nếu không được xác định, tối đa 10 phiên bản được trả về.Giá trị tối đa là 100 giá trị và giá trị cao hơn được đặt thành 100.

pageTokenstring

Một token trang, nhận từ cuộc gọi trước, để lấy lại trang tiếp theo.

Khi paginate, tất cả các tham số khác được cung cấp cho cuộc gọi tiếp theo phải phù hợp với cuộc gọi cung cấp token trang.

filterstring

Hỗ trợ các phần sau của CEL:

  • Chỉ có các && , <= , và >= operator được hỗ trợ.
  • Chỉ có trường revision_create_time hỗ trợ.

Ví dụ:

"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".

Phản Hồi

Một danh sách các bản sửa đổi của một cửa hàng dữ liệu.

dataStoreEntriesarray<DataStoreEntry>

Các sửa đổi của data_store_entry.

nextPageTokenstring

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

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Phản Hồi
{

  "dataStoreEntries": [

    {

      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",

      "createTime": "2023-07-05T12:34:56Z",

      "revisionId": "string",

      "revisionCreateTime": "2023-07-05T12:34:56Z",

      "state": "STATE_UNSPECIFIED",

      "etag": "string",

      "value": "JSON value",

      "id": "string",

      "users": [

        "string"

      ],

      "attributes": "object"

    }

  ],

  "nextPageToken": "string"

}