メタデータ API 開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
deploy()
ファイル表現のコンポーネントを使用して、組織のファイル表現のコンポーネントを作成、更新、または削除します。
構文
使用方法
このコールを使用して、ファイル表現のコンポーネントを取得し、ファイル表現のコンポーネントが表すコンポーネントを作成、更新、または削除することにより、組織にファイル表現のコンポーネントをリリースします。
API バージョン 29.0 では、Salesforce は、リリース状況プロパティを改善し、deploy() コール後にリリースに関する情報を取得するために checkStatus() を使用する要件を削除しました。Salesforce では、API バージョン 28.0 以前で deploy() を使用する場合の checkStatus() の使用を引き続きサポートします。
API バージョン 29.0 以降の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントをリリース (作成または更新) します。
- deploy() コールを発行して、非同期リリースを開始すると、AsyncResult オブジェクトが返されます。id 項目の値をメモし、次のステップで使用します。
- checkDeployStatus() コールの発行を、返される DeployResult の done 項目がコールの完了を示す true になるまでループします。DeployResult オブジェクトには、deploy() コールを使用して開始された進行中または完了済みのリリースに関する情報が含まれます。checkDeployStatus() をコールするとき、最初のステップの AsyncResult オブジェクトから id 値を渡します。
API バージョン 28.0 以前の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントをリリース (作成または更新) します。
- deploy() コールを発行して、非同期リリースを開始すると、AsyncResult オブジェクトが返されます。コールが完了すると、done 項目に true が含まれます。ほとんどの場合、コールはすぐに完了しないため最初の結果に記述されません。完了している場合、返された id 項目の値を書き留め、次のステップを省略します。
- コールが完了していない場合、前のステップで deploy() コールから返された AsyncResult オブジェクトの id 項目の値を使用して、ループで checkStatus() コールを発行します。done 項目に true が含まれるまで、返される AsyncResult オブジェクトを確認します。deploy() コールを完了するまでにかかる時間は、リリースされる zip ファイルのサイズによって異なるため、zip ファイルのサイズが大きくなるほど、反復間の待機時間をより長くする必要があります。
- 最初のステップで返された id 値を使用して、checkDeployStatus() コールを発行し、deploy() コールの結果を取得します。
項目を削除するには、同じ手順を実行します。ただし、destructiveChanges.xml という名前のマニフェストファイルの削除も含めてください。ごみ箱をスキップするには、「purgeOnDelete」 を参照してください。
destructiveChanges.xml の形式は package.xml と同じです。ただし、ワイルドカードはサポートされていません。
削除対象の単一のカスタムオブジェクトを指定しているサンプルの destructiveChanges.xml ファイルを次に示します。
この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョンを含み、destructiveChanges.xml と同じディレクトリ内にある package.xml ファイルも必要です。
処理中または過去 30 日間で完了したリリースの状況を追跡するには、[設定] で または をクリックします。
進行中またはキュー内のリリースは、リリースの横にある [キャンセル] をクリックしてキャンセルできます。リリースが完全にキャンセルされるまで、リリースの状況は Cancel Requested になります。キャンセルされたリリースは、[失敗] セクションにリストされます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| zipFile | base64 | Base 64 で符号化されたバイナリデータ クライアントアプリケーションは、バイナリデータを base64 に符号化する必要があります。 |
| deployOptions | DeployOptions | リリースするパッケージまたはファイルを特定するためのオプションをカプセル化します。 |
DeployOptions
このコールでは次のリリースオプションを選択できます。
| 名前 | 型 | 説明 |
|---|---|---|
| allowMissingFiles | boolean | ファイルが package.xml では指定されているが、.zip ファイルにはない場合でもリリースを継続するか (true)、否か (false) を指定します。 |
| autoUpdatePackage | boolean | ファイルが .zip ファイルにはあるが、package.xml で指定されていない場合、ファイルを自動的にパッケージに追加するか (true)、否か (false) を指定します。.zip ファイルを含む package.xml が更新された場合は、retrieve() が自動的に発行されます。 本番組織へのリリースでは、この引数を設定することはできません。 |
| checkOnly | boolean | Apex クラスおよびトリガをリリースの一部として組織に保存するか (false)、否か (true) を示します。デフォルトは false です。発行済みのエラーまたはメッセージもすべて生成されます。このパラメータは、Salesforce Ant ツールの checkOnly パラメータと似ています。 |
| ignoreWarnings | boolean | 警告を無視してリリースの正常な完了を許可するか (true)、否か (false) を示します。デフォルトは false です。 警告の DeployMessage オブジェクトには次の値が含まれます。
警告が発生し、ignoreWarnings が true に設定されている場合は、DeployMessage の success 項目は true です。ignoreWarnings が false に設定されている場合、success は false に設定され、警告はエラーとして処理されます。 この項目は API バージョン 18.0 以降で使用できます。バージョン 18.0 より前では、警告とエラーは区別されていませんでした。すべての問題はエラーとして処理され、リリースの成功を妨げていました。 |
| performRetrieve | boolean | retrieve() コールをリリース直後に実行するか (true)、否か (false) を示します。リリース直後のものをすべて取得するには true に設定します。 |
| purgeOnDelete | boolean | true の場合、destructiveChanges.xml マニフェストファイルの削除されたコンポーネントはごみ箱に保存されません。代わりに、即座に削除の対象となります。 この項目は API バージョン 22.0 以降で使用できます。 このオプションは Developer Edition 組織または Sandbox 組織でのみ機能しますが、本番組織では機能しません。 |
| rollbackOnError | boolean | エラーが発生した場合、ロールバックを完了するか (true)、否か (false) を示します。false の場合、エラーなしで実行できるアクションのセットはすべて実行され、残りのアクションではエラーが返されます。本番組織にリリースする場合は、このパラメータは true に設定されている必要があります。デフォルトは、false です。 |
| runAllTests | boolean | true の場合、組織で定義されているすべての Apex テストが実行されます。 本番組織へのリリースの場合、インストール済みの管理パッケージから作成されたテストを除くすべてのテストは、この引数に関係なく自動的に実行されます。rollbackOnError パラメータが true に設定されているときにテストのいずれかが失敗した場合は、リリース全体がロールバックされます。 |
| runTests | string[] | リリース時に実行される Apex テストのリスト。クラス名 (1 インスタンスあたり 1 つの名前) を指定します。また、クラス名にはドット付きの名前空間を指定することもできます。たとえば、3 つのテストを実行するには、次のコードを使用します。 rollbackOnError パラメータが true に設定されているときにこれらのテストのいずれかが失敗した場合は、リリースがロールバックされ、組織への変更は行われません。 |
| singlePackage | boolean | 指定された .zip ファイルが指し示すディレクトリ構造が 1 つのパッケージを持つか (true)、パッケージのセットを持つか (false)) を示します。 |
応答
サンプルコード —Java
このサンプルでは、zip ファイルでコンポーネントをリリースする方法を示します。zip ファイルの取得方法についての詳細は、retrieve() のサンプルコードを参照してください。