Unity UDP API 사용 가이드
Unity의 UDP API를 사용하면 앱을 쉽게 빌드하고 UDP 콘솔에 업로드할 수 있습니다. 이 문서는 기본적인 사용법과 다양한 설정 방법에 대해 설명합니다.
API 구조
UDP API의 기본 구조는 다음과 같습니다:
https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx[&obbType=xxxx]
API 파라미터 설명
아래 표는 UDP API에서 사용되는 주요 파라미터에 대한 설명입니다.
| 파라미터 | 설명 |
|---|---|
| orgId | 바이너리 파일을 업로드할 게임의 조직 ID입니다. |
| clientId | 바이너리 파일을 업로드할 게임의 클라이언트 ID입니다. |
| token | UDP 콘솔의 개발자 API 페이지에서 생성된 인증 토큰입니다. |
| obbType | 업로드할 OBB 파일 타입입니다 (mainObb, patchObb). |
폼 키 설명
UDP에 빌드를 업로드할 때 POST 메서드에서 사용해야 하는 폼 키에 대한 설명은 다음과 같습니다.
| 폼 키 | 설명 | 필수/선택 |
|---|---|---|
| uploadFile | 업로드할 파일의 경로를 지정합니다. | 필수 |
| whatsNew | UDP 콘솔의 What’s New 필드 값을 설정합니다. | 선택 |
| useGoogleService | UDP 콘솔의 Google Play Services 사용 여부를 설정합니다. | 선택 |
선택 키를 지정하지 않을 경우, UDP는 게임의 최신 버전의 값을 자동으로 사용합니다.
일반적인 오류 메시지 및 코드
다음은 API 호출 시 발생할 수 있는 일반적인 오류와 그에 대한 메시지입니다.
| 오류 타입 | 상태 코드 | 오류 메시지 |
|---|---|---|
| 잘못된 인증 토큰 | 401 | {"errorCode":"NotAuthenticated","message":"not authenticated error"} |
| 잘못된 조직 ID | 400 | {"errorCode":"InvalidParameter","message":"Invalid OrgId or ClientId"} |
| 잘못된 파일 타입 | 400 | {"errorCode":"InvalidParameter","message":"Invalid file type"} |
| 잘못된 OBB 타입 | 400 | {"errorCode":"InvalidParameter","message":"Invalid obbType"} |
| 잘못된 콘텐츠 타입 | 400 | {"errorCode":"InvalidParameter","message":"Invalid content type"} |
활용 예제
APK 파일 업로드 예제
APK 파일을 업로드하기 위해서는 적절한 API 호출을 구성합니다. 아래와 같이 설정할 수 있습니다.
orgId,clientId,token값을 준비합니다.- 파일 경로를
uploadFile폼 키에 설정합니다. POST요청을 작성하고 전송합니다.
OBB 파일 업로드 예제
OBB 파일을 업로드할 경우, 추가적으로 obbType 값을 설정해야 합니다. 예를 들어, mainObb 또는 patchObb 값을 선택하여 지정합니다.
결론
이 문서에서는 Unity의 UDP API를 사용하는 방법과 주요 설정에 대해 설명했습니다. 올바른 파라미터와 폼 키를 사용하여 원활한 파일 업로드를 구현할 수 있습니다. 오류 발생 시, 위의 에러 메시지를 참조하여 문제를 해결해 보세요.