---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# LeadAPIValidationUtilOOB: スコープ指定

# LeadAPIValidationUtilOOB: スコープ指定 {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：6分

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

[リード API](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-api "リード API は、インスタンスからマーケティングリードとそれに関連するリード品目を作成、更新、およびクエリ/取得できるようにするエンドポイントを提供します。") メソッドが呼び出されたときのリードレコードの検証方法をカスタマイズする場合は、LeadAPIValidationUtil スクリプトインクルードのこのスクリプトインクルードのメソッドを上書きします。LeadAPIValidationUtil スクリプトインクルードで上書きするメソッドの名前は、LeadAPIValidationUtilOOB スクリプトインクルードファイル内のものと同じである必要があります。

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

リード管理の詳細については、「[Using Lead Management](https://www.servicenow.com/docs/access?context=lead-management-using&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。

## LeadAPIValidationUtilOOB:validateLeadObjectForPatchCall (オブジェクト leadObject) {#ariaid-title2}

リード API の `PATCH` エンドポイントを使用してリードレコードを更新するときに、指定されたリードとそれに関連する品目の渡されたフィールドを検証します。
このメソッドは、LeadAPIValidationUtilOOB スクリプトインクルードの processUpdateLead() メソッドによってトリガーされます。このメソッドでは、次のようなさまざまな検証が実行されます。

* 必須フィールドをチェック
* 電話番号とメールアドレスの形式が適切であることを確認します。
* 無効な値を無視して、選択フィールドと参照フィールドをチェックします。
* ステージを検証し、ユーザーがリードを認定しようとするとエラーをスローします。
{#LAVU-valLeadObjectForPatchCall_O__table_g1v_qls_ydc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| leadObject | オブジェクト | 指定されたリードレコードおよび関連するリード品目レコードで更新するフィールド。合格できるフィールドとそれに関連する要件のリストについては、「 [リード - PATCH /sn_lead_mgmt_core/lead/{sys_id}](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-PATCH-lead "指定されたリードレコードとそれに関連するリード品目を更新します。このエンドポイントを使用して、指定したリードに新しいリード品目を関連付けることもできます。")」を参照してください。 |
[表 : 1. パラメーター]

{#LAVU-valLeadObjectForPatchCall_O__table_g1v_qls_ydc} {#LAVU-valLeadObjectForPatchCall_O__table_h1v_qls_ydc__entry__2}

| タイプ | 説明 |
|-|-|
| \<JSON オブジェクト\> | 検証の結果。 { "errors": [Array], "indexesOfleadLineItemsForInsertion": [Array] } |
| \<JSON object\>.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 に挿入する必要がある新しいリード品目のインデックス。 データタイプ:整数の配列 |
[表 : 2. 返される内容]

{#LAVU-valLeadObjectForPatchCall_O__table_h1v_qls_ydc}  
次のコード例は、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) {#ariaid-title3}

リード API の `POST` エンドポイントを使用してリードレコードを作成するときに、指定されたリードとその関連品目の渡されたフィールドを検証します。
このメソッドは、LeadAPIValidationUtilOOB スクリプトインクルードの processCreateLead() メソッドによってトリガーされます。このメソッドでは、次のようなさまざまな検証が実行されます。

* 必須フィールドを確認します。
* 電話番号とメールアドレスの形式が適切であることを確認します。
* 無効な値を無視して、選択フィールドと参照フィールドをチェックします。
{#LAVU-valLeadObjectForPostCall_O__table_ggp_t1s_ydc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| leadObject | オブジェクト | 新しいリードレコードと関連するリード品目レコードに挿入するフィールド。合格できるフィールドとそれに関連する要件のリストについては、「 [リード:投稿 /sn_lead_mgmt_core/リード](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-POST-lead "指定されたパラメーターを使用して、リードレコードとそれに関連するリード品目を作成します。")」を参照してください。 |
[表 : 3. パラメーター]

{#LAVU-valLeadObjectForPostCall_O__table_ggp_t1s_ydc} {#LAVU-valLeadObjectForPostCall_O__table_hgp_t1s_ydc__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | 渡されたリードとリード品目オブジェクトの検証中に検出されたエラーの詳細。エラーが検出されない場合は空のアレイを返します。 例： [ {"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 スクリプトインクルードにあります。 |
[表 : 4. 返される内容]

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

    var LeadAPIValidationUtil = Class.create(); 

    LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

    // Define overriding functions here 

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

    type: 'LeadAPIValidationUtil' 

    });