Web サービスについて

Adobe Campaign API の定義

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

Adobe Campaign API は、アプリケーション内の JavaScript と、その外部の SOAP で使用されます。 エンリッチメントは、エンリッチメント可能な汎用関数のライブラリを構成します。 詳しくは、 SOAP メソッドの実装.

重要

1 日あたりの認証済みエンジン呼び出し数は、ライセンス契約によって異なります。 詳しくは、このページを参照してください。
すべての API のリストとその詳細な説明は、 [この専用ドキュメント] (https://experienceleague.adobe.com/developer/campaign-api/api/index.html?lang=ja.

前提条件

Adobe Campaign API を使用する前に、次のトピックに関する十分な知識が必要です。

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

Adobe Campaign API の使用

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

  • データモデルデータをクエリするための汎用データアクセス API。 データ指向 API を参照してください。
  • 目的の対象ごとにアクションをおこなえる、ビジネスに特化した API。配信、ワークフロー、サブスクリプションなど。参照: ビジネス指向 API.

API を開発し、Adobe Campaignとやり取りするには、データモデルに関する知識が必要です。 Adobe Campaignを使用すると、ベースの完全な説明を生成できます。 参照: モデルの説明.

SOAP 呼び出し

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

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

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

リソースと交換

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

「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> element は、SOAP エンベロープを表すメッセージの最初の要素です。

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

呼び出すメソッドが <executequery> 要素を SOAP メッセージの本文から取得します。

SOAP では、パラメーターは出現順に認識されます。 最初のパラメータ <__sessiontoken>は認証チェーンを受け取り、2 番目のパラメーターは <querydef> 要素。

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

  • <faultcode> :エラーのタイプを示します。 エラータイプは次のとおりです。

    • 使用する SOAP バージョンとの非互換性の場合、「VersionMismatch」
    • メッセージヘッダーに問題が発生した場合は、「MustUnderstand」
    • クライアントに情報が欠落している場合の「クライアント」
    • サーバーで処理の実行に問題が発生した場合の「サーバー」。
  • <faultstring> :エラーを説明するメッセージ

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

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

重要

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

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) をクリックします。

このページ