Version: 2022.1
言語: 日本語
UDP リファレンス
UDP SDK のデータ収集

UDP API

UDP API を使うと、UDP コンソールにバイナリファイルをアップロードできます。これにより、CI システムを使ってアプリケーションをビルドし、その出力を UDP に直接プッシュすることができます。UDP コンソールでのゲームの管理と公開 を参照してください。

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

  • APK
  • OBB
  • AAB

API の構造

API は https://distribute.dashboard.unity.com/developer/api/upload/:orgId/:clientId?token=xxxxxx[&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}
UDP リファレンス
UDP SDK のデータ収集