User Manual

Apps - appをダウンロード

ルート URL

POST https://playcanvas.com/api/apps/download

説明

これにより、自身のサーバー上でセルフホスティングできるアプリがダウンロードできるようになります。リクエストは、出力ジョブを開始し、ジョブの詳細は応答で返されます。ステータスがcompleteまたはerrorになるまでIDによるジョブをポーリングすることができます。ジョブが完了したら、データにエクスポートされたアプリをダウンロードするためのURLが含まれます。

curl -H "Authorization: Bearer fdslkjlk32j2l3kj2lkj2lkj323rr" -H "Content-Type: application/json" -X POST -d '{"project_id": 9999999, "name": "My App"}' https://playcanvas.com/api/apps/download

パラメータ

project_id

プロジェクトのid。

name

アプリの名前。1000文字以内。

scenes [optional]

アプリに含まれるシーンidのリスト。シーンが指定されていない場合、プロジェクトのプライマリシーンが使用されます。シーンを指定する場合はリストの最初のシーンがアプリケーションの初期シーンとして使用されます。

target [optional]

'web' または 'ios'に設定できます。通常アプリをダウンロードするには'web'を使用。XCodeプロジェクトをダウンロードするには'ios'を使用。ターゲットが指定されていない場合は'web'がデフォルトとなります。

description [optional]

アプリの説明。10,000文字以内。

version [optional]

アプリのバージョン。20文字以内の文字列。

release_notes [optional]

アプリのリリースノート。10,000文字以内の文字列。

scripts_concatenate [optional]

Boolean。スクリプトを連結したい場合はtrueに設定。

応答のスキーマ

Status: 201 Created
{
    "id": int,
    "created_at": date,
    "modified_at": date,
    "status": "running" or "complete" or "error",
    "messages": list of strings,
    "data": {
      'owner_id': int,
      'project_id': int,
      'scenes': list of int scene ids,
      'name': string,
      'target': string,
      'concatenate': boolean,
      "download_url": string
    }
}

エラー

401

非認証

403

許可されていません

404

プロジェクトが見つかりません

404

所有者が見つかりません

404

シーンが見つかりません

429

リクエストが多すぎます

レート制限

Tこのルートはstrictなレート制限を使用します。

This site is translated by the community. If you want to get involved visit this page