メタデータ API 開発者ガイド
jカスタムメタデータ型 (CustomObject)
ファイルのサフィックスおよびディレクトリの場所
カスタムメタデータ型は、カスタムオブジェクトとして定義され、オブジェクトフォルダーに保存されます。カスタムメタデータ型のサフィックスには __mdt を使用します (カスタムオブジェクトの場合の __c の代わりに)。カスタムメタデータ型の項目名のサフィックスにはその他のカスタム項目と同様に __c を使用します。カスタムメタデータ型の項目名は、属するカスタムメタデータ型の名前を使用してドット修飾する必要があります。
カスタムメタデータ型の名前は、それらの名前空間内で一意である必要があります。すべてのカスタムメタデータ型は、CustomMetadata 名前空間に属しており、必要に応じて 2 番目の名前空間に属することができます。組織では、各自の名前空間や他の組織の名前空間が含まれるカスタムメタデータ型を使用できます。
バージョン
カスタムメタデータ型のコンポーネントは、API バージョン 31.0 以降で使用できます。
特別なアクセスルール
項目
カスタムメタデータ型には、次の CustomObject 項目を含めることができます。
カスタムメタデータ型の項目をインデックス付けができる一意の項目にするには、項目を Unique および ExternalId としてマークします。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| description | string | カスタムメタデータ型の説明。この項目には、最大で 1,000 文字を含めることができます。 |
| fields | CustomField[] | カスタムメタデータ型の 1 つ以上のカスタム項目を表します。 |
| gender | Gender | オブジェクトを表す名詞の性別を示します。この項目は、語の性別に基づいて、異なる処理が必要となる言語に使用されます。 |
| label | string | Salesforce の [設定] ユーザーインターフェース全体でオブジェクトを表す表示ラベル。カスタムメタデータ型は、Lightning プラットフォームホームページおよびパッケージ化のユーザーインターフェースの、最近使用したオブジェクトのリストにのみ表示されます。 |
| pluralLabel | string | 表示ラベル値の複数形。 |
| startsWith | StartsWith (string 型の列挙) | 名詞が母音、子音、または特殊文字で開始されているかを示します。この項目は、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。 |
| visibility | SetupObjectVisibility (string 型の列挙) | この項目はカスタムメタデータ型の表示設定を返します。有効な値は次のとおりです。
デフォルト値は、Public です。 |
宣言的なメタデータの定義のサンプル
この例では、Picklists R Us は、オブジェクトフォルダーに ReusablePicklistOption__mdt.object という名前のファイルとこれらのコンテンツをリリースして、Reusable Picklist カスタムメタデータ型を作成します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fields>
4 <fullName>AlphaSort__c</fullName>
5 <defaultValue>false</defaultValue>
6 <externalId>false</externalId>
7 <label>Sorted Alphabetically</label>
8 <type>Checkbox</type>
9 </fields>
10 <label>Reusable Picklist</label>
11 <pluralLabel>Reusable Picklist</pluralLabel>
12 <visibility>Public</visibility>
13</CustomObject>1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3...
4 <types>
5 <members>PicklistTest__c.PicklistTestField__c</members>
6 <members>ReusablePicklistOption__mdt.Picklist__c</members>
7 <members>ReusablePicklistOption__mdt.SortOrder__c</members>
8 <members>PicklistUsage__mdt.Field__c</members>
9 <members>PicklistUsage__mdt.Picklist__c</members>
10 <members>PicklistUsage__mdt.SObjectType__c</members>
11 <members>ReusablePicklist__mdt.AlphaSort__c</members>
12 <name>CustomField</name>
13 </types>
14...
15 <types>
16 <members>PicklistTest__c</members>
17 <members>ReusablePicklistOption__mdt</members>
18 <members>PicklistUsage__mdt</members>
19 <members>ReusablePicklist__mdt</members>
20 <name>CustomObject</name>
21 </types>
22...
23 <version>60.0</version>
24</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。