자산 API

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

Roblox에서 자산을 생성하려면 다음 요청 및 응답 전송 및 수신을 사용하여 자산을 만들 수 있습니다. 자산 사용에 대한 자세한 내용은 사용 가이드를 참조하십시오.

Assets

https://apis.roblox.com/assets

자산 버전 목록

GET /assets/v1/assets/{assetId}/versions

옵션 페이지 표시를 사용하여 특정 자산의 모든 버전을 나열합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path

필수

maxPageSize number

응답에 포함할 자산 버전 수를 지정합니다. 유효한 값은 1부터 50(포함)입니다. 제공되지 않으면 기본값은 8입니다.

pageToken string

페이지 번호입니다. 값은 이전 요청에서 얻은 값으로 이전 자산 버전의 다음 페이지를 검색할 수 있습니다.

요청

List Asset Versions

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'

응답

기타 상태 코드

필요한 권한

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

읽기

OAuth 2.0 애플리케이션에서 이 엔드포인트를 사용하려면 다음 범위가 필요합니다. OAuth 2.0 애플리케이션 등록 방법에 대한 자세한 내용은 앱 등록 및 심사에서 확인하세요.

asset:read

한도

각 API 키별: IP 주소당 60초마다 60 요청

롤백 자산 버전

POST /assets/v1/assets/{assetId}/versions:rollback

특정 이전 버전으로 자산을 롤백합니다.

매개 변수

assetId string

자산의 고유 식별자.

Path

필수

assetVersion string

자산 버전 경로가 assets/{assetId}/versions/{versionNumber} 형식입니다.

FormData

필수

요청

Rollback Asset Versions

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions:rollback' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json' \
--data '{\"assetVersion\":\"assets/{assetId}/versions/{versionNumber}\"}'

응답

기타 상태 코드

필요한 권한

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

읽기
쓰기

asset:read
asset:write

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 얻기

GET /v1/assets

특정 자산 콘텐츠 및 메타데이터를 검색합니다.

매개 변수

assetId

자산의 고유 식별자.

Path

필수

readMask string

설명, 표시 이름, 아이콘, 소셜 링크 및 미리보기를 포함한 자산 메타데이터 필드를 가져오다. 예: description%2CdisplayName , previews%2CtwitchSocialLink .

요청

Get Asset without readMask

curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'

Get Asset with readMask

curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'

응답

기타 상태 코드

필요한 권한

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

읽기

asset:read

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 생성

POST /v1/assets

지정된 콘텐츠 및 메타데이터를 가진 자산을 생성합니다.

자산을 생성할 때 소셜 링크 개체를 추가할 수 없습니다. 대신 자산 업데이트를 사용하십시오.

매개 변수

request

생성 또는 업데이트할 자산 특성. 다음 예시 요청과 같은 형식의 데이터를 보내세요.

FormData

필수

fileContent string

이진 자산 파일 경로 및 콘텐츠 입력. 형식: fileContent=@"/filepath/{File}";type={ContentType} .예: fileContent=@"/filepath/model.fbx";type=model/fbx .참조 콘텐츠 유형 .

FormData

필수

요청

Create Asset

curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \
--header 'x-api-key: {apiKey}' \
--form 'request="{ 
  \"assetType\": \"Model\",  
  \"displayName\": \"Name\", 
  \"description\": \"This is a description\", 
  \"creationContext\": { 
    \"creator\": { 
      \"userId\": \"${userId}\" 
    } 
  } 
}"' \
--form 'fileContent=@"/filepath/model.fbx";type=model/fbx'

응답

200 - OK

생성 상태를 확인하기 위한 작업 ID를 반환합니다.

반환: object

done boolean

false 이면 작업이 여전히 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

path string

서버에 할당된 리소스 경로입니다. 기본 형식은 operations/{operation_id} 입니다.

response object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

기타 상태 코드

필요한 권한

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

읽기
쓰기

asset:read
asset:write

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 업데이트

PATCH /v1/assets/{assetId}

설명, 표시 이름, 아이콘, 소셜 링크 및 미리보기를 포함한 자산을 업데이트합니다. 현재 모델에 대해 콘텐츠 본문만 업데이트할 수 있습니다. 아이콘과 미리보기는 이미지 자산이어야 합니다. 아이콘은 정사각형 크기여야 합니다.

매개 변수

request

다음 예시 요청처럼 형식 데이터를 보내십시오.

FormData

필수

fileContent string

이진 자산 파일 경로 및 콘텐츠 입력. 형식: fileContent=@"/filepath/{File}";type={ContentType} .예: fileContent=@"/filepath/model.fbx";type=model/fbx .참조 콘텐츠 유형 .

FormData

updateMask string

설명, 표시 이름, 아이콘 및 미리 보기를 포함한 자산 메타 데이터 필드를 업데이트합니다. 예: description%2CdisplayName , previews%2CtwitchSocialLink .

요청

Update Content Only and Create a New Version

curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": {assetId} }"' \
--form 'fileContent="@\"{file-path}\""'

Update Content and Metadata

curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
--header 'x-api-key: {apiKey}' \
--form 'request="{
    \"assetType\": \"{assetType}\",
    \"assetId\": {assetId},
    \"displayName\": \"{new display name}\",
    \"description\": \"{new description}\",    
    \"creationContext\": { 
        \"creator\": {
            \"userId\": {userId}
        },
        \"expectedPrice\":{expectedPrice}
    },
}"' \
--form 'fileContent=@\"{file-path}\"'

Update a List of Previews

curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=previews' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"previews\": [{\"asset\": \"assets/123\", \"altText\": \"Your alt text.\"}]}"'

Update Social Links

curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'

응답

200 - OK

업데이트 상태를 확인하는 데 필요한 작업 ID 반환 / 업데이트된 메타데이터 필드를 반환합니다.

반환: object

application/json

{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}

done boolean

false 이면 작업이 여전히 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

path string

서버에 할당된 리소스 경로입니다. 기본 형식은 operations/{operation_id} 입니다.

response object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

기타 상태 코드

필요한 권한

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

읽기
쓰기

asset:read
asset:write

한도

각 API 키별: IP 주소당 60초마다 60 요청

자산 버전 받기

GET /v1/assets/{assetId}/versions/{versionNumber}

자산 ID 및 버전 번호로 특정 자산 버전을 검색하십시오.

매개 변수

assetId string

자산의 고유 식별자.

Path

필수

versionNumber string

버전 번호.

Path

필수

요청

Get Asset Version

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'

응답

기타 상태 코드

필요한 권한

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

읽기

asset:read

한도

각 API 키별: IP 주소당 60초마다 60 요청

작업 얻기

GET /v1/operations/{operationId}

반환된 작업 ID를 사용하여 자산 생성 또는 업데이트 결과를 얻습니다. API 키 권한에 대해 읽기를 필요로 하며, OAuth 2.0 앱에 대해 자산:읽기를 필요로 합니다.

요청

Get Operation

curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'

응답

200 - OK

반환: object

done boolean

false 이면 작업이 여전히 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

path string

서버에 할당된 리소스 경로입니다. 기본 형식은 operations/{operation_id} 입니다.

response object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

기타 상태 코드

필요한 권한

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

읽기

asset:read

한도

각 API 키별: IP 주소당 60초마다 60 요청

개체

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

Any

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

특성

@type string

서식화된 메시지의 형식입니다.

Asset

자산을 나타냅니다.

특성

assetId number

자산의 고유 식별자. 자산 업데이트에 필요합니다. 자산 업데이트 .

assetType string

자산 입력. 다음 중 하나만 될 수 있습니다 Audio, Decal, 또는 Model 필요합니다. 2>자산 생성을2> 위해 필요합니다.

creationContext object

메타데이터 및 크리에이터 정보와 같은 자산 내용이 아닌 생성 컨텍스트. 자산 생성을 위해 필요합니다. 자산 생성 작업에 필요합니다.

description string

자산에 대한 설명. 1000자 제한. 자산 생성에 필요합니다. 자산 생성 을

displayName string

자산의 이름을 표시합니다. 자산 생성에 필요합니다. 자산 이름 생성 .

icon string

아이콘에 대한 리소스 경로.

moderationResult object

자산에 대한 조정 결과.

path string

자산의 반환된 리소스 경로. 형식: assets/{assetId} . 예시: assets/2205400862 .

previews array<object>

각 자산 경로와 alt 텍스트가 있는 미리 보기 목록. 미리 보기는 이미지 자산이어야 합니다.

revisionCreateTime string

현재 리뷰의 생성 시간 날짜입니다.

revisionId string

자산의 개정 ID. 자산의 모든 변경 사항에 대해 versionNumber 에 해당합니다. 형식은 정수 문자열입니다. 예: 1 .

socialLink object

자산에 대한 소셜 미디어 링크. 최대 3개의 자산당 최대 3개. 개체 이름

CreationContext

메타데이터 및 크리에이터 정보와 같은 자산 내용이 아닌 생성 컨텍스트. 자산 생성을 위해 필요합니다. 자산 생성 작업에 필요합니다.

특성

creator object

크리에이터를 나타냅니다.

필수

expectedPrice number

Robux에서 예상되는 자산 업로드 수수료입니다. 실제 가격이 예상보다 높으면 400 오류가 발생하여 작업이 실패합니다.

Creator

크리에이터를 나타냅니다.

특성

groupId number

그룹 ID. 자산이 그룹 소유인 경우 필요합니다.

userId number

자산이 개별 사용자 소유인 경우 필요합니다.

ModerationResult

자산에 대한 조정 결과.

특성

moderationState string

자산의 조정 상태. MODERATION_STATE_REVIEWING , MODERATION_STATE_REJECTED 또는 MODERATION_STATE_APPROVED 일 수 있습니다.

Operation

이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.

특성

done boolean

false 이면 작업이 여전히 진행 중입니다. true 이면 작업이 완료됩니다.

error object

오류 상태를 설명하는 논리적 오류 모델.

metadata object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

path string

서버에 할당된 리소스 경로입니다. 기본 형식은 operations/{operation_id} 입니다.

response object

형식 지정자를 포함한 임의의 인식 메시지와 @type 형식의 메시지를 설명합니다.

Preview

자산 미리보기.

특성

altText string

미리 보기 자산에 대한 얼트 텍스트.

asset string

미리 보기 자산 경로.

SocialLink

자산에 대한 소셜 미디어 링크. 최대 3개의 자산당 최대 3개. 개체 이름

특성

title string

소셜 미디어 연결대한 옵션 타이틀. 크리에이터 허브에서는 사용되지 않습니다.

uri string

소셜 미디어 연결에 대한 유리. 유형의 연결에 대한 예상 형식과 일치해야 합니다. 예를 들어, twitchSocialLink 개체의 타이틀은 https://twitch.tv/your-channel 형식이어야 합니다.

Status

오류 상태를 설명하는 논리적 오류 모델.

특성

code number

HTTP 상태 코드.

details array<object>

오류 세부 정보가 포함된 메시지 목록.

message string

오류 메시지.