정렬된 데이터 저장소(베타)

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

이 페이지에는 주문형 데이터 저장소 작업에 대한 참조 문서가 포함되어 있습니다.API 사용에 대한 자세한 내용은 데이터 저장소용 API 요청 처리 및 사용 가이드를 참조하십시오.

OrderedDataStores

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

목록

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

주문된 데이터 상점엔트리 목록을 반환합니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

대상 주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
max_page_size number

반환할 최대 항목 수.서비스는 이 값보다 적은 값을 반환할 수 있습니다.기본값은 10 입니다.최대 값은 100 이고, 100 이상의 모든 입력은 100 으로 강제됩니다.

page_token string

이전의 List 호출에서 받은 페이지 토큰.이것을 제공하여 다음 페이지를 검색합니다.페이징할 때, 모든 다른 매개변수는 List에 제공된 페이지 토큰을 제공하는 호출과 일치해야 합니다.

order_by string

열거 방향. 기본 순서는 상승 순입니다. 내림차순으로 입력하려면 desc 접미사를 입력하십시오.

filter string

반환할 엔트리의 적격 값 범위. 참조 필터.

요청

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

응답

200 - OK
OK
반환: object
entries array<object>

지정된 범위의 항목.

nextPageToken string

다음 페이지를 검색하기 위해 page_token로 전송할 수 있는 토큰. 이 필드가 생략되면 후속 페이지가 없습니다.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

만들기

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

제공된 콘텐츠 값으로 새 항목을 생성합니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
id string

항목의 이름.

필수

요청

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> 

}'

응답

200 - OK
OK
반환: object
id string

항목의 이름

path string

요청의 리소스 경로.

value number

항목의 값.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 쓰기

가져오기

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

지정된 항목을 가져오고 반환합니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
entry string

엔트리 ID.

Path
필수

요청

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

응답

200 - OK
OK
반환: object
id string

항목의 이름

path string

요청의 리소스 경로.

value number

항목의 값.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 읽기

삭제

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

지정된 항목을 삭제합니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
entry string

엔트리 ID.

Path
필수

요청

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

응답

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 쓰기

업데이트

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

항목 값을 업데이트하고 업데이트된 항목을 반환합니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
entry string

엔트리 ID.

Path
필수
allow_missing boolean

입력이 존재하지 않는 경우 입력 생성을 허용하는 플래그. 참조하십시오 누락된 플래그 허용.

요청

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> 

}'

응답

200 - OK
OK
반환: object
id string

항목의 이름

path string

요청의 리소스 경로.

value number

항목의 값.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 쓰기

증가량

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

제공된 금액으로 키 값을 증가시키고 업데이트된 항목을 반환합니다.

알려진 문제: 입력 값이 유효한 범위를 초과할 수 있고 백엔드에 지속될 수 있습니다. 반환된 값은 유효한 범위에 클램핑됩니다.

매개 변수

universeId string

액세스하려는 주문형 데이터 저장소가 있는 경험의 식별자.크리에이터 대시보드에서 복사하는 방법에 대해 유니버스 ID 를 참조하십시오.

Path
필수
orderedDataStore string

주문된 데이터 상점이름.

Path
필수
scope string

데이터 저장소 범위의 이름. 참조 범위.

Path
필수
entry string

엔트리 ID.

Path
필수

요청

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> 

}'

응답

200 - OK
OK
반환: object
id string

항목의 이름

path string

요청의 리소스 경로.

value number

항목의 값.

필요한 권한

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한 자세한 내용은 API 키 관리에서 확인하세요.

  • 쓰기

개체

다음 개체는 수락되거나 반환되는 페이로드를 설명합니다. 이러한 개체가 사용되는 시기에 대한 자세한 정보는 각 개별 끝점을 참고하세요.

CreateEntryRequest

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

특성

value number

새 항목을 설정할 값.입력 값이 int64에서 지원하는 최대 값인 9,223,372,036,854,775,807을 초과하면 요청이 400 잘못된 요청 오류로 실패합니다.

Entry

엔트리를 나타냅니다.

특성

id string

항목의 이름

path string

요청의 리소스 경로.

value number

항목의 값.

IncrementEntryRequest

증가 항목 값을 입력합니다.

특성

amount number

입력 값으로 증가할 금액.입력 값이 int64에서 지원하는 최대 값인 9,223,372,036,854,775,807을 초과하면 요청이 400 잘못된 요청 오류로 실패합니다.

ListEntriesResponse

부모 컬렉션의 항목 목록.

특성

entries array<object>

지정된 범위의 항목.

nextPageToken string

다음 페이지를 검색하기 위해 page_token로 전송할 수 있는 토큰. 이 필드가 생략되면 후속 페이지가 없습니다.

UpdateEntryRequest

새 값으로 제공된 항목을 업데이트합니다.

특성

value number

항목을 업데이트할 값.입력 값이 int64에서 지원하는 최대 값인 9,223,372,036,854,775,807을 초과하면 요청이 400 잘못된 요청 오류로 실패합니다.