LeadAPIHelperOOB - 범위 지정됨

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기5분

    • LeadAPIHelperOOB 스크립트 포함은 리드 기록 세트를 GlideRecord 객체에서 JSON 배열 또는 JSON 객체로 변환하고 리드 객체 내의 필드를 변환하는 등 다양한 기능을 수행하기 위해 리드 REST API에서 호출하는 도우미 메서드를 제공합니다.

    이러한 도우미 함수를 사용자 지정하려면 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'
});