GlobalPicklistValue | メタデータ API 開発者ガイド

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

GlobalPicklistValue コンポーネントは値のリストでありカスタム項目ではないため、ファイルのサフィックスやディレクトリがありません。ファイルベースの操作では、これらのコンポーネントに GlobalPicklist (API v37.0 のみにあるもの) でアクセスできます。

メモ

バージョン

GlobalPicklistValue コンポーネントは、API バージョン 37.0 のみで使用できます。API バージョン 38.0 以降では、GlobalPicklistValue は CustomValue に置き換えられました。

項目

項目名	項目の型	説明
color	string	レポートおよびダッシュボードのグラフで色が使用されている場合、選択リスト値に割り当てられている色。色は、16 進形式で表記されます (#FF6600 など)。色が指定されていない場合、グラフ作成時に動的に割り当てられます。
default	boolean	必須。この値が、グローバル選択リストと、その選択リスト値セットを共有するカスタム選択リストのデフォルトの選択であるかどうかを示します。この項目は、デフォルトで `true` に設定されます。
description	string	グローバル選択リスト値の説明。グローバル選択リスト値に関する説明を記載すると、作成した理由を追跡できるので便利です。最大 255 文字です。
isActive	boolean	この値が現在有効か無効かを示します。デフォルト値は `true` です。ユーザーは有効な値のみを選択リストから選択できます。グローバル選択リスト値の API 取得操作では、選択リストの有効な値と無効な値がすべて返されます。一方、グローバルでない非制限選択リストの値を取得する場合は、有効な値のみが返されます。

PicklistValue

このメタデータ型では選択リストの値を定義し、この値がデフォルト値であるかどうかを指定します。GlobalPicklistValue メタデータ型を拡張し、そのすべての項目を継承します。API バージョン 36.0 以前では、PicklistValue はメタデータ型を拡張し、その fullName 項目を継承します。

選択リストの値を使用する場合は、次の点に注意してください。

標準オブジェクトを取得する場合、カスタマイズされた選択リスト値のみでなく、すべての選択リスト値が取得されます。
標準選択リスト項目への変更をリリースする場合、必要に応じて選択リストの値が追加されます。
グローバル選択リスト値を無効化するには、値を省略して (値の isActive 項目を false に設定して) GlobalPicklist で update() コールを呼び出します。または、isActive 項目を false に設定して GlobalPicklistValue で update() コールを直接呼び出すこともできます。
選択リスト値がコンポーネント定義にない場合、リリース時に無効化されます。無効化は、標準項目とカスタム項目の両方の選択リスト値で発生します。

項目名	項目の型	説明
allowEmail	boolean	この値によりユーザーが見積 PDF をメール送信できるか (`true`)、否か (`false`) を示します。この項目は見積の Status 項目にのみ関連します。この項目は、API バージョン 18.0 以降で使用できます。
closed	boolean	この値が完了の状況に関連付けられるか (`true`)、否か (`false`) を示します。この項目はケースおよび ToDo の標準項目の Status にのみ関連します。この項目は、API バージョン 16.0 ～ 36.0 で使用できます。バージョン 37.0 では、この項目は GlobalPicklistValue にあります。
controllingFieldValues	string[]	この選択リスト値にリンクしている制御項目の値のリスト。制御項目は、チェックボックスまたは選択リストにすることができます。この項目は、API バージョン 14.0 以降で使用できます。リストの値は項目のデータ型によって異なります。 `Checkbox`: `checked` または `unchecked`。 `Picklist`: 制御項目の選択リスト値の fullname。
converted	boolean	この値が取引開始済みの状況に関連付けられるか (`true`)、否か (`false`) を示します。この項目はリードの標準項目の [リード状況] にのみ関連します。詳細は、Salesforce オンラインヘルプの「評価済みリードの取引開始」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。
cssExposed	boolean	この値がセルフサービスポータルで使用可能か (`true`)、否か (`false`) を示します。この項目はケースの標準項目の [原因] にのみ関連します。セルフサービスは、顧客にオンラインサポートチャネルを提供します。これにより、顧客は、カスタマーサービス担当者に連絡しなくても各自の疑問を解消できます。セルフサービスについての詳細は、Salesforce オンラインヘルプの「セルフサービスポータルの設定」を参照してください。 Spring '12 以降、新しい Salesforce 組織ではセルフサービスポータルを利用できません。既存の組織は、引き続きセルフサービスポータルを使用できます。メモこの項目は、API バージョン 16.0 以降で使用できます。
forecastCategory	ForecastCategories (string 型の列挙)	この値が売上予測分類に関連付けられるか (`true`)、否か (`false`) を示します。この項目は商談の標準項目の Stage にのみ関連します。 Omitted Pipeline BestCase Forecast Closed この項目は、API バージョン 16.0 以降で使用できます。
highPriority	boolean	この値が優先度が高い項目であるか (`true`)、否か (`false`) を示します。この項目は ToDo の標準項目の Priority にのみ関連します。ToDo についての詳細は、Salesforce オンラインヘルプの「ToDo を使用する場合の考慮事項」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。
probability	int	この値が確度割合であるか (`true`)、否か (`false`) を示します。この項目は商談の標準項目の Stage にのみ関連します。この項目は、API バージョン 16.0 以降で使用できます。
reverseRole	string	パートナーの相手側から見たロールの名前に対応する選択リスト値。ロールが「下請け」の場合、相手側から見たロールは「元請け」となります。Salesforce でパートナーロールを取引先に割り当てると、相手側から見たパートナーとの関係が作成され、両方の取引先で他方をパートナーとして表示できます。この項目は、パートナーロールにのみ関連します。詳細は、Salesforce オンラインヘルプの「パートナーの項目」を参照してください。この項目は、API バージョン 18.0 以降で使用できます。
reviewed	boolean	この値がレビュー済み状況に関連付けられるか (`true`)、否か (`false`) を示します。この項目はソリューションの標準項目の Status にのみ関連します。商談についての詳細は、Salesforce オンラインヘルプの「ソリューションの作成」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。
won	boolean	この値が完了または成立の状況に関連付けられるか (`true`)、否か (`false`) を示します。この項目は商談の標準項目の Stage にのみ関連します。この項目は、API バージョン 16.0 以降で使用できます。

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

GlobalPicklistValue コンポーネントを参照する package.xml を使用した GlobalPicklistValue コンポーネントの例は、「GlobalPicklist」を参照してください。

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

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