商業導向 API

業務API是每種物件類型專屬的。 它們對以下方面有影響:

本節詳細說明「訂閱」、「取消訂閱」和「提交交付」服務的使用。

重要

Campaign JSAPI檔案 包含有關Adobe Campaign中SOAP呼叫與使用Javascript的其他資訊,以及應用程式中所用所有方法和函式的完整參考。

訂閱(nms:subscription)

此服務可讓您訂閱資訊服務的收件者,並更新收件者設定檔。

呼叫服務需要下列參數:

  • 驗證,
  • 訂閱服務的內部名稱,
  • 包含收件者資訊的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>

調解金鑰的定義必須透過_輸入​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:subscription)

此服務可讓您從資訊服務中取消訂閱收件者,並更新收件者設定檔。

呼叫服務需要下列參數:

  • 驗證,
  • 要取消訂閱的服務的內部名稱,
  • 包含收件者資訊的XML文檔(來自"nms:recipient"方案),

「nms:subscription」方案中「取消訂閱」方法的說明:

<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>

調解金鑰的定義必須透過 <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> 

本頁內容