メタデータ API 開発者ガイド
jDocument
ドキュメントを表します。すべてのドキュメントは、sampleFolder/TestDocument などのドキュメントフォルダ内にある必要があります。このメタデータ型は、MetadataWithContent コンポーネントを拡張し、その項目を共有します。
現在、ユーザは Force.com IDE を使用してドキュメントのメタデータをローカルファイルシステムにエクスポートできません。
ドキュメントの取得
package.xml ではドキュメントにワイルドカード (*) 記号を使用できません。 明示的な名前を package.xml に入力するためにドキュメントのリストを取得するには、listMetadata() をコールし、DocumentFolder をデータ型として渡します。DocumentFolder は describeMetadata() ではデータ型として返されません。 ドキュメントは、inFolder の関連付けられている属性が true に設定された describeMetadata() から返されます。 この属性が true に設定されている場合は、DocumentFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。
次の例では、package.xml 内のフォルダを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyDBFolder/MyDBName</members>
5 <name>Dashboard</name>
6 </types>
7 <types>
8 <members>MyDocumentFolder/MyDocumentName</members>
9 <name>Document</name>
10 </types>
11 <types>
12 <members>unfiled$public/MarketingProductInquiryResponse</members>
13 <members>unfiled$public/SalesNewCustomerEmail</members>
14 <name>EmailTemplate</name>
15 </types>
16 <types>
17 <members>MyReportFolder/MyReportName</members>
18 <name>Report</name>
19 </types>
20 <version>36.0</version>
21</Package>各ドキュメントには、DocumentFilename-meta.xml という名前の付随するメタデータファイルがドキュメントフォルダ内に作成されます。たとえば、sampleFolder フォルダにあるドキュメント TestDocument.png の場合は、パッケージの documents/sampleFolder に TestDocument.png-meta.xml があります。
バージョン
ドキュメントは、API バージョン 10.0 以降で使用できます。
API バージョン 17.0 以降では、ごみ箱に移動したドキュメントを含むフォルダを削除できます。フォルダを削除すると、ごみ箱内の関連ドキュメントをはすべて完全に削除されます。
API バージョン 18.0 以降では、ドキュメントに拡張子が不要です。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| content | base64 | ドキュメントのコンテンツ。Base 64 で符号化されたバイナリデータ API コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContent コンポーネントから継承されます。 |
| description | string | ドキュメントの説明。このドキュメントを他のドキュメントと区別するための説明を入力します。 |
| fullName | string | フォルダ名を含む、ドキュメントの名前。バージョン 17.0 以前では、fullName にドキュメント拡張子が含まれていました。バージョン 18.0 以降では、fullName にはファイル拡張子が含まれていません。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値は name 項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。 |
| internalUseOnly | boolean | 必須。ドキュメントが機密文書であるか (true)、否か (false) を示します。この項目と public はどちらか 1 つのみを true に設定でき、両方を true に設定することはできません。 |
| keywords | string | ドキュメントを説明するための 1 つ以上の語が含まれます。検索時には、この項目の語に一致するかどうかの確認が実行されます。 |
| name | string | fullName 項目で使用できる文字のリストは、バージョン 14.0 以降削減されています。この項目には、バージョン 14.0 以前の fullName 項目に含まれている値が含まれます。この項目は、fullName 項目の値にその項目で受け入れらない文字が含まれる場合にのみ入力されます。 |
| public | boolean | 必須。ドキュメントが HTML メールテンプレートに使用できる画像であり、メールで参照する場合に Salesforce ユーザ名とパスワードが必要でないか (true)、否か (false) を示します。その画像を、カスタムアプリケーションロゴまたはカスタムタブアイコンとして使用し、その両方を参照するのに Salesforce ユーザ名とパスワードが必要な場合は、この項目を false に設定します。この項目と internalUseOnly はどちらか 1 つのみを true に設定でき、両方を true に設定することはできません。 |
宣言的なメタデータの定義のサンプル
ドキュメントの定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Document xmlns="http://soap.sforce.com/2006/04/metadata">
3 <internalUseOnly>false</internalUseOnly>
4 <name>Q2 Campaign Analysis</name>
5 <public>false</public>
6 <description>Analyze Q2 campaign effectiveness</description>
7</Document>