事件說明 event-description

異動訊息資料模型 about-transactional-messaging-datamodel

交易式訊息依賴Adobe Campaign資料模型,並使用兩個額外的個別表格。 這個資料表NmsRtEvent ​和​ NmsBatchEvent ​包含相同的欄位,讓您一方面管理即時事件,另一方面管理批次事件。

SOAP方法 soap-methods

本節詳細說明與異動訊息模組結構描述相關的SOAP方法。

兩個​ PushEvent ​或​ PushEvents SOAP方法連結至兩個​ nms:rtEvent ​和​ nms:BatchEvent ​資料架構。 此資訊系統可判斷事件是「批次」或「即時」型別。

  • PushEvent ​可讓您在訊息中插入單一事件,
  • PushEvents ​可讓您在訊息中插入一系列事件。

用於存取這兩種方法的WSDL路徑為:

  • http://hostname/nl/jsp/schemawsdl.jsp?schema=nms:rtEvent ​以存取即時型別結構描述。
  • http://hostname/nl/jsp/schemawsdl.jsp?schema=nms:batchEvent ​以存取批次型別結構描述。

如需產生WSDL檔案的詳細資訊,請參閱本節

兩種方法都包含用於登入交易式訊息模組的​ <urn:sessiontoken> ​元素。 我們建議您透過受信任的IP位址使用身分識別方法。 若要擷取工作階段權杖,請執行登入SOAP呼叫,然後執行get權杖和登出。 對多個RT呼叫使用相同的權杖。 本節包含的範例是使用工作階段權杖方法(建議使用)。

如果您使用負載平衡的伺服器,則可以使用使用者/密碼驗證(在RT訊息的層級)。 例如:

<PushEvent xmlns="urn:nms:rtEvent">
<sessiontoken>mc/PASSWORD</sessiontoken>
<domEvent>
<rtEvent wishedChannel="41" type="rt_MobileJourney_iOS_Push" registrationToken="c3ddc8aaecc24822df25d0f49865cca61ea3f86c61bfa53ae4d37294e37f4a1c" hashlpId="27EE7571EC14DBA23B9B5CC0EF79BB782DAECF4C03C88E5D92CC9B9DAC4E5DDA" correlationId="415b7593-4f6f-e911-811f-00505691247c" xmlns="">
<mobileApp uuid="236B24DC-C073-412F-8BCB-AC7207096258" _operation="none"/>
<ctx>...</ctx>
</rtEvent>
</domEvent>
</PushEvent>

PushEvent ​方法由包含事件的​ <urn:domevent> ​參陣列成。

PushEvents ​方法由包含事件的​ <urn:domeventcollection> ​參陣列成。

使用PushEvent的範例:

<urn:PushEvent>

 <sessiontoken>___921f9b38-72ac-49ad-b481-ab32973efc50</sessiontoken>

 <urn:domEvent>

   <rtEvent>

   ...

   </rtEvent>

 </urn:domEvent>

</urn:PushEvent>
NOTE
如果呼叫​ PushEvents ​方法,我們需要新增父XML元素以符合標準XML。 此XML元素會設定事件中所包含的各種​**<rtevent>**​元素的框架。

使用PushEvents的範例:

<urn:PushEvents>

 <sessiontoken>___921f9b38-72ac-49ad-b481-ab32973efc50</sessiontoken>

 <urn:domEventCollection>

   <Events>

     <rtEvent>... </rtEvent>

     <rtEvent>... </rtEvent>

     ...

   </Events>

 </urn:domEventCollection>

</urn:PushEvents>

<rtevent> ​和​ <batchevent> ​元素具有一組屬性,以及整合訊息資料的必要子元素: <ctx>

NOTE
<batchevent> ​元素可讓您將事件新增至「批次」佇列。 <rtevent> ​將事件新增至「即時」佇列。

<rtevent> ​和​ <batchevent> ​元素的必要屬性為@type和@email。 @type的值必須與設定執行例項時定義的逐項清單值相同。 此值可讓您定義要在傳送期間連結至事件內容的範本。

<rtevent> configuration example:

<rtEvent type="order_confirmation" email="john.doe@domain.com" origin="eCommerce" wishedChannel="0" externalId="1242" mobilePhone="+33620202020">

在此範例中,提供兩個管道:電子郵件地址和行動電話號碼。 widedChannel ​可讓您選取將事件轉換為訊息時要使用的管道。 「0」值對應至電子郵件頻道、「1」值對應至行動裝置頻道等。

如果您希望延遲事件傳遞,請新增​ scheduled ​欄位,後面接著偏好的日期。 此事件將於此日期轉換為訊息。

我們建議在@wishedChannel和@emailFormat屬性中填入數值。 連結數值和標籤的函式表格可在資料結構描述中找到。

NOTE
在​ nms:rtEvent ​和​ nms:BatchEvent ​資料結構的描述中,可以找到所有授權屬性及其值的詳細描述。

<ctx> ​元素包含訊息資料。 其XML內容是開放的,這表示可以根據要傳送的內容來設定它。

NOTE
請務必最佳化訊息中包含的XML節點數量和大小,以避免在傳遞期間造成伺服器超載。

資料範例:

   <ctx>
               <client>
                        <firstname>John</firstname>
                        <lastname>Doe</lastname>
               </client>
               <action>
                         <type>Order confirmation</type>
                          <number>CN23453</number>
               </action>
               <orderdetails>
                          <article num="1">
                                   <name>Generic USB key</name>
                                   <price>20</price>
                           </article>
               </orderdetails>
    </ctx>

SOAP呼叫傳回的資訊 information-returned-by-the-soap-call

Adobe Campaign在收到事件時,會產生唯一的傳回ID。 這是已封存之事件版本的ID。

IMPORTANT
接收SOAP呼叫時,Adobe Campaign會驗證電子郵件地址格式。 如果電子郵件地址的格式不正確,則會傳回錯誤。
  • 事件處理成功時方法傳回的識別碼範例:

    code language-none
    <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>
          <urn:PushEventResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:nms:rtEvent">
             <plId xsi:type="xsd:long">72057594037935966</plId>
          </urn:PushEventResponse>
       </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

如果傳回識別碼的值嚴格地大於零,這表示事件已成功在Adobe Campaign中封存。

但是,如果事件無法處理,則方法會傳回錯誤訊息或等於零的值。

  • 處理查詢不包含登入或指定的運運算元沒有必要許可權時失敗的事件範例:

    code language-none
    <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>
          <SOAP-ENV:Fault>
             <faultcode>SOAP-ENV:Client</faultcode>
             <faultstring xsi:type="xsd:string">Error while reading parameters of method 'PushEvent' of service 'nms:rtEvent'.</faultstring>
             <detail xsi:type="xsd:string">Invalid login or password. Connection denied.</detail>
          </SOAP-ENV:Fault>
       </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
  • 由於查詢中的錯誤而失敗的事件範例(不遵守XML分類):

    code language-none
    <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>
          <SOAP-ENV:Fault>
             <faultcode>SOAP-ENV:Client</faultcode>
             <faultstring xsi:type="xsd:string">The XML SOAP message is invalid (service 'PushEvent', method 'nms:rtEvent').</faultstring>
             <detail xsi:type="xsd:string"><![CDATA[(16:8) : Expected end of tag 'rtevent'
    Error while parsing XML string '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:nms:rtEvent">
       <soapenv:Header/>
       <soapenv:Body>
          <urn:PushEvent>
             <urn:sessiontoken>mc/</urn:sessiontoken>
             <urn:domEvent>
    <rtevent type="create_account" email="esther.hall@adobe.com" origin="eCommerce" wishedChannel="email"
          externalId="1596" language="english" country="EN" emailFormat="2"
          mobilePhone="+447700123123">
      <ctx>
       <website name="eCommerce" url="http://www.eCo']]></detail>
          </SOAP-ENV:Fault>
       </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
  • 失敗並傳回零識別碼(錯誤的方法名稱)的事件範例:

    code language-none
    <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>
          <urn:PushEventResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:nms:rtEvent">
             <plId xsi:type="xsd:long">0</plId>
          </urn:PushEventResponse>
       </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1