メタデータ API 開発者ガイド
jFolder
Salesforce には、現在次の 5 つのフォルダの種類があります。
- ドキュメントフォルダ
- メールフォルダ (Salesforce Classic メールテンプレートでのみ使用可能)
- メールテンプレートフォルダ
- レポートフォルダ
- ダッシュボードフォルダ
フォルダの種類の名前は「Folder」サフィックスで終わります。たとえば、ドキュメントフォルダの種類の名前は「DocumentFolder」です。
ファイルのサフィックスおよびディレクトリの場所
フォルダは、パッケージの対応するコンポーネントディレクトリに保存されます。これらのディレクトリにはそれぞれ documents、email、emailTemplates、reports、dashboards という名前が付いています。フォルダは、ファイルのコンテナであるため、テキストファイル表記がありません。各フォルダには、同じディレクトリレベルに FolderName-meta.xml という名前の付随するメタデータファイルが作成されます。FolderName-meta.xml メタデータファイルには、accessType など、そのフォルダのメタデータ情報が含まれます。たとえば、sampleFolder という名前のドキュメントフォルダの場合は、パッケージの documents フォルダ内に sampleFolder-meta.xml があります。
バージョン
フォルダは、API バージョン 11.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| accessType | FolderAccessTypes (string 型の列挙) | 必須。このフォルダのアクセス権の種類。有効な値は、次のとおりです。 |
| fullName | string | API アクセスの一意の識別子として使用される名前。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| name | string | 必須。ドキュメントフォルダの名前。 |
| publicFolderAccess | PublicFolderAccess (string 型の列挙) |
Public が accessType の値である場合、この項目はすべてのユーザがフォルダの内容に対して持つアクセス権の種類を示します。使用できる値は次のとおりです。
|
| SharedTo | Salesforce ヘルプの「共有に関する考慮事項」を参照してください。 |
宣言的なメタデータの定義のサンプル
ドキュメントが含まれるドキュメントフォルダのパッケージマニフェスト定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fullName>basic</fullName>
4 <types>
5 <members>sampleFolder</members>
6 <members>sampleFolder/TestDocument.txt</members>
7 <name>Document</name>
8 </types>
9 <version>56.0</version>
10</Package>1<?xml version="1.0" encoding="UTF-8"?>
2<DocumentFolder xmlns="http://soap.sforce.com/2006/04/metadata">
3 <accessType>Public</accessType>
4 <name>sampleFolder</name>
5 <publicFolderAccess>ReadWrite</publicFolderAccess>
6</DocumentFolder>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。