비즈니스 지향 API

비즈니스 API는 각 개체 유형에만 적용됩니다. 이러한 효과는 다음과 같습니다.

이 섹션에서는 "Subscribe", "Unsubscribe" 및 "SubmitDelivery" 서비스의 사용에 대해 자세히 설명합니다.

중요

캠페인 JSAPI 설명서에는 SOAP 호출 및 Adobe Campaign의 Javascript 사용에 대한 추가 정보와 애플리케이션에서 사용되는 모든 메서드 및 기능에 대한 전체 참조가 포함되어 있습니다.

구독(nms:구독)

이 서비스를 사용하면 정보 서비스에 수신자를 가입시키고 수신자 프로필을 업데이트할 수 있습니다.

서비스를 호출하려면 다음 매개 변수가 필요합니다.

  • 인증,
  • 구독 서비스의 내부 이름,
  • 받는 사람 정보가 포함된 XML 문서("nms:recipient" 스키마에서),
  • 아직 수신자가 없는 경우 수신자를 만들 수 있는 부울입니다.

"nms:subscription" 스키마의 "subscribe" 메서드에 대한 설명:

<method name="Subscribe" static="true">
  <parameters>
     <param name="serviceName" type="string"  desc="List of information service names (comma separated)"/>
     <param name="recipient" type="DOMElement" desc="Recipient"/>
     <param name="create" type="Boolean" desc="Create recipient if it does not exist"/>
   </parameters>
</method>

조정 키의 정의는 XML 문서의 요소에 있는 _​key 속성을 통해 <recipient> 입력해야 합니다. 이 속성의 내용은 쉼표로 구분된 XPath 목록입니다.

이 호출은 오류를 제외한 모든 데이터를 반환하지 않습니다.

예제

이메일 주소의 수신자 조정 키가 포함된 구독:입력 XML 문서는 이 필드에서 이메일 주소와 키 정의를 참조해야 합니다.

<recipient _key="email" email= "john.doe@adobe.com"/>

수신자와 구독을 업데이트합니다.

<recipient _key="email, [folder-id]" email= "john.doe@adobe.com" folder-id="1305" firstName="John" lastName="Doe"/>

SOAP 메시지 예

  • 쿼리:

    <?xml version='1.0' encoding='ISO-8859-1'?>
    <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <m:Subscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
          <sessiontoken xsi:type='xsd:string'/>
          <service xsi:type='xsd:string'>SVC1</service>
          <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
            <recipient _key="@email" email= "john.doe@adobe.com/>
          </content>
          <create xsi:type='xsd:boolean'>true</create>
        </m:Subscribe>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
  • 응답:

    <?xml version='1.0' encoding='ISO-8859-1'?>
    <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <m:SubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
        </m:SubscribeResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

구독 취소(nms:구독)

이 서비스를 사용하면 정보 서비스에서 수신자의 가입을 해지하고 수신자 프로필을 업데이트할 수 있습니다.

서비스를 호출하려면 다음 매개 변수가 필요합니다.

  • 인증,
  • 가입 해지할 서비스의 내부 이름,
  • 받는 사람 정보가 포함된 XML 문서("nms:recipient" 스키마에서),

"nms:subscription" 스키마의 "Unsubscribe" 메서드에 대한 설명:

<method name="Unsubscribe" static="true">
  <parameters>
    <param name="serviceName" type="string" desc="List of information service names (comma separated)"/>
    <param name="recipient" type="DOMElement"  desc="Recipient"/>
  </parameters>
</method>

조정 키의 정의는 XML 문서의 요소에 있는 _key 속성을 통해 <recipient> 입력해야 합니다. 이 속성의 내용은 쉼표로 구분된 XPath 목록입니다.

받는 사람이 데이터베이스에 없거나 해당 정보 서비스에 가입되어 있지 않으면 서비스는 작업을 수행하지 않고 오류를 생성하지 않습니다.

노트

서비스 이름이 매개 변수로 지정되지 않은 경우 수신자는 자동으로(@blackList="1")에 차단 목록 배치됩니다.

이 호출은 오류를 제외한 모든 데이터를 반환하지 않습니다.

SOAP 메시지 예

쿼리:

<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:Unsubscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    <sessiontoken xsi:type='xsd:string'/>
    <service xsi:type='xsd:string'>SVC1</service>
    <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
      <recipient _key="@email" email= "john.doe@adobe.com/>
    </content>
  </m:Unsubscribe>
</SOAP-ENV:Body>

응답:

<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:UnsubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    </m:UnsubscribeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SubmitDelivery(nms:delivery)

이 서비스를 사용하여 배달 작업을 만들고 제출할 수 있습니다.

서비스를 호출하려면 다음 매개 변수가 필요합니다.

  • 인증,
  • 배달 템플릿의 내부 이름,
  • 추가 배달 데이터를 포함하는 선택적 XML 문서.

성능 문제가 발생할 수 있으므로 이 API를 볼륨으로 호출해서는 안 됩니다.

스키마의 메서드에 대한 설명:

<method name="SubmitDelivery" static="true">
  <parameters>
    <param name="scenarioName" type="string" inout="in" desc="Internal name of the delivery template"/>
    <param name="content" type="DOMElement"  inout="in" desc="XML content of the delivery template" />
  </parameters>
</method>

배달 템플릿은 Adobe Campaign 클라이언트 콘솔에서 만들어야 합니다. 여기에는 모든 게재에 공통으로 사용되는 매개 변수(메시지의 보낸 사람 주소 또는 유효 기간)가 포함됩니다.

입력 XML 문서는 "nms:delivery" 스키마의 구조를 준수하는 배달 템플릿 조각입니다. 게재 템플릿에는 정적으로 정의할 수 없는 모든 추가 데이터(예: 타깃팅할 수신자 목록)가 포함됩니다.

이 호출은 오류를 제외한 모든 데이터를 반환하지 않습니다.

XML 문서 예

이 예는 외부 데이터 소스(이 경우 파일)의 사용자 지정 배달 템플릿을 기반으로 합니다. 구성은 전달 템플릿에 완전히 설명되므로 호출이 발생할 때 전송되어야 하는 모든 것은 요소의 파일 <externalsource> 컨텐츠입니다.

<delivery>
  <targets fromExternalSource="true">
    <externalSource>
      MsgId|ClientId|Title|Name|FirstName| Mobile|Email| Market_segment|Product_affinity1 |Product_affinity2|Product_affinity3| Product_affinity4| Support_Number|Amount|Threshold1|000001234|M.| Doe|John|0650201020| john.doe@adobe.com
|1| A1|A2|A3|A4|E12|120000|100000
    </externalSource>
  </target>
</delivery>

배달 템플릿이 없는 경우 다음 샘플을 사용할 수 있습니다.

<delivery>
<targets fromExternalSource="true" targetMode="1" noReconciliation="true" addressField="Email" >  
    <fileFormat active="true">  
      <source format="text" type="text">  
        <dataSourceConfig >  
          <dataSourceColumn label="Email" name="Email" type="string"/>  
        </dataSourceConfig>  
      </source>  
      <destination type="xtkDataStore"/>  
    </fileFormat>  
    <externalSource><![CDATA[not-a-repicipient@domain.com]]></externalSource>  
  </targets> 
</delivery> 

이 페이지에서는