カスタムメタデータ型 (CustomObject) | メタデータ API 開発者ガイド

詳細は、『Custom Metadata Types Implementation Guide』を参照してください。

ファイルのサフィックスおよびディレクトリの場所

カスタムメタデータ型は、カスタムオブジェクトとして定義され、オブジェクトフォルダに保存されます。カスタムメタデータ型のサフィックスには __mdt を使用します (カスタムオブジェクトの場合の __c の代わりに)。カスタムメタデータ型の項目名のサフィックスにはその他のカスタム項目と同様に __c を使用します。カスタムメタデータ型の項目名は、属するカスタムメタデータ型の名前を使用してドット修飾する必要があります。

カスタムメタデータ型の名前は、それらの名前空間内で一意である必要があります。すべてのカスタムメタデータ型は、CustomMetadata 名前空間に属しており、必要に応じて 2 番目の名前空間に属することができます。組織では、各自の名前空間や他の組織の名前空間が含まれるカスタムメタデータ型を使用できます。

バージョン

カスタムメタデータ型のコンポーネントは、API バージョン 31.0 以降で使用できます。

特別なアクセスルール

カスタムメタデータ型を作成するには、「Apex 開発」権限が必要です。メタデータが登録者によって制御され、コードの名前空間内から参照可能な場合、Apex コードでカスタムメタデータレコードの作成、参照、更新ができます (ただし削除は不可)。メモリ内のレコードを編集できますが、更新/挿入や削除を行うことはできません。Apex コードはカスタムメタデータレコードをリリースできますが、DML 操作を介することはできません。さらに、パートナー API またはエンタープライズ API では、カスタムメタデータに対して DML 操作を実行できません。管理カスタムメタデータ型をインストールするユーザは、新しいカスタム項目を追加できません。パッケージ化されていないメタデータでは、開発者によって制御されたアクセスと登録者によって制御されたアクセスの動作は同じです。登録者によって制御されたアクセスのように動作します。詳細は、「Trust, but Verify: Apex Metadata API and Security (信頼と検証: Apex メタデータ API およびセキュリティ)」を参照してください。

監査項目 (CreatedDate、CreatedBy、LastModifiedDate、LastModifiedBy、SystemModStamp) は編集不可のままです。

メモ

項目

カスタムメタデータ型には、次の 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` — カスタム設定またはカスタムメタデータ型がパッケージ化されている場合、すべての登録組織がアクセスできます。 `Protected` — カスタムオブジェクト、カスタム設定、またはカスタムメタデータ型が管理パッケージに含まれる場合、開発組織のみがアクセスできます。登録組織はアクセスできません。 `PackageProtected` — カスタムメタデータ型が `PackageProtected` の場合、パッケージのカスタム Apex コードでのみアクセスできます。この値は、API アクセスキーやセキュリティトークンなどの秘密を保護するために使用します。API バージョン 47.0 以降で利用できます。デフォルト値は、`Public` です。

宣言的なメタデータの定義のサンプル

この例では、Picklists R Us は、オブジェクトフォルダに ReusablePicklistOption__mdt.object という名前のファイルとこれらのコンテンツをリリースして、Reusable Picklist カスタムメタデータ型を作成します。

次の package.xml ファイルからの抜粋は、ドット表記および __mdt サフィックスの使用方法を示しています。picklist1234 などの名前空間を使用している場合、ReusablePicklistOption__mdt の完全名は picklist1234__ReusablePicklistOption__mdt になります。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。