メタデータ API 開発者ガイド
jzip ファイルを使用したメタデータのリリースと取得
deploy() コールと retrieve() コールは、.zip ファイルをリリースおよび取得するために使用されます。.zip ファイル内には、取得またはリリースする項目の一覧を示すプロジェクトマニフェスト (package.xml) やフォルダに整理された 1 つ以上の XML コンポーネントが含まれます。
.zip ファイルで取得またはリリースされるファイルは、組織内にあるパッケージ化されていないコンポーネント (標準オブジェクトなど)、または指定したパッケージ内にあるパッケージコンポーネントである場合があります。
各 .zip ファイルには、プロジェクトマニフェスト、package.xml という名前のファイル、およびコンポーネントを含むディレクトリのセットが含まれます。マニフェストファイルでは、.zip ファイルで取得またはリリースしようとしているコンポーネントを定義します。また、マニフェストでは、リリースまたは取得に使用される API バージョンも定義します。
package.xml ファイルのサンプルを次に示します。members 要素に fullName 項目値を指定して、メタデータ型の個別のコンポーネントを取得できます。<members>*</members> を使用して、メタデータ型のすべてのコンポーネントを取得することもできます。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyCustomObject__c</members>
5 <name>CustomObject</name>
6 </types>
7 <types>
8 <members>*</members>
9 <name>CustomTab</name>
10 </types>
11 <types>
12 <members>Standard</members>
13 <name>Profile</name>
14 </types>
15 <version>54.0</version>
16</Package>次の要素は、package.xml に定義されている場合があります。
- <fullName> には、サーバ側パッケージの名前が含まれます。<fullName> が存在しない場合、package.xml はクライアント側の unpackaged パッケージを定義します。
- <types> には、取得またはリリースされるメタデータ型の名前 (CustomObject など) および指定メンバー (myCustomObject__c など) が含まれます。マニフェストファイルには複数の <types> 要素を追加できます。
- <members> には、MyCustomObject__c など、コンポーネントの fullName が含まれます。listMetadata() コールは、個々のコンポーネントを取得する場合に、特定のメタデータ型のコンポーネントの fullName を特定する場合に役立ちます。多くのメタデータ型の場合、各メンバーを個別に書き出す代わりに、members の値をワイルドカード文字 * (アスタリスク) に置き換えることができます。特定のデータ型でワイルドカードがサポートされているかどうかを判別するには、そのデータ型のリファレンストピックを参照してください。
- <name> には、CustomObject または Profile などのメタデータ型が含まれます。ディレクトリの各メタデータ型には 1 つの名前が定義されています。Metadata を拡張するすべてのメタデータ型は有効な値です。入力される名前は、メタデータ API WSDL に定義されているメタデータ型に一致する必要があります。リストについては、「メタデータ型」を参照してください。
- <version> は、.zip ファイルをリリースまたは取得するときに使用する API のバージョン番号です。現在のところ、有効な値は 54.0 です。
異なるメタデータのサブセットを使用する方法を説明した package.xml マニフェストファイルのその他のサンプルは、「package.xml マニフェストファイルのサンプル」を参照してください。
コンポーネントを削除する場合は、「組織からのコンポーネントの削除」を参照してください。