LeadAPIHelperOOB: スコープ指定

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

    • LeadAPIHelperOOB スクリプトインクルードは、リード REST API によって呼び出されるヘルパーメソッドを提供し、リードレコードのセットを GlideRecord オブジェクトから JSON アレイまたは JSON オブジェクトに変換したり、リードオブジェクト内のフィールドを変換したりするなど、さまざまな機能を実行します。

    これらのヘルパー関数をカスタマイズする場合は、 LeadAPIHelper スクリプトインクルードのこのスクリプトインクルードのメソッドを上書きします。LeadAPIHelper スクリプトインクルードで上書きするメソッドの名前は、LeadAPIHelperOOB スクリプトインクルードファイル内のものと同じである必要があります。

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

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

    LeadAPIHelperOOB:getJSONFromGR(GlideRecord gr、アレイフィールド)

    GlideRecord オブジェクトを JSON オブジェクトに変換します。このメソッドは、GlideRecord のフィールドを反復処理し、そのタイプをチェックして、JSON 互換構造に値を適切にフォーマットします。

    表 : 1. パラメーター
    名前 タイプ 説明
    gr GlideRecord JSON オブジェクトに変換する GlideRecord オブジェクト。
    フィールド アレイ オプション。 JSON オブジェクトに含めるカンマ区切りのフィールド名。これらの名前は、リードレコードの名前と正確に一致する必要があります。
    例: ["account", "first_name", "do_not_call", "lead_line_items"]
    注:

    fieldsパラメーターが null の場合、または値「lead_line_items」が含まれている場合、メソッドは、品目のすべてのフィールドを含む、関連する各品目レコードをフェッチします。

    この方法では、リード品目 [sn_lead_mgmt_core_lead_line_item] テーブルではなく、リード [sn_lead_mgmt_core_lead] テーブルの個々のフィールドの変換のみがサポートされます。[リード品目] テーブルから特定のフィールドを指定すると、そのフィールドは無視されます。

    デフォルト:すべてのリードレコードフィールドが JSON オブジェクトに含まれます。
    表 : 2. 戻り値
    タイプ 説明
    JSON オブジェクト 指定された GlideRecord のフィールドを含む JSON オブジェクト。

    GlideRecord の各フィールドは、キーと値のペアに変換されます。参照フィールド、選択フィールド、日時フィールド、およびその他の特定のデータ型には、それらが正しく書式設定されるように特別な処理が適用されます。

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

    var LeadAPIHelper = Class.create(); 
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here
getJSONFromGR: function(gr, fields) {

// Add your custom code here
},

type: 'LeadAPIHelper'
});

    LeadAPIHelperOOB:getLeadsJSON(GlideRecord leadsGr、アレイフィールド)

    リードレコードのセットを GlideRecord オブジェクトから JSON アレイに変換します。JSON アレイに含めるリードレコードフィールドを指定する必要があります。

    表 : 3. パラメーター
    名前 タイプ 説明
    leadsGr GlideRecord JSON に変換するリードレコードを含む GlideRecord オブジェクト。

    テーブル:リード [sn_lead_mgmt-core_lead]
    フィールド アレイ JSON オブジェクトに含めるカンマ区切りのフィールド名。これらの名前は、リードレコードの名前と正確に一致する必要があります。
    例: ["account", "first_name", "do_not_call", "lead_line_items"]
    注:

    fieldsパラメーターが null の場合、または値「lead_line_items」が含まれている場合、メソッドは、品目のすべてのフィールドを含む、関連する各品目レコードをフェッチします。

    この方法では、リード品目 [sn_lead_mgmt_core_lead_line_item] テーブルではなく、リード [sn_lead_mgmt_core_lead] テーブルの個々のフィールドの変換のみがサポートされます。[リード品目] テーブルから特定のフィールドを指定すると、そのフィールドは無視されます。
    表 : 4. 戻り値
    タイプ 説明
    JSON オブジェクトのアレイ 各オブジェクトは、指定されたフィールドを含むリードを表します。該当する場合は、すべてのリードのリード品目オブジェクトのアレイも含まれます。

    GlideRecord の各フィールドは、キーと値のペアに変換されます。参照フィールド、選択フィールド、日時フィールド、およびその他の特定のデータ型には、それらが正しく書式設定されるように特別な処理が適用されます。

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

    var LeadAPIHelper = Class.create();
LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, { 

// Define overriding functions here 
getLeadsJson: function(leadsGR, fields) {

// Add your custom code here
}, 

type: 'LeadAPIHelper' 
});

    LeadAPIHelperOOB:getTransformedLeadObject(オブジェクト leadObject)

    指定されたリードオブジェクトを変換します。

    この変換には次のものが含まれます。
    • 無視されたフィールドを削除しています。
    • 参照フィールドをsys_idなどの関連する値に変換する。
    • 作業メモテキストをカンマ区切りの文字列に結合します。
    • アカウント、連絡先、コンシューマーの各フィールドを検証しています。アカウントとコンシューマーの両方に値が含まれている場合、アカウント、連絡先、およびコンシューマーの値は無視されます。
    表 : 5. パラメーター
    名前 タイプ 説明
    leadObject オブジェクト 変換するリードオブジェクト。このオブジェクトには、リードとそれに関連するリード品目の詳細が含まれています。
    表 : 6. 戻り値
    タイプ 説明
    オブジェクト 変換されたリードオブジェクト。

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

    var LeadAPIHelper = Class.create();

LeadAPIHelper.prototype = Object.extendsObject(LeadAPIHelperOOB, {

// Define overriding functions here 
getTransformedLeadObject: function(leadObject) { 

// Add your custom code here
}, 

type: 'LeadAPIHelper'
});