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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

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

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

ForecastingType コンポーネントにはサフィックス .forecastingType が付けられ、forecastingTypes フォルダーに保存されます。

バージョン

ForecastingType コンポーネントは、API バージョン 52.0 以降で使用できます。

項目

項目名	項目の型	説明
active	boolean	必須。`true` の場合、売上予測種別は有効です。`false` の場合、売上予測種別は無効です。デフォルト値は `false` です。
amount	boolean	必須。`true` の場合、売上予測種別は収益単位に基づきます。`false` の場合、売上予測種別は数量単位に基づきます。デフォルト値は `true` です。
dateType	string	必須。売上予測金額のベースとなる日付種別。 `OpportunityCloseDate`: 売上予測は、商談の完了予定日に基づきます。 `ProductDate`: 売上予測は、商談商品品目の提供日に基づきます (ある場合)。 `ScheduleDate`: 売上予測は、商談商品のスケジュール日に基づきます (ある場合)。次の値は、Performance Edition と、Sales Cloud が付属する Unlimited Edition で、API バージョン 52.0 以降で使用できます。 `OLIMeasureCloseDateOnly`: 売上予測は、商談の完了予定日に基づきます。 `ProductDateOnly`: 売上予測は、商談商品品目の提供日に基づきます (ある場合)。 `ScheduleDateOnly`: 売上予測は、商談商品のスケジュール日に基づきます (ある場合)。
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 コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>false</active>
4    <amount>true</amount>
5    <dateType>0</dateType>
6    <developerName>qqw</developerName>
7    <hasProductFamily>false</hasProductFamily>
8    <masterLabel>qqw</masterLabel>
9    <quantity>false</quantity>
10    <roleType>R</roleType>
11</ForecastingType>

テリトリー階層を使用する ForecastingType コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>false</active>
4    <amount>false</amount>
5    <dateType>0</dateType>
6    <developerName>New_Model6</developerName>
7    <hasProductFamily>false</hasProductFamily>
8    <masterLabel>Opportunity Quantity by Territory</masterLabel>
9    <quantity>true</quantity>
10    <roleType>Y</roleType>
11    <territory2Model>New_Model6</territory2Model>
12</ForecastingType>

商談分割種別を使用する ForecastingType コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>false</active>
4    <amount>true</amount>
5    <dateType>0</dateType>
6    <developerName>split12</developerName>
7    <hasProductFamily>false</hasProductFamily>
8    <masterLabel>split12</masterLabel>
9    <opportunitySplitType>Custom_Revenue</opportunitySplitType>
10    <quantity>false</quantity>
11    <roleType>R</roleType>
12</ForecastingType>

商談品目分割種別を使用する ForecastingType コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <amount>true</amount>
5    <dateType>0</dateType>
6    <developerName>productrevenuesplit</developerName>
7    <hasProductFamily>true</hasProductFamily>
8    <masterLabel>productrevenuesplit</masterLabel>
9    <opportunitySplitType>Revenue</opportunitySplitType>
10    <opptyLineItemSplitType>Revenue</opptyLineItemSplitType>
11    <quantity>false</quantity>
12    <roleType>R</roleType>
13</ForecastingType>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ForecastingType</name>
6    </types>
7    <version>52.0</version>
8</Package>

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

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

使用方法

API バージョン 52.0 より前で使用できた従来の売上予測種別は、有効化、無効化することはできますが、作成、削除することはできません。既存の売上予測種別を有効にするには、有効フラグを更新します。
API バージョン 52.0 以降でのみ使用できる売上予測種別は、作成、有効化、無効化、削除することができます。売上予測種別が存在しない場合は、無効な状態の売上予測種別が作成されます。売上予測種別が存在する場合は、有効フラグが更新されます。zip ファイルを 2 回リリースすると、売上予測種別が作成され、有効化されます。
メタデータ API 種別は、ForecastingSettings、ForecastingType、ForecastingSourceDefinition、ForecastingTypeSource の順にリリースします。すべてがパッケージファイルに指定されている場合は、自動的にこの順序に従います。