面向业务的 API

业务API特定于每种类型的对象。 它们对以下方面有影响:

  • 投放:

    • 创建投放操作,请参阅SubmitDelivery(nms:投放),
    • 发送活动(开始、暂停、停止、发送验证),
    • 恢复投放日志。
  • 工作流:

    • 启动工作流,

    • 验证进程等。

      请参阅JavaScript](…/…/configuration/using/soap-methods-in-javascript.md)中的[SOAP方法。

  • 内容管理

  • 订阅管理,请参阅订阅(nms:订阅)取消订阅(nms:订阅)

  • 数据流程:进口,出口。

本节详细介绍了“订阅”、“取消订阅”和“SubmitDelivery”服务的使用情况。

重要

活动 JSAPI文 档包含有关Adobe Campaign中SOAP调用和使用Javascript的其他信息,以及对应用程序中使用的所有方法和函数的完整引用。

订阅(nms:订阅)

此服务允许您订阅收件人信息服务并更新收件人用户档案。

调用服务需要以下参数:

  • 身份验证,
  • 订阅服务的内部名称,
  • 包含收件人信息的XML文档(来自“nms:收件人”模式),
  • 一个布尔值,用于创建收件人(如果尚未创建)。

“nms:订阅”模式中的“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合并关键项的<recipient>元素上的_​key​属性输入文档的定义。 此属性的内容是逗号分隔的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:收件人”模式),

“nms:订阅”模式中“取消订阅”方法的说明:

<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合并关键项的<recipient>元素上的_key属性输入文档的定义。 此属性的内容是逗号分隔的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:投放)

此服务允许您创建和提交投放操作。

调用服务需要以下参数:

  • 身份验证,
  • 投放模板的内部名称,
  • 包含其他文档数据的可选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:投放”模式结构的投放模板片段。 它将包含投放模板中无法静态定义的所有其他数据(例如,收件人到目标的列表)。

此调用不返回任何数据,错误除外。

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> 

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now