この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Opportunity

販売または保留中の取引である商談を表します。

サポートされているコール

create()、delete()、describeLayout()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、search()、undelete()、update()、upsert()

項目

項目 項目の型
AccountId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この商談と関連付けられた取引先の ID。
これはリレーション項目です。
リレーション���
Account
���レーション種別
Lookup
参照先
Account
AgeInDays
型
int
プロパティ
Aggregate、Filter、Group、Nillable、Sort
説明
商談が作成されてからの日数で、現在の日付から created_date 項目を引いた値で計算されます。パイプライン検査が有効になっている場合は、この項目を API バージョン 52.0 以降で使用できます。
Amount
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
売上の見積総額。商品が関連する商談では、関連商品の合計金額です。レコードに商品が指定されている場合、この項目を更新しようとすると無視されます。update コールは却下されず、その他の項目は指定されたとおりに更新されますが、金額は変わりません。
CampaignId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
関連する Campaign の ID。この項目は、Campaign をキャンペーン機能として有効化している組織にのみ定義されています。User が、商談のこの項目で相互参照される Campaign オブジェクトを作成または更新するには、そのオブジェクトへの参照権限が付与されている必要があります。
これはリレーション項目です。
リレーション名
Campaign
リレーション種別
Lookup
参照先
Campaign
CloseDate
型
date
プロパティ
Create、Filter、Group、Sort、Update
説明
必須。商談がクローズすると期待される日付。
ConnectionReceivedId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
組織とこのレコードを共有した PartnerNetworkConnection の ID。この項目は、Salesforce to Salesforce が有効な場合に使用できます。
ConnectionSentId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
このレコードを共有した PartnerNetworkConnection の ID。この項目は、Salesforce to Salesforce が有効な場合に使用できます。この項目は、API バージョン 15.0 以前を使用する場合にサポートされます。他の API バージョンでは、この項目の値は null です。レコードを接続に転送するには、新しい PartnerNetworkRecordConnection を使用します。
ContactId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
主取引先責任者として設定され、この商談に関連付けられた取引先責任者の ID。商談の作成と同時に作成される取引先責任者の役割から派生した参照のみの項目。この項目は作成時にのみ入力可能で、更新できません。この項目の値を更新するには、この商談に関連付けられた OpportunityContactRole で IsPrimary フラグを変更します。API バージョン 46.0 以降で利用できます。
ContractId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この商談と関連付けられた契約の ID。
CurrencyIsoCode
型
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
複数の currency 機能を有効化している組織にのみ使用できます。組織で使用できる currency の ISO コードが指定されています。
組織でマルチ通貨が使用でき、商談で Pricebook2 が指定されている場合 (Pricebook2Id 項目が空欄でない)、この項目の通貨値は、商談の品目と関連付けられている PricebookEntry レコードの通貨と一致する必要があります。
Description
型
textarea
プロパティ
Create、Nillable、Update
説明
商談のテキストによる説明。最大 32,000 文字です。
ExpectedRevenue
型
currency
プロパティ
Filter、Nillable、Sort
説明
商談の Amount 項目と Probability の積に等しい参照のみの項目。この項目を直接設定することはできませんが、Amount 項目または Probability 項目を設定することで間接的に設定できます。
Fiscal
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
会計年度が有効化されていない場合、商談の CloseDate が含まれる会計四半期または会計期間の名前。値の形式は「YYY Q」です (2006 年の第 1 四半期の場合、「2006 1」)。
FiscalQuarter
型
int
プロパティ
Filter、Group、Nillable、Sort
説明
会計四半期を表します。使用できる値は、1、2、3、または 4 です。
FiscalYear
型
int
プロパティ
Filter、Group、Nillable、Sort
説明
たとえば 2006 年度など、会計年度を表します。
ForecastCategory
型
picklist
プロパティ
Filter、Group、Restricted picklist、Sort
説明
Restricted picklist 項目。StageName 項目によって暗黙的に指定されますが、直接的に制御はされません。StageName 値で指定された値に対して、この項目で別の値を上書きできます。この項目の値は、固定された列挙型の値です。ユーザインターフェースでローカライズされたバージョンの表示ラベルが使用できる場合、この項目表示ラベルは、操作を実行するユーザの言語にローカライズされます。

API バージョン 12.0 以降では、この項目の値は ForecastCategoryName の値に基づいて自動的に設定され、別の方法で更新することはできません。項目のプロパティ Create、Defaulted on create、Nillable、および Update は、バージョン 12.0 では使用できません。

可能な値は次のとおりです。
  • BestCase
  • Closed
  • Forecast
  • MostLikely
  • Omitted
  • Pipeline
ForecastCategoryName
型
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
売上予測分類の名前。StageName 項目によって暗黙的に指定されますが、直接的に制御はされません。StageName 値で指定された値に対して、この項目で別の値を上書きできます。API バージョン 12.0 以降で使用できます。
可能な値は次のとおりです。
  • Best Case
  • Closed
  • Commit
  • Most Likely
  • Omitted
  • Pipeline
HasOpenActivity
型
boolean
プロパティ
Defaulted on create、Group
説明
商談に進行中の行動または ToDo があるか (true)、否か (false) を示します。API バージョン 35.0 以降で使用できます。
HasOpportunityLineItem
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
商談に関連する品目があるかどうかを示す参照のみの項目。true の値は、商談品目がその商談に作成されていることを示します。商談に価格表がある場合にのみ、商談は商談品目を指定できます。商談品目は、商談の Pricebook2 に記載された PricebookEntry オブジェクトに関連付ける必要があります。ただし、関連する Pricebook2 のない商談に商談品目を挿入できます。Pricebook2 のない商談に最初の商談品目を挿入すると、商談の CurrencyIsoCode 項目に一致する CurrencyIsoCode 項目を持つ有効な Pricebook2 の PricebookEntry に商談品目が一致する場合、API は自動的に Pricebook2Id 項目を設定します。Pricebook2 が有効でない、または CurrencyIsoCode 項目が一致しない場合、API はエラーを返します。商談品目名が Opportunity に存在する場合、Pricebook2Id または PricebookId 項目を更新することはできません。PricebookId 項目を更新する前に、品目を削除する必要があります。
HasOverdueTask
型
boolean
プロパティ
Defaulted on create、Group
説明
商談に期限切れの ToDo があるか (true)、否か (false) を示します。API バージョン 35.0 以降で使用できます。
IqScore
型
int
プロパティ
Aggregate、Filter、Group、Nillable、Sort
説明
1 から 99 のスケールで測定される商談成立の可能性。[Einstein 商談スコアリング] を有効にする必要があります。API バージョン 41.0 以降で利用できます。表示ラベルは [商談スコア] です。
IsClosed
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
StageName によって直接制御されます。この項目ではクエリや絞り込みを実行できますが、作成、更新/挿入、または更新要求でこの項目を直接設定することはできません。StageName を介してのみ設定できます。表示ラベルは [クローズ] です。
IsDeleted
型
boolean
プロパティ
Defaulted on create、Filter
説明
オブジェクトがごみ箱に移動したか (true)、否か (false) を示します。表示ラベルは Deleted です。
IsExcludedFromTerritory2Filter
型
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
検索条件ベースの商談テリトリー割り当てに使用します (Spring '15/API バージョン 33 ではパイロット)。APEX 検索条件を実行するたびに商談を除外するか (True)、含めるか (False) を示します。
IsPriorityRecord
型
boolean
プロパティ
Defaulted on create、Group
説明
ユーザが商談を重要としてマークしたか (true)、否か (false) を示します。デフォルト値は false です。API バージョン 53.0 以降で使用できます。
IsSplit
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
商談チームメンバー間で商談のクレジットを分割するかどうかを示す参照のみの項目。表示ラベルは IsSplit です。パイロット期間中に組織で商談分割が有効化されている場合、この項目はバージョン 14.0 以降で使用できます。

この項目の使用はお勧めしません。これはコードに IsSplit への参照があるパイロットユーザのために記載されています。

警告

IsWon
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
StageName によって直接制御されます。この項目ではクエリや絞り込みを実行できますが、値を直接設定することはできません。StageName を介してのみ設定できます。表示ラベルは [成立] です。
LastActivityDate
型
date
プロパティ
Filter、Group、Nillable、Sort
説明
値は、次のいずれかのうち、最新のものになります。
  • レコードに対して記録された直近の行動の期日。
  • レコードに関連付けられた ToDo のうち直近に完了したものの期日。
LastActivityInDays
型
int
プロパティ
Aggregate、Filter、Group、Nillable、Sort
説明
最後に完了したイベントまたはレコードの ToDo からの日数で、現在の日付から last_activity 項目を引いた値で計��されます。last_activity 項目が NULL の場合、この項目も NULL になります。パイプライン検査が有効になっている場合は、この項目を API バージョン 52.0 以降で使用できます。
LastAmountChangedHistoryId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
Winter '21 以降で商談の金額項目が最後にいつ更新されたかに関する情報を含む OpportunityHistory レコードの ID。情報には、変更日時と変更者が含まれます。API バージョン 50.0 以降で利用できます。
これはリレーション項目です。
リレーション名
LastAmountChangedHistory
リレーション種別
Lookup
参照先
OpportunityHistory
LastCloseDateChangedHistoryId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
Winter '21 以降で商談の完了予定日項目が最後にいつ更新されたかに関する情報を含む OpportunityHistory レコードの ID。情報には、変更日時と変更者が含まれます。API バージョン 50.0 以降で利用できます。
これはリレーション項目です。
リレーション名
LastCloseDateChangedHistory
リレーション種別
Lookup
参照先
OpportunityHistory
LastReferencedDate
型
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコード、このレコードに関連するレコード、またはリストビューに最後にアクセスしたときのタイムスタンプ。
LastStageChangeDate
型
datetime
プロパティ
Aggregate、Filter、Nillable、Sort
説明
この商談レコードの Stage 項目が最後に変更された日付。この項目は、API バージョン 52.0 以降で使用できます。
LastStageChangeInDays
型
int
プロパティ
Aggregate、Filter、Group、Nillable、Sort
説明
この商談レコードの Stage 項目が最後に変更された日付で、現在の日付から last_stage_change_date 項目を引いた値で計算されます。last_stage_change_date が null の場合、この項目には AgeInDays の値が含まれます。パイプライン検査が有効になっている場合は、この項目を API バージョン 52.0 以降で使用できます。
LastViewedDate
型
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードまたはリストビューを最後に表示したときのタイムスタンプ。この値が null の場合、ユーザはこのレコードまたはリストビューにアクセスしただけで (LastReferencedDate) 表示していない可能性があります。
LeadSource
型
picklist
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
「広告」、「展示会」など、この商談の取得元。
Name
型
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
必須。この商談の名前。最大 120 文字です。
NextStep
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
商談のクローズ時の次の ToDo の説明。最大 255 文字です。
OwnerId
型
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
この商談を処理するために割り当てられた User の ID。

この項目を更新する場合、以前の所有者のアクセス権は、参照のみ、または商談について組織の共有設定に指定されたアクセス権のうち、より高い権限に設定されます。

商談チームを組織に設定した場合、API のバージョンに応じて、この項目を更新する結果が次のように異なります。

  • API バージョン 12.0 以降の場合、すべてのオブジェクト同様、レコードの共有は保持されます。
  • API バージョン 12.0 より古い場合は、レコードの共有が削除されます。
  • API バージョン 16.0 以降では、この項目を使用して取引先の所有権を更新 (移行) するために、ユーザは「レコードの移行」権限が必要です。
これはリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
User
PartnerAccountId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
この商談を所有するパートナーユーザのパートナー取引先の ID。PRM 機能が有効な場合、またはデジタルエクスペリエンスが有効になっていて、パートナーポータルライセンスを所有している場合に使用できます。

API バージョン 15.0 以前を使用して商談をアップロードしており、バッチのいずれかの商談にパートナーユーザが所有者として指定されている場合、バッチ内のすべての商談の [パートナー取引先] 項目が、パートナーユーザが所有者であるかどうかに関係なく、パートナーユーザの取引先に設定されます。バージョン 16.0 では、[パートナー取引先] 項目は、商談を所有するパートナーユーザの該当する取引先に設定されます。商談の所有者がパートナーユーザでない場合、この項目は空のままです。

メモ

Pricebook2Id
型
reference
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Sort、Update
説明
関連する Pricebook2 オブジェクトの ID。Pricebook2Id 項目は、この商談に適用される Pricebook2 を示します。Pricebook2Id 項目は、商品機能を有効化している組織にのみ定義されます。いずれか一方の項目 (Pricebook2Id または PricebookId) に値を指定できます。両方指定することはできません。このため、両方の項目が nillable を宣言しています。
これはリレーション項目です。
リレーション名
Pricebook2
リレーション種別
Lookup
参照先
Pricebook2
PricebookId
型
reference
プロパティ
Create、Defaulted on create、Filter、Nillable、Update
説明
バージョン 3.0 では使用できません。バージョン 8.0 では、Pricebook オブジェクトはサポートされていません。Pricebook2 レコードの ID を指定して、Pricebook2Id 項目を代わりに使用します。
Probability
型
percent
プロパティ
Create、Defaulted on create、Filter、Nillable、Sort、Update
説明
商談の受注に対する確度 (%)。StageName 項目によって暗黙的に指定されますが、直接的に制御はされません。StageName で指定するのではなく、この項目を別の値に上書きできます。

Partner WSDL コールを使用して API を介して、または Apex before トリガを使用して、Probability 項目を変更するときに、値に小数部が含まれている可能性がある場合は、値を整数に丸めることをお勧めします。たとえば、before トリガの o.probability = o.probability.round(); の Apex で round メソッドを使用し、項目値を変更します。

メモ

PushCount
型
int
プロパティ
Filter、Group、Nillable、Sort
説明
商談の完了予定日が 1 カレンダー月延期された回数。たとえば、完了予定日を 4 月から 5 月に移動することは 1 回の延期とみなされますが、4 月 1 日から 4 月 30 日への移動は延期とみなされません。完了予定日が前に移動した場合、合計は減少しません。API バージョン 53.0 以降で使用できます。
RecordTypeId
型
reference
プロパティ
Create、Filter、Nillable、Update
説明
このオブジェクトに割り当てられるレコードタイプの ID。
StageName
型
picklist
プロパティ
Create、Filter、Group、Sort、Update
説明
必須。このレコードの現在のフェーズ名。StageName 項目は、商談の別の項目をいくつか制御します。それぞれの項目は直接設定、または StageName 項目を変更して暗黙的に設定することができます。また、StageName 項目は選択リストであり、返される describeSObjectResult には、その他の項目への影響を表す追加の構成要素が含まれます。選択リストのフェーズ名の値を取得するには、OpportunityStage オブジェクトを照会します。StageName が更新されると、ForecastCategoryName、IsClosed、IsWon、および Probability がフェーズカテゴリの対応付けに基づいて自動的に更新されます。
SyncedQuoteID
型
reference
プロパティ
Create、Filter、Nillable、Update
説明
Apex トリガで参照のみです。商談と同期する Quote の ID。この項目を設定すると、商談と見積の同期の開始と停止を行えます。ID は、商談の子である見積の ID である必要があります。
Territory2Id
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
商談に割り当てられているテリトリーの ID。組織でエンタープライズテリトリー管理が有効化されている場合にのみ使用できます。

商談の取引先へのフルアクセス権があるユーザは、有効なモデルの任意のテリトリーを商談に割り当てることができます。その取引先への共有アクセス権を持たないユーザは、商談の取引先にも割り当てられたテリトリーのみを割り当てることができます。同じ制限が、システムモードで Apex を介して作成されるテリトリー割り当てに適用されます。

メモ

TotalOpportunityQuantity
型
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
この商談に含まれる品目数。数量ベースの売上予測で使用します。
Type
型
picklist
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
商談の種別。たとえば、「既存ビジネス」または「新規ビジネス」などです。表示ラベルは [商談種別] です。

商談データをインポートし、CreatedDate など、監査項目に値を設定する必要がある場合は、Salesforce に連絡してください。これらの項目を自身で設定する必要がない限り、監査項目は API 操作時に自動的に更新されます。

メモ

使用方法

営業や進行中の商談に関する情報を管理するには、この Opportunity オブジェクトを使用します。また、このオブジェクトは子の Quote と同期することもできます。商談を更新するには、クライアントアプリケーションに商談の「編集」権限が必要です。API を使用して、商談に関連付けられた Attachment レコードを作成、更新、削除、および照会できます。複数の商談チームメンバー間で商談のクレジットを分割するには、OpportunitySplit オブジェクトを使用します。

また、クライアントアプリケーションは、convertLead() を使用して Lead を変換して商談オブジェクトを作成または更新することもできます。

商談および商談商品では、子になる商談商品またはスケジュールへの更新によって親レコードが更新されると、ワークフロールール、入力規則、および Apex トリガが発行されます。つまり、親レコードに対する更新があるときには、カスタムアプリケーションロジックを強制して、より高いデータの品質と組織のビジネスポリシー準拠が保証されます。

メモ

サンプルコード — Java

このコードは、オブジェクトと子の見積の同期を開始します。

1public void startQuoteSync() {
2         Opportunity opp = new Opportunity(); 
3         opp.setId(new ID("006D000000CpOSy")); 
4         opp.setSyncedQuoteId(new ID("0Q0D000000002OZ")); 
5   // Invoke the update call and save the results
6   try {
7      SaveResult[] saveResults = binding.update(new SObject[] {opp});
8      // check results and do more processing after the update call ...
9   }
10   catch (Exception ex) {
11      System.out.println("An unexpected error has occurred." + ex.getMessage());
12      return;
13 }
14}

このコードは、オブジェクトと子の見積の同期を停止します。

1public void stopQuoteSync() {
2         Opportunity opp = new Opportunity(); 
3         opp.setId(new ID("006D000000CpOSy")); 
4         opp.setFieldsToNull(new String[]  {"SyncedQuoteId"} );
5   // Invoke the update call and save the results
6   try {
7      SaveResult[] saveResults = binding.update(new SObject[] {opp});
8      // check results and do more processing after the update call ...
9   }
10   catch (Exception ex) {
11      System.out.println("An unexpected error has occurred." + ex.getMessage());
12      return;
13 }
14}

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。特に記載がない限り、これらはこのオブジェクトと同じ API バージョンで使用できます。

OpportunityChangeEvent (API バージョン 44.0)
このオブジェクトには変更イベントを利用できます。
OpportunityFeed (API バージョン 18.0)
このオブジェクトにはフィード追跡を利用できます。
OpportunityHistory
オブジェクトの追跡項目について履歴を利用できます。
OpportunityOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
OpportunityShare
このオブジェクトには共有を利用できます。

その他の考慮事項

before トリガを使用して商談レコードの [フェーズ] および [売上予測分類] を設定する場合、次のように動作します。
  • [フェーズ] および [売上予測分類] を設定すると、商談レコードにはこれらの正確な値が含まれます。
  • [フェーズ] を設定して [売上予測分類] を設定しない場合、商談レコードの [売上予測分類] はデフォルトで [フェーズ] トリガに関連付けられた値に設定されます。
  • [フェーズ] を API コールで指定した値またはユーザインターフェースから受信した値にリセットすると、[売上予測分類] 値も API コールまたはユーザインターフェースによって入力されます。[売上予測分類] に値を指定せず、入力された [フェーズ] がトリガ [フェーズ] とは異なる場合、[売上予測分類] はデフォルトで [フェーズ] に関連付けられた値に設定されます。トリガ [フェーズ] と入力された [フェーズ] が同じ場合、[売上予測分類] はデフォルト値に設定されません。
商品に関連する商談をコピーする場合、次のイベントが順に発生します。
  1. 親商談が実行の順序に従って保存されます。
  2. 商談商品が実行の順序に従って保存されます。

商談商品でエラーが発生した場合は、商談に戻ってエラーを修正してからコピーを行う必要があります。

商談商品に固有のカスタム項目が含まれている場合は、それらをすべて null に設定してから商談をコピーする必要があります。

メモ