retrieve() | メタデータ API 開発者ガイド

構文

使用方法

組織内のファイル表現のコンポーネントを取得するには、このコールを使用します。

リリース制限は次のとおりです。

機能	制限
最大圧縮 .zip フォルダサイズ¹	約 39 MB
最大非圧縮フォルダサイズ ²	約 400 MB
AppExchange パッケージの最大ファイル数	30,000 (API バージョン 47.0 以降) 22,000 (API バージョン 46.0) 17,500 (API バージョン 45.0) 12,500 (API バージョン 43.0 および 44.0) 10,000 (API バージョン 42.0 以前)
パッケージの最大ファイル数	10,000

インデックスが定義されている Big Object 対してのみ retrieve() コールを実行できます。Big Object が [設定] で作成されていて、インデックスがまだ定義されていない場合、その Big Object を取得することはできません。

メモ

¹ メタデータ API base-64 では、コンポーネントを圧縮後にエンコードします。結果の .zip ファイルの最大サイズは 50 MB です。Base-64 エンコードではペイロードのサイズが約 22% 増加するため、エンコードする前に、圧縮済みペイロードが約 39 MB を超えることはできません。

² Ant 移行ツールを使用して、展開したプロジェクトをリリースする場合、まずプロジェクト内のすべてのファイルが圧縮されます。非圧縮プロジェクト内の非圧縮コンポーネントの最大サイズは、ファイルの圧縮率に応じて 400 MB 以下です。ファイルの圧縮率が高い場合、圧縮されたサイズは 39 MB を下回るため、合計およそ 400 MB を移行できます。ただし、バイナリ静的リソースのように、それほど圧縮できないコンポーネントの場合、移行できるのは 400 MB 未満です。

API バージョン 31.0 以降では、retrieve() コールを実行するプロセスが簡略化されました。取得操作の状況を取得する場合、retrieve() をコールしてから checkStatus() をコールする必要がなくなりました。代わりに、checkRetrieveStatus() のみをコールします。取得操作が進行中の場合、取得操作が完了するまで checkRetrieveStatus() を再コールします。checkStatus() コールは、API バージョン 30.0 以前では引き続きサポートされますが、API バージョン 31.0 以降では使用できません。

API バージョン 31.0 以降の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントを取得します。

retrieve() コールを発行し、非同期的な取得を開始すると、AsyncResult オブジェクトが返されます。id 項目の値をメモし、次のステップで使用します。
checkRetrieveStatus() コールを発行して、最初のステップの AsyncResult オブジェクトから id 値を渡します。返された RetrieveResult の done 項目の値をチェックします。true の場合、コールが完了して、次のステップに進むことを意味します。それ以外の場合は、done 項目が true になるまで、このステップを繰り返して checkRetrieveStatus() を再度コールします。
前のステップの checkRetrieveStatus() への最後のコールで返された RetrieveResult から zip ファイル (zipFile) 項目および他の必要な項目を取得します。

API バージョン 30.0 以前の場合、次の手順に従って、パッケージ化されたコンポーネントまたはパッケージ化されていないコンポーネントを取得します。

retrieve() コールを発行し、非同期的な取得を開始すると、AsyncResult オブジェクトが返されます。コールが完了すると、done 項目に true が含まれます。ほとんどの場合、コールはすぐに完了しない��め、結果に記述されません。完了している場合、返された id 項目の値を書き留め、次のステップを省略します。
コールが完了していない場合、前のステップで retrieve() コールから返された AsyncResult オブジェクトの id 項目の値を使用して、ループで checkStatus() コールを発行します。done 項目に true が含まれるまで、返される AsyncResult オブジェクトを確認します。retrieve() コールを完了するまでにかかる時間は、リリースされる zip ファイルのサイズによって異なるため、zip ファイルのサイズが大きいほど、反復中の待機時間をより長く設定します。
最初のステップで返された id 値を使用して、checkRetrieveStatus() コールを発行し、retrieve() コールの結果を取得します。

マニフェストファイルの例は、「package.xml マニフェストファイルのサンプル」を参照してください。

権限

クライアントアプリケーションは、「メタデータ API 関数を使用したメタデータの変更」権限または「すべてのデータの編集」権限でログインしている必要があります。

メタデータへのアクセス権がユーザに必要で、データへのアクセス権は必要でない場合、「メタデータ API 関数を使用したメタデータの変更」権限を有効にします。それ以外の場合は、「すべてのデータの編集」権限を有効にします。

メモ

引数

名前	型	説明
retrieveRequest	`RetrieveRequest`	取得するパッケージまたはファイルを決定するためのオプションをカプセル化します。

応答

AsyncResult

サンプルコード —Java

このサンプルでは、コンポーネントを zip ファイルにして取得する方法を示します。zip ファイルのリリース方法の詳細は、deploy() のサンプルコードを参照してください。

このサンプルでは、API バージョン 34.0 以降が必要です。

メモ