メタデータ API 開発者ガイド
jForecastingType
親種別
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ForecastingType コンポーネントにはサフィックス .forecastingType が付けられ、forecastingTypes フォルダに保存されます。
バージョン
ForecastingType コンポーネントは、API バージョン 52.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | 必須。true の場合、売上予測種別は有効です。false の場合、売上予測種別は無効です。デフォルト値は false です。 |
| amount | boolean | 必須。true の場合、売上予測種別は収益単位に基づきます。false の場合、売上予測種別は数量単位に基づきます。デフォルト値は true です。 |
| dateType | string | 必須。売上予測金額のベースとなる日付種別。
次の値は、Performance Edition と、Sales Cloud が付属する Unlimited Edition で、API バージョン 52.0 以降で使用できます。
|
| developerName | string | 必須。売上予測種別の名前。DeveloperName は、ForecastingSettings では name と呼ばれ、カスタムレポートでは売上予測種別と呼ばれます。 |
| hasProductFamily | boolean | 必須。true の場合は、売上予測種別に商品ファミリが含まれます。false の場合は、売上予測種別に商品ファミリは含まれません。デフォルト値は false です。 |
| masterLabel | string | 必須。この ForecastingType 値の表示ラベルを制御します。この表示値は、翻訳されない内部ラベルです。 |
| opportunitySplitType | string | 売上予測種別に分割種別があるかどうか、ある場合はその分割種別名を示します。 |
| opptyLineItemSplitType | string | 売上予測種別に商談品目 (製品) 分割種別があるかどうか、ある場合は品目分割種別の名前を示します。API バージョン 58.0 以降で使用できます。 |
| quantity | boolean | 必須。true の場合、売上予測種別は数量単位に基づきます。false ��場合、売上予測種別は収益単位に基づきます。デフォルト値は false です。 |
| roleType | string | 必須。ロールの種類に ForecastingType があるかどうか、ある場合はどの ForecastingType なのかを示します。可能な値は R (ユーザロールベースの売上予測種別) および Y (Territory2 ベースの売上予測種別) です。 |
| territory2Model | string | ForecastingType に Territory2 モデルがあるかどうか、ある場合はその Territory2 モデル名を示します。 |
宣言的なメタデータの定義のサンプル
ロール階層を使用する ForecastingType コンポーネントの例を次に示します。
テリトリー階層を使用する ForecastingType コンポーネントの例を次に示します。
商談分割種別を使用する ForecastingType コンポーネントの例を次に示します。
商談品目分割種別を使用する ForecastingType コンポーネントの例を次に示します。
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワ���ルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。
使用方法
- API バージョン 52.0 より前で使用できた従来の売上予測種別は、有効化、無効化することはできますが、作成、削除することはできません。既存の売上予測種別を有効にするには、有効フラグを更新します。
- API バージョン 52.0 以降でのみ使用できる売上予測種別は、作成、有効化、無効化、削除することができます。売上予測種別が存在しない場合は、無効な状態の売上予測種別が作成されます。売上予測種別が存在する場合は、有効フラグが更新されます。zip ファイルを 2 回リリースすると、売上予測種別が作成され、有効化されます。
- メタデータ API 種別は、ForecastingSettings、ForecastingType、ForecastingSourceDefinition、ForecastingTypeSource の順にリリースします。すべてがパッケージファイルに指定されている場合は、自動的にこの順序に従います。