面向数据的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)的低级交换。
对于列和条件,您可以使用查询。
这允许您隔离基础SQL。 查询语言不依赖于基础引擎:某些函数将被重新映射,这可能会生成多个SELECT SQL订单。
有关更多信息,请参阅 模式“xtk:queryDef”的“ExecuteQuery”方法示例.
的 ExecuteQuery 方法介绍于 ExecuteQuery(xtk:queryDef).
使用“写入”(write)命令可以编写简单或复杂的文档,其中包含一个或多个基表中的条目。
事务型API允许您通过 updateOrInsert 命令:使用一个命令可以创建或更新数据。 您还可以配置修改合并(合并):此操作模式允许您授权部分更新。
XML结构提供了数据的逻辑视图,并允许您绕过SQL表的物理结构。
Write方法在 Write/WriteCollection(xtk:session).
此方法允许您根据与架构关联的数据执行查询。 它采用身份验证字符串(必须登录)和XML文档,以描述要作为参数提交的查询。 返回参数是一个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文档的结构在“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>
查询必须引用 模式 属性。
所需的操作类型在 操作 属性和包含以下值之一:
的 XPath 语法用于根据输入模式查找数据。 有关XPath的详细信息,请参阅 数据模式.
在电子邮件上检索带过滤器的收件人(“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>
表达式可以是简单的字段或复杂的表达式,如算术运算或字符串的串联。
要限制要返回的记录数,请将 lineCount 属性 <querydef>
元素。
要将查询返回的记录数限制为100,请执行以下操作:
<queryDef schema="nms:recipient" operation="select" lineCount="100">
...
要检索下一个100条记录,请再次运行同一查询,并添加 startLine 属性。
<queryDef schema="nms:recipient" operation="select" lineCount="100" startLine="100">
...
要计算查询中的记录数,请执行以下操作:
<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>
当多个条件应用于同一字段时,可以将“OR”运算符替换为“IN”运算:
<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>
子句。 引用字段的XPaths是集合元素中的上下文字段。
过滤( <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>
参数的绑定允许引擎设置查询中使用的参数的值。 这非常有用,因为引擎负责值的转义,并且对于要检索的参数,缓存还有额外的好处。
构建查询时,“绑定”值将替换为字符(? 在ODBC中, #[index]#
…)。
<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>
要避免绑定参数,必须使用值“true”填充“noSqlBind”属性。
如果查询包含“订单依据”或“组依据”说明,则数据库引擎将无法“绑定”值。 必须将@noSqlBind="true"属性放在查询的"select"和/或"where"说明中。
要帮助处理查询的语法,您可以在Adobe Campaign客户端控制台中使用通用查询编辑器来编写查询( Tools/ Generic query editor… 菜单)。 操作步骤:
选择要检索的数据:
定义过滤条件:
执行查询并按Ctrl+F4查看查询源代码。
返回参数是与查询关联的架构格式的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>
查询:
<?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>
这些服务用于插入、更新或删除实体(“写入”方法)或实体集合(“写入收集”方法)。
要更新的实体与数据模式相关联。 输入参数是验证字符串(必须登录)和包含要更新数据的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列表(以逗号分隔)。
可以通过填充 _operation 属性的值:
使用电子邮件地址、出生日期和城镇更新或插入收件人(隐含的“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]"/>
对于删除操作,输入文档必须只包含构成协调键值的字段。
更新或插入多个收件人:
<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>
根据文件夹的内部名称(@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”)和电子邮件。
在文件夹元素中输入的操作“无”定义对文件夹的协调,而无需更新或插入。
从收件人更新公司(“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>
使用组关系表(“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集合元素。 来自数据库的数据将替换为来自输入文档的数据。 如果文档仅包含要更新的元素,则必须对所有要更新的集合元素填充“_operation”属性,以便强制与数据库的XML数据合并。
查询:
<?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 "nmsrecipient_id"Impossible to save document of type 'Recipients (nms:recipient)'</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>