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

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

重要

親種別

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

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

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

バージョン

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

項目

項目名	項目の型	説明
categoryField	string	売上予測種別に関連付けられている売上予測分類の名前。可能な値は次のとおりです。 `Opportunity.ForecastCategoryName`
dateField	string	売上予測種別の日付種別に使用される項目。たとえば、商談の CloseDate 項目は、商談完了予定日ベースの売上予測種別で使用されます。可能な値は次のとおりです。 `Opportunity.CloseDate` `OpportunityLineItem.ServiceDate` `OpportunityLineItemSchedule.ScheduleDate`
familyField	string	この項目は、売上予測を商品ファミリ別にグループ化する場合に使用します。可能な値は次のとおりです。 `Product2.Family`
masterLabel	string	必須。この売上予測ソース定義の表示パネルを制御します。
measureField	string	売上予測種別の基準に使用される項目。たとえば、商談の Amount 項目は、収益ベースの売上予測種別に関連付けられています。可能な値は次のとおりです。* `Opportunity.Amount` `Opportunity.Custom` `Opportunity.TotalOpportunityQuantity` `OpportunityLineItem.Custom` `OpportunityLineItem.Quantity` `OpportunityLineItem.TotalPrice` `OpportunityLineItemSchedule.Custom` `OpportunityLineItemSchedule.Quantity` `OpportunityLineItemSchedule.Revenue` `OpportunitySplit.Custom` `OpportunitySplit.SplitAmount` *`Custom` は、売上予測種別の基準のベースになるカスタム項目の名前を表します。例: エネルギー消費量を予測するには、`Megawatts__c` を使用します。
sourceObject	string	必須。この売上予測ソース定義に関連付けられているオブジェクト。可能な値は次のとおりです。 `Opportunity` `OpportunityLineItem` `OpportunityLineItemSchedule` `OpportunitySplit` `Product2`
territory2Field	string	テリトリーベースの売上予測種別の場合、テリトリー情報に使用される項目を示します。可能な値は次のとおりです。 `Opportunity.Territory2Id` ユーザロールベースの売上予測種別の場合、この値は `null` です。
userField	string	売上予測の所有者を指定します。可能な値は次のとおりです。 `Opportunity.OwnerId` `OpportunitySplit.SplitOwnerId`

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

ForecastingSourceDefinition コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ForecastingSourceDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>TestFsd</masterLabel>
4    <sourceObject>Opportunity</sourceObject>
5    <measureField>Opportunity.Amount</measureField>
6    <dateField>Opportunity.CloseDate</dateField>
7    <userField>Opportunity.OwnerId</userField>
8    <categoryField>Opportunity.ForecastCategoryName</categoryField>
9</ForecastingSourceDefinition>

前の定義を参照する 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>ForecastingSourceDefinition</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 の順にリリースします。すべてがパッケージファイルに指定されている場合は、自動的にこの順序に従います。