*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

DataStoreEntry

데이터 저장소의 키-값 항목.

  • 리소스 경로
  • /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

특성

pathstring

데이터 저장소 항목의 리소스 경로.

형식:

  • 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
출력 전용

데이터 저장소 항목이 생성된 시점의 타임스탬프. 이 문자열은 Timestamp 형식으로 지정됩니다.

revisionIdstring
불변
출력 전용

데이터 저장소 항목의 리버전 ID.

데이터 저장소 항목이 어떤 방식으로든 변경될 때마다 새로운 리뷰가 커밋됩니다.

형식은 임의의 문자열입니다. 예: "foo".

revisionCreateTimestring
출력 전용

리뷰가 생성된 시점의 타임스탬프. 이 문자열은 Timestamp 형식으로 지정됩니다.

stateEnum<string>
출력 전용

데이터 저장소 항목의 상태.

가능한 값:

| 값 | 설명 | | --- | --- | | STATE_UNSPECIFIED | 기본값.상태가 생략되는 경우 이 값이 사용됩니다.| | 활성 | 새로 생성된 데이터 저장소 항목의 기본 상태.| | 삭제됨 | 데이터 저장소 항목이 삭제된 상태로 표시됩니다.미래의 어느 시점에서 영구적으로 삭제됩니다. |. 가능한 값:

etagstring

이 체크섬은 다른 필드의 값을 기반으로 서버에서 계산되며, 업데이트 및 삭제 요청(그리고 특정 사용자 지정 메서드에서도 가능)에 전송되어 클라이언트가 진행하기 전에 최신 값을 갖도록 보장할 수 있습니다.

valueJSON value

항목의 값.

JSON 값은 null, boolean, string, number, array, object일 수 있습니다.

idstring
출력 전용

항목의 리소스 ID.

리소스 경로의 마지막 세그먼트와 일치하며 편의를 위해서만 제공됩니다.

usersarray<string>

엔트리와 연결된 사용자.

attributesobject

입력과 관련된 임의의 특성 집합.

기본 URL

https://apis.roblox.com
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

데이터 저장소 항목 목록
베타

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

데이터 저장소에서 엔트리 목록을 반환합니다.

pathid 필드만 채워집니다; 다른 필드를 검색하려면 GetDataStoreEntry 을 사용하십시오.

와일드카드 범위( )를 지정하여 모든 범위의 항목을 나열합니다.

범위
universe-datastores.objects:list
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

쿼리 매개 변수
maxPageSizenumber

반환할 데이터 저장소 항목의 최대 수.서비스는 이 값보다 적은 값을 반환할 수 있습니다.지정되지 않으면 최대 10개의 데이터 저장소 항목이 반환됩니다.최대 값은 256이며 더 높은 값은 256으로 설정됩니다.

pageTokenstring

이전 호출에서 받은 페이지 토큰으로, 이후 페이지를 검색합니다.

페이징할 때 후속 호출에 제공된 모든 다른 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

filterstring

이 필드는 반환된 리소스를 필터링하기 위해 설정될 수 있습니다.

filter 필드는 CEL의 아주 작은 하위 집합을 지원합니다:

  • 오직 id 필드만 지원됩니다.
  • 오직 startsWith 함수만 사용할 수 있으며 다른 연산자나 빌트인은 지원되지 않습니다.

예제 필터: id.startsWith("foo").

showDeletedboolean

참여가 true이면 보류 중인 삭제에 대해 표시된 리소스가 결과에 포함됩니다.

응답

부모 컬렉션의 DataStoreEntries 목록.

dataStoreEntriesarray<DataStoreEntry>

지정된 데이터스토어 또는 데이터스토어 스코프의 DataStoreEntries.

nextPageTokenstring

다음 페이지를 검색하기 위해 pageToken 매개변수로 보낼 수 있는 토큰입니다. 이 필드가 생략되면 후속 페이지가 없습니다.

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

{
"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

데이터 저장소 항목 생성
베타

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

제공된 ID와 값으로 항목을 생성합니다.

입력이 있으면 400 잘못된 요청을 반환합니다.

범위
universe-datastores.objects:create
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

쿼리 매개 변수
idstring

데이터 저장소 입력에 사용할 ID로, 데이터 저장소 입력의 최종 리소스 경로가 됩니다.

이 값은 1-50자 문자열이어야 합니다. 소문자, 숫자 및 하이픈만 사용하는 것이 좋습니다.

요청 본문DataStoreEntry
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"
}'
응답

{
"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

데이터 저장소 항목 가져오기
베타

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

지정된 항목을 가져옵니다.

특정 버전에서 항목을 가져오려면 경로 끝에 @<revisionId>를 추가하십시오.

예를 들어, 리버전 ID my-entry에서 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01를 가져오려면 경로 /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01를 사용하십시오.

입력 ID에 하나 이상의 @ 문자가 포함되어 있고 특정 버전이 아닌 최신 버전을 가져오려는 경우 경로 끝에 특별 버전 ID @latest 를 추가하십시오.그렇지 않으면 마지막 @ 이후의 입력 ID 세그먼트가 리뷰 ID로 해석됩니다.

예를 들어, 최신 버전의 my-entry를 가져하려면 경로 /v2/universes/1234/data-stores/5678/entries/my@entry@latest를 사용하십시오.

특정 시간에 유효했던 항목을 가져오려면 @latest:<timestamp>를 경로 끝에 추가하여 <timestamp>가 RFC-3339 형식으로 변환된 항목입니다.지정된 타임스탬프는 Unix 시대(1/1/1970) 이후이고 미래에 10분 이상 지나지 않아야 합니다.

예를 들어, 2024년 12월 2일 06:00 UTC에 현재였던 리버전 my-entry 을 가져오려면 경로 /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z 를 사용하십시오.

범위
universe-datastores.objects:read
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

entry_idstring
필수

엔트리 ID.

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

{
"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

데이터 저장소 항목 삭제
베타

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

지정된 항목을 삭제하도록 표시합니다.

항목은 즉시 삭제되지 않으며, state 필드가 DELETED로 설정됩니다. 영구 삭제는 30일 후에 발생합니다.

성공하면 200 OK를 반환합니다. 항목이 존재하지 않으면 404 찾을 수 없음을 반환합니다.

범위
universe-datastores.objects:delete
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

entry_idstring
필수

엔트리 ID.

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

데이터 저장소 항목 업데이트
베타

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

엔트리의 값, 특성 및 사용자를 업데이트합니다.

엔트리의 특정 수정을 업데이트하는 것은 지원되지 않습니다 .경로에 리비전 ID를 지정하고 allow_missingtrue 인 경우 업데이트 요청은 키의 일부로 @<revisionId> 접미사를 포함하는 새 항목을 생성합니다.

부분 업데이트는 지원되지 않습니다 .값을 업데이트할 때 특성이나 사용자가 제공되지 않으면 지워집니다.항목을 업데이트할 때 항상 값을 제공해야 합니다.

범위
universe-datastores.objects:update
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

entry_idstring
필수

엔트리 ID.

쿼리 매개 변수
allowMissingboolean

참으로 설정되고 데이터 저장소 항목이 찾을 수 없으면 데이터 저장소 항목이 생성됩니다.

요청 본문DataStoreEntry
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"
}'
응답

{
"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

증가 데이터 저장소 항목 입력
베타

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

지정된 항목의 값을 증가시킵니다. 기존 값과 증가량 모두 정수여야 합니다.

항목이 존재하지 않으면 지정된 값으로 항목을 생성합니다.

엔트리의 특정 수정 사항 증가는 지원되지 않습니다 .경로에 리버전 ID를 지정하면 증분 요청이 키의 일부로 @<revisionId> 접미사를 포함하는 새 항목을 생성합니다.

알려진 문제: 값이 유효한 범위를 넘어 증가될 수 있습니다.이런 일이 발생하면 반환된 값이 유효한 범위에 클램핑되지만 백엔드는 원래 값을 유지할 수 있습니다.이 동작은 이전 버전과의 호환성을 유지하기 위해 유지되지만 이 API의 미래 버전에서 변경될 수 있습니다.

범위
universe-datastores.objects:createuniverse-datastores.objects:update
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

entry_idstring
필수

엔트리 ID.

요청 본문
amountnumber

입력 값을 증가시키는 금액. 기존 값과 증가량 모두 정수여야 합니다.

usersarray<string>

엔트리와 연결된 사용자.

이것이 제공되지 않으면 기존 사용자 ID가 지워집니다.

attributesobject

입력과 관련된 임의의 특성 집합.

이것이 제공되지 않으면 기존 특성이 지워집니다.

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"
}'
응답

{
"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

데이터 저장소 항목 수정 목록
베타

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

데이터 저장소 항목의 리뷰 목록.

이 메서드는 부분 데이터 저장소 항목을 반환합니다.

특히, path, id, createTime, revisionCreateTime, revisionId, etagstate 필드만 채워집니다.pathid 필드 모두에는 @<version> 접미사가 있습니다.

리버전에서 전체 항목을 가져오려면 path 필드를 GetDataStoreEntry 메서드로 사용하여 GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version> 방법을 사용할 수 있습니다.

범위
universe-datastores.versions:list
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

data_store_idstring
필수

데이터 저장소 ID.

entry_idstring
필수

엔트리 ID.

쿼리 매개 변수
maxPageSizenumber

페이지당 반환할 수정 최대 수.

서비스는 최대 수의 리뷰보다 적은 수를 반환할 수 있습니다.지정되지 않으면 최대 10개의 리비전이 반환됩니다.최대 값은 100개의 값이며, 더 높은 값은 100으로 설정됩니다.

pageTokenstring

이전 호출에서 받은 페이지 토큰으로, 이후 페이지를 검색합니다.

페이징할 때 후속 호출에 제공된 모든 다른 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

filterstring

다음 하위 집합의 CEL을 지원합니다:

  • 오직 &&, <=>= 연산자만 지원됩니다.
  • 오직 revision_create_time 필드만 지원됩니다.

예를 들어:

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

응답

데이터 저장소 항목의 수정 목록.

dataStoreEntriesarray<DataStoreEntry>

데이터_스토어_엔트리의 수정.

nextPageTokenstring

다음 페이지를 검색하기 위해 pageToken 매개변수로 보내는 토큰. 이 필드가 생략되면 후속 페이지가 없습니다.

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

{
"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"
}