メタデータ API 開発者ガイド
jGlobalValueSet
グローバル選択リスト値セット (カスタム選択リスト項目で使用できる共有値のセット) のメタデータを表します。グローバル値セットは項目ではありません。これに対し、グローバル選択リストに基づくカスタム選択リスト項目は ValueSet 型になります。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
GlobalValueSet コンポーネントのサフィックスは .globalValueSet で、globalValueSets フォルダーに保存されます。
バージョン
GlobalValueSet コンポーネントは、API バージョン 38.0 以降で使用できます。API バージョン 37.0 では、このコンポーネントは GlobalPicklist 型です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customValue | CustomValue[] | 少なくとも 1 つの値が必要です。グローバル選択リストで定義された値のリスト、すなわち「グローバル値セット」です。グローバル値セットは、グローバル値セットを使用するすべてのカスタム選択リスト項目で継承されます。各値は customValue 型です。グローバル値セットには、無効な値を含め合計 1,000 個までの値を設定できます。 |
| description | string | これは、グローバル値セットの目的や対象オブジェクトを記述する場合に役立ちます。最大 255 文字です。 |
| masterLabel | string | 必須。グローバル値セットの作成時に定義されるグローバル値セットの名前。ユーザーインターフェースに表示ラベルとして表示されます。 |
| sorted | boolean | 必須。グローバル値セットがアルファベット順に並べ替えられるかどうかを示します。デフォルトでは、この値は false です。 |
宣言的なメタデータの定義のサンプル
次の UpsellGlobal.globalValueSet は GlobalValueSet コンポーネントの例です。
1<?xml version="1.0" encoding="UTF-8"?>
2<GlobalValueSet xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>Updated:This is a basic global value set.</description>
4 <masterLabel>UpsellGlobal</masterLabel>
5 <customValue>
6 <fullName>Maybe</fullName>
7 <default>false</default>
8 <label>Maybe</label>
9 </customValue>
10 <customValue>
11 <fullName>No</fullName>
12 <default>false</default>
13 <label>No</label>
14 </customValue>
15 <customValue>
16 <fullName>Yes</fullName>
17 <default>false</default>
18 <label>Yes</label>
19 </customValue>
20 <sorted>false</sorted>
21</GlobalValueSet>
22この例の package.xml は、以前の定義を参照します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>UpsellGlobal</members>
5 <name>GlobalValueSet</name>
6 </types>
7 <version>40.0</version>
8</Package>グローバル値セットが API バージョン 57.0 以降で作成された場合は、開発者名に __gvs サフィックスが自動的に付加されます。GlobalValueSet 型を使用して CRUD ベースのコールを行う場合、その型を参照する際に fullName 項目にサフィックスを付加する必要があります。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。