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

LeadConvert クラス

取引の開始に使用する情報が含まれます。

名前空間

Database

使用方法

convertLead データベースメソッドでは、リード取引開始によって取引先と取引先責任者、または取引先と個人取引先、および (必要に応じて) 商談が作成されます。convertLead は、Database.LeadConvert クラスのインスタンスをパラメータとして取ります。このクラスのインスタンスを作成し、リードとその変換先の取引先と取引先責任者の設定など、取引の開始に必要な情報を設定します。

Database.convertLead() メソッドは、1 つの LeadConvert オブジェクトまたは LeadConvert オブジェクトのリストを取ることができます。

メモ

この例では、Database.convertLead メソッドを使用してリード取引を開始する方法を示します。新規リードを挿入し、LeadConvert オブジェクトを作成してその状況を取引開始済みに設定し、Database.convertLead メソッドに渡します。最後に、取引の開始が成功したことを確認します。

1Lead myLead = new Lead(LastName = 'Fry', Company='Fry And Sons');
2insert myLead;
3
4Database.LeadConvert lc = new Database.LeadConvert();
5lc.setLeadId(myLead.id);
6
7LeadStatus convertStatus = [SELECT Id, MasterLabel FROM LeadStatus WHERE IsConverted=true LIMIT 1];
8lc.setConvertedStatus(convertStatus.MasterLabel);
9
10Database.LeadConvertResult lcr = Database.convertLead(lc);
11System.assert(lcr.isSuccess());

LeadConvert のコンストラクタ

LeadConvert のコンストラクタは次のとおりです。

LeadConvert()

Database.LeadConvert クラスの新しいインスタンスを作成します。

署名

public LeadConvert()

LeadConvert のメソッド

LeadConvert のメソッドは次のとおりです。すべてインスタンスメソッドです。

getAccountId()

リードをマージする取引先の ID を取得します。

署名

public ID getAccountId()

戻り値

型: ID

getContactId()

リードをマージする取引先責任者の ID を取得します。

署名

public ID getContactId()

戻り値

型: ID

getConvertedStatus()

取引開始済みのリードのリード状況の値を取得します。

署名

public String getConvertedStatus()

戻り値

型: String

getLeadID()

取引を開始するリードの ID を取得します。

署名

public ID getLeadID()

戻り値

型: ID

getOpportunityName()

作成する商談の名前を取得します。

署名

public String getOpportunityName()

戻り値

型: String

getOwnerID()

新しく作成する取引先、取引先責任者、商談の所有者となるユーザの ID を取得します。

署名

public ID getOwnerID()

戻り値

型: ID

getRelatedPersonAccountId()

リードの変換先の既存の個人取引先の ID を取得します。

署名

public ID getRelatedPersonAccountId()

戻り値

型: ID

getRelatedPersonAccountRecord()

リードの変換先の新しい個人取引先のエンティティレコードを取得します。

署名

public ID getRelatedPersonAccountRecord()

戻り値

型: ID

isDoNotCreateOpportunity()

リード変換時に商談を作成するかどうかを指定します (デフォルトは false で商談を作成し、true では作成しない)。

署名

public Boolean isDoNotCreateOpportunity()

戻り値

型: Boolean

isOverWriteLeadSource()

変換先の取引先責任者オブジェクトの LeadSource 項目に、変換元のリードオブジェクトの LeadSource 項目の値を上書きするかどうかを指定します (上書きする場合は true、上書きしない場合は false で、デフォルトでは上書きしません)。

署名

public Boolean isOverWriteLeadSource()

戻り値

型: Boolean

isSendNotificationEmail()

setOwnerId で指定された所有者に通知メールを送るかどうかを示します (送信する場合は true、送信しない場合は false。デフォルトは false)。

署名

public Boolean isSendNotificationEmail()

戻り値

型: Boolean

setAccountId(accountId)

リードをマージする取引先の ID を設定します。この値は、個人取引先を含めた既存の取引先を更新する場合にのみ必要です。

署名

public Void setAccountId(ID accountId)

パラメータ

accountId
型: ID

戻り値

型: Void

setContactId(contactId)

リードがマージされる取引先責任者の ID を設定します (この取引先責任者は、setAccountId で指定された取引先と関連付けられている必要があり、setAccountId の指定が必要です)。この値は、既存の取引先責任者を更新する場合のみ必要です。

署名

public Void setContactId(ID contactId)

パラメータ

contactId
型: ID

戻り値

型: Void

使用方法

setContactId が指定された場合、アプリケーションは、取引先と暗黙的に関連付けられる新しい取引先責任者を作成します。取引先責任者および他の既存のデータは上書きされません (ただし、setOverwriteLeadSource が true に設定されている場合は LeadSource 項目のみが上書きされます)。

リードを個人取引先に変換する場合、setContactId を指定しないでください。指定するとエラーが発生します。個人取引先の setAccountId のみを指定してください。

重要

setConvertedStatus(status)

変換されたリードのリード状況の値を設定します。この項目は必須です。

署名

public Void setConvertedStatus(String status)

パラメータ

status
型: String

戻り値

型: Void

setDoNotCreateOpportunity(createOpportunity)

リード変換時に商談を作成するかどうかを指定します。デフォルト値は false です。デフォルトでは、商談が作成されます。リードの商談を作成したくない場合のみ、このフラグを true に設定します。

署名

public Void setDoNotCreateOpportunity(Boolean createOpportunity)

パラメータ

createOpportunity
型: Boolean

戻り値

型: Void

setLeadId(leadId)

変換するリードの ID を設定します。この項目は必須です。

署名

public Void setLeadId(ID leadId)

パラメータ

leadId
型: ID

戻り値

型: Void

setOpportunityId(opportunityId)

リードをマージする商談の ID を設定します。この値は、既存の商談を更新する場合のみ必要です。

署名

public Void setOpportunityId(ID opportunityId)

パラメータ

opportunityId
型: ID

戻り値

型: Void

setOpportunityName(opportunityName)

作成する商談の名前を設定します。名前が指定されない場合、デフォルト値はリードの会社名となります。

署名

public Void setOpportunityName(String opportunityName)

パラメータ

opportunityName
型: String

戻り値

型: Void

使用方法

この項目の文字数は 80 文字までです。

setDoNotCreateOpportunity が true の場合、商談は作成されません。また、この項目は空のままにする必要があります。空でない場合はエラーが発生します。

setOverwriteLeadSource(overwriteLeadSource)

変換先の取引先責任者オブジェクトの LeadSource 項目に、変換元のリードオブジェクトの LeadSource 項目の値を上書きするかどうかを指定します。デフォルト値は false で、項目の値を上書きしません。true として指定した場合は、変換先取引先責任者の setContactId も指定する必要があります。

署名

public Void setOverwriteLeadSource(Boolean overwriteLeadSource)

パラメータ

overwriteLeadSource
型: Boolean

戻り値

型: Void

setOwnerId(ownerId)

新しく作成する取引先、取引先責任者、商談の所有者となるユーザの ID を指定します。アプリケーションでこの値を指定しない場合、リードの所有者が新しいオブジェクトの所有者となります。

署名

public Void setOwnerId(ID ownerId)

パラメータ

ownerId
型: ID

戻り値

型: Void

使用方法

このメソッドは、既存のオブジェクトにマージする場合は適用されません。setOwnerId が指定された場合、既存の取引先または取引先責任者の ownerId 項目は上書きされません。

setRelatedPersonAccountId(relatedPersonAccountId)

リードの変換先の既存の個人取引先の ID を設定します。この値は、既存の個人取引先を更新する場合のみ必要です。

署名

public Void setRelatedPersonAccountId(ID relatedPersonAccountId)

パラメータ

relatedPersonAccountId
型: ID

戻り値

型: Void

setRelatedPersonAccountRecord(Entity relatedPersonAccountRecord)

リードの変換先の新しい個人取引先のエンティティレコードを取得します。

署名

public Void setRelatedPersonAccountRecord(Entity relatedPersonAccountRecord)

パラメータ

relatedPersonAccountRecord
型: ID

戻り値

型: Void

setSendNotificationEmail(sendEmail)

setOwnerId で指定された所有者に通知メールを送るかどうかを指定します。デフォルト値は false で、メールを送信しません。

署名

public Void setSendNotificationEmail(Boolean sendEmail)

パラメータ

sendEmail
型: Boolean

戻り値

型: Void