SOAP API メソッド: ターゲット・セル
ターゲット・セルは、IBM® Campaign によって管理されるキャンペーン結果のいくつかの既知のサブセットを、 ターゲット・セル・スプレッドシート (TCS) として抽象化したものです。ターゲット・セルは、キャンペーンに対してグローバルであったり、特定のキャンペーン・フローチャートに関連付けられていたりします。
IBM Campaign SOAP API は、ターゲット・セルで以下の操作をサポートします。
- 1 つ以上の新しいグローバル・ターゲット・セルの作成
- 1 つ以上の既存のターゲット・セルのバルク更新
- ディスカバリー (ターゲット・セルのリスト作成)
- 属性の作成、読み取り、および更新 (属性 API による)
- 既存のターゲット・セルの削除
- 1 つ以上のセルに関連付けられた実行結果の取り出し
ターゲット・セルには、API によって公開される、いくつかの標準属性が関連付けられています。このリストは、カスタム属性のメタデータ定義を追加することにより、クライアントが任意に拡張できます (属性 API を参照してください)。各属性メタデータは、TCS 内の 1 つの列と見なすことができます。スプレッドシートのレイアウトは、クライアントが決定する必要があります。
標準のターゲット・セル属性には、以下のものがあります。
- uacName: セル名。
- uacDescription: フローチャートについて説明する文字列 (オプション)。
- uacCellCode: セルを一意的に識別するコード文字列。通常は Campaign が自動生成しますが、クライアントが指定することもできます。
- uacCreateDate: セルがサーバーによって作成された日時を指定するカレンダー・インスタンス。
- uacUpdateDate: セルがサーバーによって最後に更新された日時を定義するカレンダー・インスタンス。
- uacIsControl: コントロール・セル (true) であるか、そうでない (false) かを示すブール値。他のセルはこのセルを制御セルとして参照することがあります (uacControlCell を参照してください)。
- uacControlCell: 制御セルの参照 (オプション。ただし、制御セルの場合には許可されません)。uaclsControl 属性を参照してください。
- uacIsApproved: セルが承認されている (true) か、そうでない (false) かを示すブール値。
- uacIsReadOnly: セルが読み取り専用 (true) か、そうでない (false) かを示すブール値。
- uacDisplayOrder: このセル (行) の順序を、ターゲット・セル・スプレッドシート内の他のセルとの相対関係で示す整数。
- uacIsTopDown: セルがトップダウンかどうかを示すブール値。
- uacAssignedOffers: このセルに割り当てられたオファーまたはオファー・リストの、1 つ以上の参照の配列 (オプション)(制御セルの場合は許可されません)。
- uacFlowchartName: このセルがリンクされているフローチャートの名前 (オプション)(IBM Campaign GUI によって読み取り専用に設定される必要があります。コントロール・セルの場合は許可されません)。
- uacFlowchartId: このセルがリンクされているフローチャートのデータベース ID (オプション)(上記と同様に読み取り専用)。