Zip ファイルの使用

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>32.0</version>
16</Package>

次の要素は、package.xml に定義されている場合があります。

• <fullName> には、サーバ側パッケージの名前が含まれます。<fullName> が存在しない場合、これは、クライアント側の unpackaged パッケージです。
• <types> には、取得またはリリースされるメタデータ型の名前 (CustomObject など) および指定メンバー (myCustomObject__c など) が含まれます。マニフェストファイルには複数の <types> 要素が含まれる場合があり、各指定コンポーネントあたり 1 つのエントリと個々のメンバーあたり 1 つのエントリがあります。
• <members> には、MyCustomObject__c など、コンポーネントの fullName が含まれます。listMetadata() コールは、個々のコンポーネントを取得する場合に、特定のメタデータ型のコンポーネントの fullName を特定する場合に役立ちます。多くのメタデータ型の場合、各メンバーを個別に書き出す代わりに、members の値をワイルドカード文字 * (アスタリスク) に置き換えることができます。ワイルドカード文字を使用できるメタデータ型のリストについては、メタデータ型の「ワイルドカード (*) を使用できるか」の列を参照してください。

  SecuritySettings コンポーネントの種類を取得する場合には、<members> 要素で Security を指定し、name 要素で Settings を指定します。

  メモ

• <name> には、CustomObject または Profile などのメタデータ型が含まれます。ディレクトリの各メタデータ型には 1 つの名前が定義されています。Metadata を拡張するすべてのメタデータ型は有効な値です。入力される名前は、メタデータ API WSDL に定義されているメタデータ型に一致する必要があります。リストについては、「メタデータ型」を参照してください。
• <version> は、.zip ファイルをリリースまたは取得するときに使用される API のバージョン番号です。現在のところ、有効な値は 32.0 です。

異なるメタデータのサブセットを使用する方法を説明した package.xml マニフェストファイルのその他のサンプルは、「package.xml マニフェストファイルのサンプル」を参照してください。

項目を削除するには、同じ手順を実行します。ただし、destructiveChanges.xml という名前のマニフェストファイルの削除も含めてください。ごみ箱をスキップするには、「purgeOnDelete」 を参照してください。

destructiveChanges.xml の形式は package.xml と同じです。ただし、ワイルドカードはサポートされていません。

削除対象の単一のカスタムオブジェクトを指定しているサンプルの destructiveChanges.xml ファイルを次に示します。

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</Package>

この破壊的な変更をリリースするためには、リリースするコンポーネントがリストされておらず、API バージョンを含み、destructiveChanges.xml と同じディレクトリ内にある package.xml ファイルも必要です。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <version>32.0</version>
4</Package>