# UDP API

> Reference for the Unity Distribution Portal API, a service that shut down in February 2025.

| **重要**                                                                                                                                                                                                                                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Unity Distribution Portal (UDP) は、2025 年 2 月 17 日に閉鎖されます。UDP ウェブコンソールとサービスへのアクセスは、この日をもって完全に無効になります。キーストアをダウンロードする方法、およびゲームをアプリストアに直接再公開する方法については、[UDP 概要](https://api-udp.unity.com/overview)ページを参照してください。アカウントについて質問がある場合は、[Unity カスタマーサポート](https://support.unity.com/hc/en-us/requests/new?ticket_form_id=360000323692)にチケットを提出してください。 |

UDP API を使用すると、UDP コンソールにバイナリファイルをアップロードできます。これにより、CI システムを使用してアプリケーションをビルドし、その出力を UDP に直接プッシュすることができます。[UDP コンソールを使ったゲームの管理と公開](/engine/6000.0/manual/unity-services/udp/managing-and-publishing.md#api-upload)を参照してください。

以下のタイプのライトがサポートされます。

* APK
* OBB
* AAB

## API の構造

API の構造は \[[https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx](https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx)[\&obbType=xxxx](https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx%5B\&obbType=xxxx)] となります。

以下の表は、API のパラメーターを説明したものです。

| パラメーター     | 説明                                                                                                         |
| ---------- | ---------------------------------------------------------------------------------------------------------- |
| `orgId`    | バイナリファイルをアップロードしたいゲームの組織 ID。                                                                               |
| `clientId` | バイナリファイルをアップロードしたいゲームのクライアント ID。                                                                           |
| `token`    | UDPコンソールの Developer API ページで生成された認証トークン。                                                                   |
| `obbType`  | アップロードしたい OBB ファイルのタイプ。有効な値は以下のとおりです。- `mainObb`- `patchObb`OBB ファイルをアップロードする場合のみ、このクエリパラメーターを指定する必要があります。 |

## フォームキー

UDP にビルドをアップロードする際、POST メソッドでフォームキーを使用して値を指定することができます。この値は、 Game Information タブの Binary セクションに対応しています。

以下の表は、フォームキーの説明です。

| フォームキー             | 説明                                                                     | 必須/任意 |
| ------------------ | ---------------------------------------------------------------------- | ----- |
| `uploadFile`       | アップロードするファイルへのパスを指定します。                                                | 必須    |
| `whatsNew`         | UDP コンソールの **What's New** フィールドの値を設定します。                               | 任意    |
| `useGoogleService` | UDP コンソールの **Does your game use Google Play Services?** フィールドの値を設定します。 | 任意    |

オプションキーを指定しない場合、UDP はゲームの最新バージョンの値を使用します。

## 般的なエラーメッセージとエラーコード

### 無効な認証トークン

無効な認証トークンを提供すると、ステータスコード 401 のエラーメッセージが表示されます。

```
{"errorCode":"NotAuthenticated","message":"not authenticated error","target":"","details":null}
```

### 無効な組織 ID またはクライアントID

無効な組織 ID または無効なクライアント ID を入力すると、ステータスコード 400 のエラーメッセージが表示されます。

```
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"Invalid OrgId or ClientId","details":null}
```

### 無効なファイルタイプ

無効なファイルタイプを指定すると、ステータスコード 400 のエラーメッセージが表示されます。

```
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid: please provide the right binary file(APK, AAB or OBB)","target":"file type","details":null}
```

### 無効な OBB タイプ

無効な OBB タイプを指定すると、ステータスコード 400 のエラーメッセージが表示されます。

```
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"obbType","details":null}
```

### 無効なコンテンツタイプ

無効なコンテンツタイプを指定すると、ステータスコード 400 のエラーメッセージが表示されます。

```
{"errorCode":"InvalidParameter","message":"The given parameter is missing or invalid","target":"content type","details":null}
```