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

convertLead()

Lead を Account、Contact または必要に応じて Opportunity に変換します。

構文

使用方法

convertLead() は Lead を Account、Contact、および必要に応じて Opportunity へと変換するために使用します。ビジネスによっては、convertLead() を使用してリードを取引先責任者ではなく、取引先と個人取引先に変換することもできます。Lead を変換するには、リードでは「リードの取引の開始」権限と「編集」権限、Account、Contact および Opportunity では「作成」権限と「編集」権限が割り当てられた状態でクライアントアプリケーションでログインする必要があります。

このコールにより、評価済みリードの情報を新規作成または更新された取引先、取引先責任者、商談に簡単に変換できます。組織は、リードを評価する時期を決定するガイドラインを独自に設定することができます。予測したい実際の商談になったときにリードを変換するのが一般的です。

データが既存の取引先、取引先責任者、商談オブジェクトにマージされる場合、変換先オブジェクトの空の項目のみが上書きされ、既存のデータ (ID を含む) は上書きされません。唯一の例外は、クライアントアプリケーションが overwriteLeadSource を true に設定している場合です。この場合、変換先の Contact オブジェクトの LeadSource 項目は変換元の Lead オブジェクトの LeadSource 項目の内容で上書きされます。

リードを変換する際は、次のルールやガイドラインを考慮する必要があります。

項目の対応付け

システムは、リードの標準項目を取引先、取引先責任者、商談の標準項目に自動的に対応付けます。リードのカスタム項目に関しては、Salesforce システム管理者が、取引先、取引先責任者、商談のカスタム項目に対応づける方法を指定することができます。

レコードタイプ

組織でレコードタイプを使用している場合、新しい所有者のデフォルトのレコードタイプはリード変換時に作成されたレコードに割り当てられます。レコードタイプについての詳細は、Salesforce ヘルプを参照してください。

選択リスト値

システムは、空の標準リード選択リスト項目を対応付けるときに、取引先、取引先責任者、商談のデフォルトの選択リストを割り当てます。組織でレコードタイプを使用している場合、空の値は新しいレコード所有者のデフォルトの選択リストの値で置き換えられます。

文字列値

API バージョン 15.0 以降、文字列を含む項目に値を指定し、値が項目に対して大きすぎる場合、コールは失敗してエラーが返されます。これまでのバージョンの API では、値は切り捨てられ、コールは正常に終了していました。バージョン 15.0 以降でもこの動作を保持する場合、AllowFieldTruncationHeader SOAP ヘッダーを使用してください。

エラー

一括操作でいずれかのリードが変換に失敗した場合、リードごとに個別にリード変換が再試行されます。

Chatter フィードの自動登録

リードを新規の取引先、取引先責任者、商談に変換すると、リード所有者はそのリードレコードの Chatter フィードから登録解除されます。リード所有者、生成されたレコードの所有者、およびリードに登録されたユーザは、Chatter フィード設定で自動登録を有効化しない限り、生成されたレコードに自動登録されません。ニュースフィードで取引先、取引先責任者、および商談レコードへの変更を表示するには、自動登録を有効化する必要があります。

ユーザはレコードまたは他のユーザを登録できます。レコードへの変更とユーザからの更新は、ユーザのホームページの Chatter フィードに表示されます。これは、Salesforce で他のユーザやレコードに加えられた変更の最新状況を把握するのに役立ちます。フィードは、API バージョン 18.0 以降で使用できます。

リードの変換の基本ステップ

リードの変換は、次の基本ステップに従います。

クライアントアプリケーションは、変換されるリードの ID を確認します。
必要に応じて、クライアントアプリケーションはリードをマージする取引先の ID も確認します。クライアントアプリケーションは SOSL または SOQL を使用し、リード名と一致する取引先を検索します。次に例を示します。
必要に応じて、クライアントアプリケーションはリードをマージする取引先責任者の ID も確認します。クライアントアプリケーションは SOSL または SOQL を使用し、リードの取引先責任者名と一致する取引先責任者を検索します。次に例を示します。
必要に応じて、クライアントアプリケーションは商談をリードから作成するか、またはリードをマージする商談の ID から作成するかを決定します。クライアントアプリケーションは SOSL または SOQL を使用し、リードの取引先責任者名と一致する取引先責任者を検索します。次に例を示します。
クライアントアプリケーションは LeadStatus テーブルへのクエリを実行して、考えられる取引開始後の状況オプションを取得します。
その後、取引開始後の状況の値を選択します。
クライアントアプリケーションは convertLead() をコールします。
クライアントアプリケーションは返された結果の各 LeadConvertResult オブジェクトを反復処理して調べ、各リードの変換が成功したかどうかを確認します。
ベストプラクティスは、クライアントアプリケーションで WhoId が ContactId であるタスクを実行することです。商談が作成された場合、WhatId が OpportunityId となります。
必要に応じて、キューが所有するリードを変換する場合は所有者を指定する必要があります。これは、キューが取引先と取引先責任者を所有することができないためです。既存の取引先または取引先責任者を指定する場合も、所有者を指定する必要があります。

サンプルコード — Java

このサンプルでは、リードの取引の開始方法を示します。2 つのリードを作成し、リードを開始します。次に、リードの取引開始結果を反復処理し、リードごとに作成された取引先、取引先責任者、商談の ID を書き込みます。

サンプルコード — C#

LeadConvert の引数

このコールは LeadConvert オブジェクトの配列を受け取ります (100 個まで)。LeadConvert オブジェクトには次のプロパティがあります。

名前	型	説明
accountId	ID	リードをマージする Account の ID。個人取引先を含めた既存の取引先を更新する場合のみ必要です。`accountID` が指定されない場合、API は新しい取引先を作成します。新しい取引先を作成するには、クライアントアプリケーションは条件を満たすアクセス権限でログインする必要があります。リードを既存の取引先にマージするには、クライアントアプリケーションは指定された取引先への「参照・更新」アクセス権を持ってログインする必要があります。取引先名と他の既存のデータは上書きされません。ID についての詳細は、「ID データ型」を参照してください。
contactId	ID	リードがマージされる Contact の ID (この取引先責任者は、指定された accountId と関連付けられていなければならず、accountId の指定が必要です)。既存の取引先を更新する場合のみ必要です。リードを個人取引先に変換する場合は、contactId を指定しないでください。指定するとエラーになります。個人取引先の accountId のみを指定してください。重要 `contactID` が指定されない場合、API は Account と暗黙的に関連付けられる取引先責任者を作成します。新しい取引先責任者を作成するには、クライアントアプリケーションは条件を満たすアクセス権限でログインする必要があります。リードを既存の取引先責任者にマージするには、クライアントアプリケーションは指定された取引先責任者への「参照・更新」アクセス権を持ってログインする必要があります。取引先責任者名とその他の既存データは上書きされません (ただし overwriteLeadSource が `true` に設定されている場合には、LeadSource 項目のみが上書きされます)。
convertedStatus	string	変換されたリードの有効な LeadStatus 値。必須。必須。この項目に設定できる値のリストを取得するには、クライアントアプリケーションが LeadStatus オブジェクトへのクエリを実行します。次に例を示します。
doNotCreateOpportunity	boolean	リード変換時に Opportunity を作成するかどうかを指定 (デフォルトは `false` で商談を作成し、`true` では作成しない)。リードから商談を作成しない場合にのみ、このフラグを `true` に設定します。デフォルトでは、商談は作成されます。
leadId	ID	変換する Lead の ID。必須。ID についての詳細は、「ID データ型」を参照してください。
opportunityId	ID	リードに関連付ける既存の商談の ID。opportunityId 引数と opportunityName 引数は相互に排他的です。両方の値を指定すると、エラーが発生します。doNotCreateOpportunity 引数が `true` の場合、商談は作成されません。また、この項目は空のままにする必要があります。空でない場合はエラーが発生します。
opportunityName	string	作成する商談の名前。名前が指定されない場合、デフォルト値はリードの会社名となります。この項目の文字数は 80 文字までです。opportunityId 引数と opportunityName 引数は相互に排他的です。両方の値を指定すると、エラーが発生します。doNotCreateOpportunity 引数が `true` の場合、商談は作成されません。また、この項目は空のままにする必要があります。空でない場合はエラーが発生します。
overwriteLeadSource	boolean	変換先の Contact オブジェクトの LeadSource 項目に、変換元の Lead オブジェクトの LeadSource 項目の値を上書きするかどうかを指定します (上書きする場合は `true`、上書きしない場合は `false` で、デフォルトでは上書きしません)。この項目を `true` に設定するには、クライアントアプリケーションは変換先の取引先責任者の contactId を指定する必要があります。
ownerId	ID	新しく作成する取引先、取引先責任者、商談の所有者となるユーザの ID を指定します。クライアントアプリケーションでこの値を指定しない場合、新しいオブジェクトの所有者はリードの所有者になります。既存のオブジェクトにマージする場合には適用されません。ownerId が指定されている場合、API は既存の取引先または取引先責任者の ownerId 項目を上書きしません。ID についての詳細は、「ID データ型」を参照してください。
relatedPersonAccountId	ID	リードを取引先責任者ではなく、法人取引先と個人取引先に変換する場合、リードを変換する既存の個人取引先の ID を指定します。
relatedPersonAccountRecord	エンティティ	リードを取引先責任者ではなく、法人取引先と個人取引先に変換する場合、リードを変換する新しい個人取引先のエンティティレコードを指定します。
sendNotificationEmail	boolean	ownerId で指定された所有者に通知メールを送るかどうかを指定します (送信する場合は `true`、送信しない場合は `false`。デフォルトは false)。

応答

LeadConvertResult[]

障害

UnexpectedErrorFault

SOAP API 開発者ガイド