LeadAPIValidationUtilOOB - スコープ指定

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：6分

    • LeadAPIValidationUtilOOB スクリプトインクルードは、リードレコードおよび関連するリード品目レコードが作成 (POST) または更新 (PATCH) するときに検証するために、リード REST API によって呼び出されるメソッドを提供します。

    リード APIメソッドが呼び出されたときのリードレコードの検証方法をカスタマイズする場合は、このスクリプトインクルードのメソッドを LeadAPIValidationUtil スクリプトインクルードで上書きします。LeadAPIValidationUtil スクリプトインクルードで上書きするメソッドの名前は、LeadAPIValidationUtilOOB スクリプトインクルードファイルの名前と同じである必要があります。

    この API は sn_lead_mgmt_core 名前空間内で提供されます。API にアクセスするには、リード管理データモデル (sn_lead_mgmt_core) プラグインがインスタンスでアクティブ化されており、呼び出し元ユーザーが sn_lead_mgmt_core.lead_integrator ロールを持っている必要があります。

    リード管理の詳細については、「Using Lead Management」を参照してください。

    LeadAPIValidationUtilOOB:validateLeadObjectForPatchCall (オブジェクト leadObject)

    リード API の PATCH エンドポイントを使用してリードレコードを更新するときに、指定されたリードとその関連品目の渡されたフィールドを検証します。

    このメソッドは、LeadAPIValidationUtilOOB スクリプトインクルードの processUpdateLead() メソッドによってトリガーされます。このメソッドは、次のようなさまざまな検証を実行します。
    • 必須フィールドを確認します
    • 電話番号とメールアドレスの形式が正しいことを確認します。
    • 無効な値を無視して、選択肢フィールドと参照フィールドをチェックします。
    • ステージを検証し、ユーザーがリードを認定しようとするとエラーをスローします。
    表 : 1. パラメーター
    名前 タイプ 説明
    リードオブジェクト オブジェクト 指定されたリードレコードおよび関連するリード品目レコードで更新するフィールド。渡すことができるフィールドのリストとそれに関連する要件については、「 lead:パッチ/sn_lead_mgmt_core/lead/{sys_id}」を参照してください。
    表 : 2. 戻り値
    タイプ 説明
    <JSON オブジェクト> 検証の結果。
    {
  "errors": [Array],
  "indexesOfleadLineItemsForInsertion": [Array] 
}
    <JSON オブジェクト>.errors 合格したリードおよびリード品目オブジェクトの検証中に検出されたエラーの詳細。エラーが検出されなかった場合は、空のアレイを返します。
    例：
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    これらのエラーメッセージは、 LeadAPIConstantsOOB スクリプトインクルードにあります。

    データタイプ：オブジェクトのアレイ
    <JSON オブジェクト>.indexesOfleadLineItemsForInsertion leadObject に挿入する必要がある新しいリード品目のインデックス。

    データタイプ:整数の配列

    次のコード例は、LeadAPIValidationUtil スクリプトインクルードで validateLeadObjectForPatchCall() メソッドのカスタムコードを追加する場所を示しています。

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here

validateLeadObjectForPatchCall: function(leadObject) { 
// Add your custom code here
}, 

type: 'LeadAPIValidationUtil' 

});

    LeadAPIValidationUtilOOB:validateLeadObjectForPostCall (オブジェクト leadObject)

    リード API の POST エンドポイントを使用してリードレコードを作成するときに、指定されたリードとその関連品目の渡されたフィールドを検証します。

    このメソッドは、LeadAPIValidationUtilOOB スクリプトインクルードの processCreateLead() メソッドによってトリガーされます。このメソッドは、次のようなさまざまな検証を実行します。
    • 必須フィールドを確認します。
    • 電話番号とメールアドレスの形式が正しいことを確認します。
    • 無効な値を無視して、選択肢フィールドと参照フィールドをチェックします。
    表 : 3. パラメーター
    名前 タイプ 説明
    リードオブジェクト オブジェクト 新しいリードレコードおよび関連するリード品目レコードに挿入するフィールド。渡すことができるフィールドのリストとそれに関連する要件については、「 lead:POST /sn_lead_mgmt_core/lead」を参照してください。
    表 : 4. 戻り値
    タイプ 説明
    アレイ 合格したリードおよびリード品目オブジェクトの検証中に検出されたエラーの詳細。エラーが検出されなかった場合は、空のアレイを返します。
    例：
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    これらのエラーメッセージは、 LeadAPIConstantsOOB スクリプトインクルードにあります。

    次のコード例は、LeadAPIValidationUtil スクリプトインクルードで validateLeadObjectForPostCall() メソッドのカスタムコードを追加する場所を示しています。

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here 

validateLeadObjectForPostCall: function(leadObject) { 
// Add your custom code
}, 

type: 'LeadAPIValidationUtil' 

});