Web サービスについて

Adobe CampaignAPIの定義

Adobe Campaign・アプリケーション・サーバは、ますます多様化し、複雑な会社情報システムとのオープン性と容易な統合を実現するように設計されています。

Adobe CampaignAPIは、アプリケーション内のJavaScriptと、その外部のSOAPで使用されます。 これらは、強化できる汎用関数のライブラリを構成しています。 詳しくは、SOAPメソッドの実装を参照してください。

重要

1日あたりの認定エンジン呼び出し数は、ライセンス契約によって異なります。 詳しくは、このページを参照してください。
すべてのAPIのリスト(詳細な説明を含む)は、この専用ドキュメントで入手できます。

前提条件

Adobe CampaignAPIを使用する前に、次のトピックに関する知識が必要です。

  • JavaScript
  • SOAPプロトコル
  • Adobe Campaignデータモデル

Adobe CampaignAPIを使用する

Adobe Campaignでは、次の2種類のAPIを使用します。

  • 汎用データは、データモデルデータをクエリするためのAPIにアクセスします。 データ指向APIを参照してください。
  • 各オブジェクトに対して操作を行えるビジネス固有のAPI:配信、ワークフロー、購読など ビジネス指向APIを参照。

APIを開発し、Adobe Campaignとやり取りするには、データモデルに精通している必要があります。 Adobe Campaignを使用すると、基本の完全な説明を生成できます。 モデルの説明を参照してください。

SOAP 呼び出し

SOAPプロトコルを使用すると、リッチクライアント、Webサービスを使用するサードパーティアプリケーション、またはこれらのメソッドをネイティブで使用するJSP経由でAPIメソッドを呼び出すことができます。

SOAPメッセージの構造は次のとおりです。

  • メッセージの構造を定義する封筒
  • オプションのヘッダ、
  • 呼び出しと応答に関する情報を含む本文
  • エラー条件を定義するエラー管理。

リソースと交換

次のスキーマは、Adobe CampaignAPIの使用に関する様々なリソースを示しています。

'ExecuteQuery'メソッドでのSOAPメッセージの例

この例では、SOAPクエリが「ExecuteQuery」メソッドを呼び出します。このメソッドは、クエリ(セッショントークン)のパラメーターとして文字列を、実行する認証の説明としてXMLコンテンツを取ります。

詳しくは、ExecuteQuery (xtk:queryDef)を参照してください。

メモ

このサービスのWSDL説明は、次の例のように入力されています。Webサービスの説明:WSDL.

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 firstRows="true" lineCount="200" operation="select" schema="nms:rcpGrpRel" startLine="0" startPath="/" xtkschema="xtk:queryDef">
          ...
          </queryDef>
        </entity>
      </ExecuteQuery>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<soap-env:envelope>要素は、SOAPエンベロープを表すメッセージの最初の要素です。

<soap-env:body>要素は、エンベロープの最初の子要素です。 メッセージの説明(クエリの内容や応答など)が含まれます。

呼び出すメソッドは、SOAPメッセージの本文の<executequery>要素に入力されます。

SOAPでは、パラメーターは外観の順序で認識されます。 最初のパラメーター<__sessiontoken>は認証チェーンを受け取り、2番目のパラメーターは<querydef>要素からのクエリの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>
      <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'>
          <rcpGrpRel-collection><rcpGrpRel group-id="1872" recipient-id="1362"></rcpGrpRel></rcpGrpRel-collection>
        </pdomOutput>
      </ExecuteQueryResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

クエリの結果は<pdomoutput>要素から入力されます。

エラー管理

SOAPエラー応答の例:

<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <SOAP-ENV:Fault>
      <faultcode>SOAP-ENV:Server</faultcode>
      <faultstring>Error while executing 'Write' of the 'xtk:persist'.</faultstring> service
      <detail>ODBC error: [Microsoft][ODBC SQL Server Driver][SQL Server]Cannot insert duplicate key row in object 'XtkOption' with unique index 'XtkOption_name'. SQLSTate: 23000
ODBC error: [Microsoft][ODBC SQL Server Driver][SQL Server]The statement has been terminated. SQLSTate: 01000 Cannot save the 'Options (xtk:option)' document </detail>
    </SOAP-ENV:Fault>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SOAPメッセージの本文の<soap-env:fault>要素は、Webサービスの処理中に発生するエラー信号を伝えるために使用されます。 これは、次のサブ要素で構成されます。

  • <faultcode> :は、エラーのタイプを示します。次に、エラータイプを示します。

    • 使用されるSOAPバージョンとの非互換性のイベントに「VersionMismatch」がある。
    • メッセージヘッダー内の問題のイベントに「MustUnderstand」が含まれている場合、
    • クライアントのイベントに「クライアント」が表示され、
    • 「Server」(サーバーで処理の実行に問題があるイベント)。
  • <faultstring> :エラーを説明するメッセージ

  • <detail> :長いエラーメッセージ

サービス呼び出しの成功または失敗は、<faultcode>要素が検証されると識別されます。

重要

すべてのAdobe CampaignWebサービスはエラーを処理します。 したがって、返されたエラーを処理するために各呼び出しをテストすることを強くお勧めします。

C#でのエラー処理の例:

try 
{
  // Invocation of method
  ...
}
catch (SoapException e)
{
  System.Console.WriteLine("Soap exception: " + e.Message);        
  if (e.Detail != null)
    System.Console.WriteLine(e.Detail.InnerText);
}

Webサービスサーバー(またはEndPoint)のURL

Webサービスを送信するには、対応するサービスメソッドを実装するAdobe Campaignサーバーに接続する必要があります。

サーバーURLは次のとおりです。

https://serverName/nl/jsp/soaprouter.jsp

<server>​でAdobe Campaignアプリケーションサーバー(nlserver web)

このページ