v7

資料導向 API

上次更新: 2023-08-31
  • 主題:
  • API
    檢視有關此主題的更多資訊
  • 建立對象:
  • Developer

資料導向API可讓您處理整個資料模型。

資料模型概觀

Adobe Campaign未針對每個實體提供專用的讀取API (無getRecipient或getDelivery函式等)。 使用QUERY & WRITER資料讀取和修改方法來存取模型的資料。

Adobe Campaign可讓您管理集合:查詢可讓您復原在資料庫中收集的一組資訊。 與SQL模式的存取不同,Adobe Campaign API會傳回XML樹狀結構而非資料欄。 因此,Adobe Campaign會建立包含所有收集資料的複合檔案。

此作業模式不提供XML檔案的屬性和元素與資料庫中表格欄之間的一對一對應。

XML檔案儲存在資料庫的MEMO型別欄位中。

模型說明

您必須熟悉Adobe Campaign資料模型,才能在指令碼中處理資料庫的欄位。

如需資料模型的簡報,請參閱 Adobe Campaign資料模型說明.

查詢與寫入器

下列簡介結構描述詳細說明資料庫和客戶(網頁或Adobe Campaign使用者端主控台)之間讀取(ExecuteQuery)和寫入(Writer)的低階交換。

Executequery

對於欄和條件,您可以使用查詢。

這可讓您隔離基礎SQL。 查詢語言不取決於基礎引擎:某些函式將會重新對應,可能會產生數個SELECT SQL順序。

有關詳細資訊,請參閱 結構描述「xtk:queryDef」的「ExecuteQuery」方法範例.

Executequery 方法顯示於 ExecuteQuery (xtk:queryDef).

寫入

「寫入」指令可讓您撰寫簡單或複雜的檔案,其專案位於基底的一或多個表格中。

異動API可讓您透過 updateOrInsert command:一個指令可讓您建立或更新資料。 您也可以配置修改合併(合併):此作業模式可讓您授權部分更新。

XML結構提供資料的邏輯檢視,可讓您略過SQL表格的實體結構。

Write方法顯示於 寫入/寫入集合(xtk:session).

ExecuteQuery (xtk:queryDef)

此方法可讓您從與結構描述相關聯的資料執行查詢。 它需要驗證字串(必須登入)和說明要作為引數提交的查詢的XML檔案。 return引數是XML檔案,包含查詢的結果,其格式為查詢所參照的結構描述格式。

「xtk:queryDef」結構描述中「ExecuteQuery」方法的定義:

<method name="ExecuteQuery" const="true">
  <parameters>
    <param desc="Output XML document" name="output" type="DOMDocument" inout="out"/>
  </parameters>
</method>
注意

這是「const」方法。 輸入引數會以「xtk:queryDef」結構描述的格式包含在XML檔案中。

輸入查詢的XML檔案格式

查詢的XML檔案結構在「xtk:queryDef」架構中進行了說明。 本檔案說明SQL查詢的子句:「select」、「where」、「order by」、「group by」、「having」。

<queryDef schema="schema_key" operation="operation_type">
  <select>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </select>
  <where>
    <condition expr="expression1"/>
    <condition expr="expression2"/>
    ...
  </where>
  <orderBy>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </orderBy>
  <groupBy>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </groupBy>
  <having>
    <condition expr="expression1"/>
    <condition expr="expression2"/>
    ...
  </having>
</queryDef>

子查詢( <subquery> )可在「 」中定義 <condition> 元素。 的語法 <subquery> 元素是根據 <querydef>.

範例 <subquery> : </subquery>

<condition setOperator="NOT IN" expr="@id" enabledIf="$(/ignored/@ownerType)=1">
  <subQuery schema="xtk:operatorGroup">
     <select>
       <node expr="[@operator-id]" />
     </select>
     <where>
       <condition expr="[@group-id]=$long(../@owner-id)"/>
     </where>
   </subQuery>
</condition>

查詢必須參考以下位置的開始結構描述: 綱要 屬性。

所需的作業型別輸入於 操作 屬性並包含下列其中一個值:

  • get:從表格擷取記錄,如果資料不存在,則傳回錯誤,
  • getIfExists:從表格擷取記錄,如果資料不存在,則傳回空白檔案,
  • 選取:建立游標以傳回數筆記錄,如果沒有資料,則會傳回空白檔案,
  • count:傳回資料計數。

XPath 語法是根據輸入結構來尋找資料。 如需XPath的詳細資訊,請參閱 資料結構描述.

具有'get'操作的範例

使用電子郵件上的篩選條件擷取收件者(「nms:recipient」綱要)的姓氏和名字。

<queryDef schema="nms:recipient" operation="get">
  <!-- fields to retrieve -->
  <select>
    <node expr="@firstName"/>
    <node expr="@lastName"/>
  </select>

  <!-- condition on email -->
  <where>
    <condition expr="@email= 'john.doe@aol.com'"/>
  </where>
</queryDef>

「選取」操作的範例

傳回在資料夾上篩選的收件者清單,以及依據出生日期以降序排序的電子郵件網域。

<queryDef schema="nms:recipient" operation="select">
  <select>
    <node expr="@email"/>
    <!-- builds a string with the concatenation of the last name and first name separated by a dash -->
    <node expr="@lastName+'-'+@firstName"/>
    <!-- get year of birth date -->
    <node expr="Year(@birthDate)"/>
  </select>

  <where>
     <condition expr="[@folder-id] = 1234 and @domain like 'Adobe%'"/>
  </where>

  <!-- order by birth date -->
  <orderBy>
    <node expr="@birthDate" sortDesc="true"/> <!-- by default sortDesc="false" -->
  </orderBy>
</queryDef>

運算式可以是簡單欄位或複雜運算式,例如算術運算或字串串連結。

若要限制要傳回的記錄數,請新增 行數 屬性至 <querydef> 元素。

若要將查詢傳回的記錄數限製為100:

<queryDef schema="nms:recipient" operation="select" lineCount="100">
...

若要擷取接下來的100筆記錄,請再次執行相同的查詢,新增 startLine 屬性。

<queryDef schema="nms:recipient" operation="select" lineCount="100" startLine="100">
...

「count」操作的範例

若要計算查詢的記錄數,請執行下列步驟:

<queryDef schema="nms:recipient" operation="count"">
  <!-- condition on the folder and domain of the email -->
  <where>
    <condition expr="[@folder-id] = 1234" and @domain like 'Adobe%'"/>
  </where>
</queryDef>
注意

我們再次使用上一個範例的條件。 此 <select> 不會使用及子句。 </select>

資料分組

若要擷取多次參照的電子郵件地址:

<queryDef schema="nms:recipient" operation="select">
  <select>
    <node expr="@email"/>
    <node expr="count(@email)"/>
  </select>

  <!-- email grouping clause -->
  <groupby>
    <node expr="@email"/>
  </groupby>

  <!-- grouping condition -->
  <having>
    <condition expr="count(@email) > 1"/>
  </having>

</queryDef>

可透過新增以下專案來簡化查詢 groupBy 要分組的欄位直接使用的屬性:

<select>
  <node expr="@email" groupBy="true"/>
</select>
注意

不再需要填入 <groupby> 元素。

在條件中括住

以下是兩個相同條件括弧的範例。

  • 單一運算式中的簡單版本:

    <where>
      <condition expr="(@age > 15 or @age <= 45) and  (@city = 'Newton' or @city = 'Culver City') "/>
    </where>
    
  • 具的結構化版本 <condition> 元素:

    <where>
      <condition bool-operator="AND">
        <condition expr="@age > 15" bool-operator="OR"/>
        <condition expr="@age <= 45"/>
      </condition>
      <condition>
        <condition expr="@city = 'Newton'" bool-operator="OR"/>
        <condition expr="@city = 'Culver City'"/>
      </condition>
    </where>
    

當多個條件套用至相同欄位時,可以用「IN」運運算元取代「OR」運運算元:

<where>
  <condition>
    <condition expr="@age IN (15, 45)"/>
    <condition expr="@city IN ('Newton', 'Culver City')"/>
  </condition>
</where>

當條件中使用兩個以上的資料時,此語法會簡化查詢。

  • 連結1-1或N1:當表格具有外部索引鍵(連結從表格開始)時,可以直接篩選或擷取連結表格的欄位。

    資料夾標籤上的篩選範例:

    <where>
      <condition expr="[folder/@label] like 'Segment%'"/>
    </where>
    

    若要從「nms:recipient」綱要擷取資料夾的欄位:

    <select>
      <!-- label of recipient folder -->
      <node expr="[folder/@label]"/>
      <!-- displays the string count of the folder -->
      <node expr="partition"/>
    </select>
    
  • 集合連結(1N):對集合表格的欄位進行篩選必須透過 存在不存在 運運算元。

    若要篩選已訂閱「電子報」資訊服務的收件者:

    <where>
      <condition expr="subscription" setOperator="EXISTS">
        <condition expr="@name = 'Newsletter'"/>
      </condition>
    </where>
    

    從直接擷取集合連結的欄位 <select> 不建議使用子句,因為查詢會傳回基數產品。 僅當連結的表格僅包含一個記錄時才使用(範例 <node expr="">)。

    「訂閱」集合連結範例:

    <select>
      <node expr="subscription/@label"/>
    </select>
    

    您可以擷取子清單,其中包含集合連結中的元素 <select> 子句。 參考欄位的XPath與收集元素相關。

    篩選( <orderby> )和限制( <where> )元素,以新增至收集元素。

    在此範例中,對於每個收件者,查詢會傳回收件者訂閱的電子郵件和資訊服務清單:

    <queryDef schema="nms:recipient" operation="select">
      <select>
        <node expr="@email"/>
    
        <!-- collection table (unbound type) -->
        <node expr="subscription">
          <node expr="[service/@label]"/>
          <!-- sub-condition on the collection table -->
          <where>
            <condition expr="@expirationDate >= GetDate()"/>
          </where>
          <orderBy>
            <node expr="@expirationDate"/>
          </orderBy>
        </node>
      </select>
    </queryDef>
    

繫結'where'和'select'子句的引數

引數的繫結可讓引擎設定查詢中使用的引數值。 這非常有用,因為引擎負責逸出值,而且快取還有一個好處,就是可以擷取引數。

當建構查詢時,「界限」值會以字元(? 在ODBC中, #[index]# SQL查詢內文中的)。

<select>
  <!--the value will be bound by the engine -->
  <node expr="@startDate = #2002/02/01#"/>
  <!-- the value will not be bound by the engine but visible directly in the query -->
  <node expr="@startDate = #2002/02/01#" noSqlBind="true"/>
</select>

若要避免繫結引數,「noSqlBind」屬性必須填入「true」值。

重要

如果查詢包含「order-by」或「group-by」指示,資料庫引擎將無法「繫結」值。 您必須將@noSqlBind="true"屬性放置在查詢的"select"及/或"where"指示上。

查詢建立秘訣:

若要協助處理查詢的語法,您可以在Adobe Campaign使用者端主控台中使用一般查詢編輯器來撰寫查詢( Tools/ Generic query editor… 功能表)。 操作步驟:

  1. 選取要擷取的資料:

  2. 定義篩選條件:

  3. 執行查詢並按CTRL+F4以檢視查詢原始程式碼。

輸出檔案格式

return引數是XML檔案,採用與查詢相關聯的結構描述格式。

從「nms:recipient」綱要對「get」作業傳回的範例:

<recipient email="john.doe@adobe.com" lastName"Doe" firstName="John"/>

在「選取」操作中,傳回的檔案是元素的列舉:

<!-- the name of the first element does not matter -->
<recipient-collection>
  <recipient email="john.doe@adobe.com" lastName"Doe" firstName="John"/>
  <recipient email="peter.martinez@adobe.com" lastName"Martinez" firstName="Peter"/>
  <recipient...
</recipient-collection>

針對「count」型別作業傳回的檔案範例:

<recipient count="3"/>

別名

別名可讓您修改輸出檔案中資料的位置。 此 別名 屬性必須在對應欄位上指定XPath。

<queryDef schema="nms:recipient" operation="get">
  <select>
    <node expr="@firstName" alias="@firstName"/>
    <node expr="@lastName"/>
    <node expr="[folder/@label]" alias="@My_folder"/>
  </select>
</queryDef>

傳回值:

<recipient My_folder="Recipients" First name ="John" lastName="Doe"/>

而非:

<recipient firstName="John" lastName="Doe">
  <folder label="Recipients"/>
</recipient>

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:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <ExecuteQuery xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
          <__sessiontoken xsi:type='xsd:string'/>
          <entity xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
            <queryDef operation="get" schema="nms:recipient" xtkschema="xtk:queryDef">
              <select>
                <node expr="@email"/>
                <node expr="@lastName"/>
                <node expr="@firstName"/>
              </select>
              <where>
                <condition expr="@id = 3599"/>
              </where>
            </queryDef>
          </entity>
        </ExecuteQuery>
      </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>
        <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
          <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
            <recipient email="john.doe@adobe.com" lastName"Doe" firstName="John"/>
          </pdomOutput>
        </ExecuteQueryResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

寫入/寫入集合(xtk:session)

這些服務用於插入、更新或刪除實體(「寫入」方法)或實體集合(「WriteCollection」方法)。

要更新的實體會與資料結構描述相關聯。 輸入引數是驗證字串(必須登入)以及包含要更新資料的XML檔案。

本檔案以設定寫入程式的指示作為補充。

呼叫不會傳回任何資料,錯誤除外。

「xtk:session」結構描述中「Write」和「WriteCollection」方法的定義:

<method name="Write" static="true">
  <parameters>
    <param name="doc" type="DOMDocument" desc="Difference document"/>
  </parameters>
</method>
<method name="WriteCollection" static="true">
  <parameters>
    <param name="doc" type="DOMDocument" desc="Difference collection document"/>
  </parameters>
</method>
注意

這是「靜態」方法。 輸入引數會以要更新的結構描述格式包含在XML檔案中。

概覽

資料協調會根據在關聯結構描述中輸入的索引鍵定義來運作。 寫入程式會根據輸入檔案中輸入的資料,尋找第一個符合條件的索引鍵。 會根據實體在資料庫中的存在性來插入或更新實體。

要更新之實體結構描述的索引鍵是根據 xtkschema 屬性。

因此,調解金鑰可以透過以下方式強制: _key 包含組成索引鍵的XPath清單的屬性(以逗號分隔)。

您可以填入 操作(_O) 屬性值之間的關聯:

  • 插入:強制插入記錄(不使用調解金鑰),
  • insertOrUpdate:根據調解金鑰(預設模式)更新或插入記錄,
  • 更新:更新記錄;如果資料不存在,則不執行任何操作,
  • 刪除:刪除記錄,
  • :僅用於連結協調,不更新或插入。

'Write'方法的範例

以電子郵件地址、出生日期和城鎮更新或插入收件者(隱含的「insertOrUpdate」作業):

<recipient xtkschema="nms:recipient" email="john.doe@adobe.com" birthDate="1956/05/04" folder-id=1203 _key="@email, [@folder-id]">
  <location city="Newton"/>
</recipient>

刪除收件者:

<recipient xtkschema="nms:recipient" _operation="delete" email="rene.dupont@adobe.com" folder-id=1203 _key="@email, [@folder-id]"/>
注意

對於刪除操作,輸入檔案必須僅包含組成調解金鑰的欄位。

'WriteCollection'方法的範例

多個收件者的更新或插入:

<recipient-collection xtkschema="nms:recipient">
  <recipient email="john.doe@adobe.com" firstName="John" lastName="Doe" _key="@email"/>
  <recipient email="peter.martinez@adobe.com" firstName="Peter" lastName="Martinez" _key="@email"/>
  <recipient ...
</recipient-collection>

範例1

根據收件者的內部名稱(@name),將資料夾與收件者建立關聯。

<recipient _key="[folder/@name], @email" email="john.doe@adobe.net" lastName="Doe" firstName="John" xtkschema="nms:recipient">
  <folder name="Folder2" _operation="none"/>
</recipient>

可以在連結的元素上輸入「_key」和「_operation」屬性。 此元素的行為與輸入結構描述的主要元素相同。

主要實體(「nms:recipient」)的索引鍵定義由連結表格(元素)中的欄位組成 <folder> 結構描述「xtk:folder」)和電子郵件。

注意

在資料夾元素上輸入的「none」作業會在資料夾上定義調解,而不需要更新或插入。

範例2

從收件者更新公司(在「cus:company」綱要中連結的表格):

<recipient _key="[folder/@name], @email" email="john.doe@adobe.net" lastName="Doe" firstName="John" xtkschema="nms:recipient">
  <company name="adobe" code="ERT12T" _key="@name" _operation="update"/>
</recipient>

範例3

使用群組關係表(「nms:rcpGrpRel」)將收件者新增至群組:

<recipient _key="@email" email="martin.ledger@adobe.net" xtkschema="nms:recipient">
  <rcpGrpRel _key="[rcpGroup/@name]">
    <rcpGroup name="GRP1"/>
  </rcpGrpRel>
</recipient>
注意

索引鍵的定義未輸入於 <rcpgroup> 元素,因為根據群組名稱的隱含索引鍵定義於「nms:group」結構描述中。

XML集合元素

依預設,必須植入所有收集要素,才能更新XML收集要素。 資料庫的資料將由輸入檔案中的資料取代。 如果檔案只包含要更新的元素,則必須在要更新的所有收集元素上填入「_operation」屬性,以強制與資料庫的XML資料合併。

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:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <Write xmlns='urn:xtk:persist' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
          <__sessiontoken xsi:type='xsd:string'/>
          <domDoc xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
            <recipient xtkschema="nms:recipient" email="rene.dupont@adobe.com" firstName="René" lastName="Dupont" _key="@email">
          </domDoc>
        </Write>
      </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>
        <WriteResponse xmlns='urn:' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
        </WriteResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

    傳回錯誤:

    <?xml version='1.0'?>
    <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:Server</faultcode>
          <faultstring xsi:type="xsd:string">Error while executing the method 'Write' of service 'xtk:persist'.</faultstring>
          <detail xsi:type="xsd:string">PostgreSQL error: ERROR:  duplicate key violates unique constraint &quot;nmsrecipient_id&quot;Impossible to save document of type 'Recipients (nms:recipient)'</detail>
        </SOAP-ENV:Fault>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

本頁內容