ビジネス指向の API

ビジネスAPIは、各タイプのオブジェクトに固有です。 以下に影響します。

この節では、「購読」、「購読解除」および「SubmitDelivery」サービスの使用について説明します。

重要

Campaign JSAPIドキュメ ントには、Adobe CampaignでのSOAP呼び出しとJavaScriptの使用に関する追加情報と、アプリケーションで使用されるすべてのメソッドと関数への完全なリファレンスが含まれています。

購読(nms:subscription)

このサービスを使用すると、受信者を情報サービスに登録し、受信者プロファイルを更新できます。

サービスを呼び出すには、次のパラメーターが必要です。

  • 認証
  • 購読サービスの内部名
  • (「nms:recipient」スキーマの)受信者情報を含むXMLドキュメント
  • 受信者の作成用のブール値(まだ存在しない場合)。

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

紐付けキーの定義は、XMLドキュメントの<recipient>要素の_​key​属性を使用して入力する必要があります。 この属性の内容は、コンマ区切りのXPathリストです。

この呼び出しは、エラーを除き、データを返しません。

Eメールアドレスの受信者紐付けキーを含む購読:入力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)

このサービスを使用すると、情報サービスから受信者を購読解除し、受信者プロファイルを更新できます。

サービスを呼び出すには、次のパラメーターが必要です。

  • 認証
  • 購読解除するサービスの内部名
  • (「nms:recipient」スキーマの)受信者情報を含むXMLドキュメント

「nms:subscription」スキーマの「Unsubscribe」メソッドの説明:

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

このページ