SOAP API の設計の概要

Campaign Services SOAP API は、実行中の IBM® Campaign アプリケーション・インスタンスのクライアント・ビューを提供するファサードです。IBM Campaign の機能のサブセットだけが公開されていますが、 Campaign 機能の主な側面を活用するためには十分です。

機能と図

この API は、IBM Campaign Web ユーザーおよび他の API スレッドと共に使用されます。

通常、この API は、キャンペーン、オファー、およびターゲット・セルのコンポーネントで、以下のタイプの操作をサポートします。

コンポーネントの作成
コンポーネントのディスカバリー
コンポーネントの削除
コンポーネント属性および属性メタデータの作成、検査、および変更
フローチャート実行結果の取り出し

次の図は、CampaignServices 3.0 の配置のサンプルを示しています。

ユーザー認証

認証は、ユーザーの身元を確立するための処理です。ユーザー認証はクライアント・アプリケーションが担当します。

実行許可

許可は、API によって公開されているコンポーネントおよび操作と比較して、認証されたユーザーが持つ権限に関する処理です。

ユーザーの認証が正常に行われても、キャンペーンのサマリー情報の編集など、いくつかの操作を行うためには十分な権限がない場合もあります。この場合、API メソッドは AuthorizationException をスローします。

ロケール

API 要求には、特定の要求の実行に使用するためのロケールを定義する、オプションの requestedLocale パラメーターがあります。このパラメーターを定義しない場合は、API はデフォルトの IBM ユーザーの優先ロケールを使用します。要求されたロケールでメッセージや他のローカライズされたテキストを返すときには、通常の Java™ ベスト・エフォート・マッチング・アルゴリズムが使用されます。

このパラメーターのタイプは java.util.Locale クラスです。

注: キャンペーンについての説明など、いくつかのユーザー指定テキストには、そのテキストを指定したユーザーのロケールが適用されます。IBM Campaign は、そのようなデータをローカライズしようとはしません。通知、警告、およびエラー・メッセージのみが API によってローカライズされます。

状態管理

CampaignServices API はステートレスです。つまり、複数の呼び出しの間でクライアントごとの情報が API によって保存されることはありません。

特定の API 呼び出しによって Campaign が管理する基礎となるコンポーネント・インスタンスの状態が変更され、その状態変更がデータベースに維持されている可能性は確かにあります。