「IMG」タグおよび「A」タグの HTTP 要求パラメーター

エンド・ユーザーが Message Connector でエンコードされた IMG タグを含む E メールを開いたため、あるいは、エンド・ユーザーが A タグをクリックスルーしたために、Message Connector が要求を受け取った場合、その要求に含まれるパラメーターは解析され、適切なオファー・データが返されます。このセクションでは、要求 URL (IMG タグ (E メールのオープン時にタグ付きイメージが表示されたときに自動でロードされる) または A タグ (E メールを表示しているユーザーが指定されたサイトにリンクされているメッセージをクリックスルーしたときにロードされる)) に含めることができるパラメーターのリストを示します。

パラメーター

Message Connector は要求を受け取ると、その要求に含まれるパラメーターを解析します。これらのパラメーターには、次のいずれかまたはすべてが含まれます。

パラメーター名 説明 必須かどうか デフォルト値
msgId E メールまたは Web ページの固有 ID。 はい なし。これは、タグを含む E メール・メッセージまたは Web ページの固有インスタンスを作成するシステムによって提供されます。
linkId この E メールまたは Web ページ内のリンクの固有 ID。 はい なし。これは、タグを含む E メール・メッセージまたは Web ページの固有インスタンスを作成するシステムによって提供されます。
audienceLevel この通信の受信者が属するオーディエンス・レベル。 いいえ MessageConnectorConfig.xml ファイルにある audienceLevels 要素にデフォルトとして指定される audienceLevel。
ic ターゲット対話式チャネル (IC) の名前 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある interactiveChannel 要素の値 (デフォルトは「interactiveChannel」)。
ip 該当するインタラクション・ポイント (IP) の名前 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある interactionPoint 要素の値 (デフォルトは「headBanner」)。
offerImageUrl メッセージ内にある IMG URL のターゲット・オファー・イメージの URL。 いいえ なし。
offerImageUrlAttr ターゲット・オファー・イメージの URL を含む、オファー属性の名前 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある imageUrlAttribute 要素の値。
offerLandingPageUrl ターゲット・オファーに対応するランディング・ページの URL。 いいえ なし。
offerLandingPageUrlAttr ターゲット・オファーに対応するランディング・ページの URL を含む、オファー属性の名前。 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある landingPageUrlAttribute 要素の値。
contactEvent コンタクト・イベントの名前。 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある contactEventName 要素の値 (デフォルトは「contact」)。
responseEvent 承認イベントの名前。 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある acceptEventName 要素の値 (デフォルトは「accept」)。
debug デバッグ・フラグ。このパラメーターは、トラブルシューティングのために IBM® テクニカル・サポートから指示を受けた場合にのみ、「true」に設定します。 いいえ MessageConnectorConfig.xml ファイルの defaultParameterValues セクションにある debugFlag 要素の値 (デフォルトは「false」)。
<audience id> このユーザーのオーディエンス ID。このパラメーターの名前は構成ファイルに定義されています。 はい なし。

Message Connector が認識できない (つまり、上記リストに表示されていない) パラメーターを受け取ると、そのパラメーターは以下の考えられる 2 つの方法のいずれかで処理されます。

  • 認識できないパラメーター (例えば、attribute="attrValue" などの「attribute」) が指定されており、「Type」という単語が付加された同じ名前の一致するパラメーター (例えば、attributeType="string" などの「attributeType」) がある場合、Message Connector は一致する Interact パラメーターを作成し、それを Interact ランタイムに渡します。

    Type パラメーターの値は以下のいずれかを指定できます。

    • ストリング
    • 数値
    • 日時

      タイプ「datetime」のパラメーターについて、Message Connector は「Pattern」という単語が付加された同じ名前のパラメーター (「attributePattern」など) も検索します (値の形式が有効な日付/時刻の場合)。例えば、パラメーター attributePattern="MM/dd/yyyy" を指定できます。

      「datetime」のパラメーター・タイプを指定しても、一致する日付パターンを指定しないと、Interact サーバー上の Message Connector 構成ファイル (<installation_directory>/msgconnector/config/MessageConnectorConfig.xml にあります) に指定されている値が使用されます。

  • 認識できないパラメーターが指定されており、一致する Type 値がない場合、Message Connector はそのパラメーターをターゲット・リダイレクト URL に渡します。

認識できないすべてのパラメーターについて、Message Connector はそれらのパラメーターの処理も保存も行わずに、Interact ランタイム・サーバーに渡します。

Message Connector コードの例

以下の A タグには、E メール・メッセージに表示される可能性のある一連の Message Connector リンクの例が含まれています。

<a href="http://www.example.com/MessageConnector/offerClickthru.jsp?msgId=234
   &linkId=1&userid=1&referral=xyz">
	<img src="http://www.example.com/MessageConnector/offerImage.jsp?msgId=234&linkId=1
      &userid=1&incomeCode=3&incomeType=numeric"/>
</a>

この例の IMG タグの場合、E メール・メッセージが開かれたときに自動的にロードされます。指定されたページからイメージを取得することで、メッセージは固有のメッセージ ID (msgID)、固有のリンク ID (linkID)、および固有のユーザー ID (userid) のパラメーターを、渡す必要がある 2 つの追加パラメーター (incomeCode および incomeType) と共に Interact ランタイムに渡します。

A タグには、E メール・メッセージのオファー・イメージをクリック可能なリンクに変える HREF (ハイパーテキスト参照) 属性が示されます。メッセージのビューアーがイメージを見てすぐにランディング・ページにクリックスルーした場合、固有のメッセージ ID (msgId)、リンク ID (linkId)、およびユーザー ID (userid) が、ターゲット・リダイレクト URL に渡される 1 つの追加パラメーター (referral) と共にサーバーにパススルーされます。

親トピック: Message Connector リンクの作成