ドキュメントCampaignCampaign Classic v7 ドキュメント

JavaScript による統合（クライアントサイド） integration-via-javascript-client-side

Last update: Fri Apr 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Web ページでインタラクションエンジンを呼び出すには、ページに JavaScript コードを直接挿入します。この呼び出しにより、ターゲットのオファーコンテンツを返します

要素にオファーコンテンツが返されます。

アドビでは、JavaScript 統合方法の使用をお勧めします。

URL を呼び出すスクリプトは、次のようになります。

<script id="interactionProposalScript" src="https://<SERVER_URL>/nl/interactionProposal.js?env=" type="text/javascript"></script>

「env」パラメーターは、匿名インタラクション専用のライブ環境の内部名を受け取ります。

オファーを提示するには、Adobe Campaign で環境とオファースペースを作成してから、HTML ページを設定する必要があります。

次の使用例で、JavaScript を使用したオファーの統合について考えられるオプションを説明します。

HTML モード html-mode

匿名オファーの提示 presenting-an-anonymous-offer

  1. インタラクションエンジンの準備

    Adobe Campaign インターフェイスを開き、匿名環境を用意します。

    この匿名環境にリンクしたオファースペースを作成します。

    このオファースペースにリンクしたオファーとその表示域を作成します。

  2. HTML ページのコンテンツ

    HTML ページには、作成したオファースペースの内部名の値（"i_スペースの内部名"）を持つ @id 属性のある

    要素を含める必要があります。オファーは、インタラクションによってこの要素に挿入されます。

    この例では、@id 属性は、値 "i_SPC12" を受け取ります（「SPC12」が先ほど作成したオファースペースの内部名）。

    code language-none 
    <div id="i_SPC12"></div>

    この例では、スクリプトを呼び出す URL は、次のようになります（「OE3」はライブ環境の内部名）。

    code language-none 
    <script id="interactionProposalScript" src="https://instance.adobe.org:8080/nl/interactionProposal.js?env=OE3" type="text/javascript"></script>
    note important
    IMPORTANT
    <script> タグは、自己終了タグにすることはできません。

    この静的呼び出しは、インタラクションエンジンに必要なすべてのパラメーターを含む動的呼び出しを自動的に生成します。

    この動作によって、同じページに複数のオファースペースを使用して、1 回のエンジン呼び出しで管理できます。

  3. HTML ページでの結果

    オファー表示域のコンテンツは、インタラクションエンジンによって HTML ページに返されます。

    code language-none 
    <div id="banner_header">
  <div id="i_SPC12">
    <table>
      <tbody>
        <tr>
          <td><h3>Fly to Japan!</h3></td>
        </tr>
        <tr>
          <td><img width="150px" src="https://instance.adobe.org/res/Track/874fdaf72ddc256b2d8260bb8ec3a104.jpg"></td>
          <td>
            <p>Discover Japan for 2 weeks at an unbelievable price!!</p>
            <p><b>2345 Dollars - All inclusive</b></p>
          </td>
        </tr>
      </tbody>
    </table>
  </div>
  <script src="https://instance.adobe.org:8080/nl/interactionProposal.js?env=OE3" id="interactionProposalScript" type="text/javascript"></script>
</div>

識別されたオファーの提示 presenting-an-identified-offer

識別された連絡先に対してオファーを提示する手順は、匿名オファーの提示で説明する手順とほぼ同じです。エンジン呼び出し中に連絡先を識別する次のスクリプトを Web ページのコンテンツに追加する必要があります。

<script type="text/javascript">
  interactionTarget = <contact_identifier>;
</script>

  1. Web ページから呼び出されるオファースペースに移動して、「詳細設定パラメーター」をクリックし、1 つまたは複数の識別キーを追加します。

    この例では、識別キーは、メールと受信者名の両方を基にした複合キーです。

  2. Web ページが表示される間、スクリプト評価を使用して、受信者 ID をオファーエンジンに渡すことができます。ID が複合キーの場合は、詳細設定で使用されたのと同じ順番に並んだキーが | で区切られて表示されます。

    次の例では、コンタクト先は、Web サイトにログインし、インタラクションエンジンの呼び出し中にメールと名前によって識別されます。

    code language-none 
    <script type="text/javascript">
  interactionTarget = myEmail|myName;
</script>

HTML レンダリング関数の使用 using-an-html-rendering-function

HTML のオファー表示域を自動的に生成するには、レンダリング関数を使用できます。

  1. オファースペースに移動し、「関数を編集」リンクをクリックします。

  2. 「HTML レンダリング関数をオーバーロード」を選択します。

  3. 「HTML レンダリング」タブに移動し、オファースペースのオファーコンテンツ用に定義されたフィールドに合致する変数を挿入します。

    この例では、オファーは、バナーの形式で Web ページに表示され、オファーコンテンツで定義されたフィールドに合致する、クリック可能な画像とタイトルで構成されます。

XML モード xml-mode

オファーの提示 presenting-an-offer

インタラクションでは、オファーエンジンを呼び出した HTML ページに XML ノードを返すことができます。この XML ノードは、顧客側で開発した関数で処理できます。

インタラクションエンジンの呼び出しは、次のようになります。

<script type="text/javascript" id="interactionProposalScript" src="https://<SERVER_URL>/nl/interactionProposal.js?env=&cb="></script>

「env」パラメーターは、ライブ環境の内部名を受け取ります。

「cb」パラメーターは、（コールバック）提案を含むエンジンから返される XML ノードを読み込む関数の名前を受け取ります。このパラメーターはオプションです。

「t」パラメーターは、識別されたインタラクションの場合にのみ、ターゲットの値を受け取ります。このパラメーターは interactionTarget 変数を使用して渡すこともできます。このパラメーターはオプションです。

「c」パラメーターは、カテゴリの内部名のリストを受け取ります。このパラメーターはオプションです。

「th」パラメーターは、テーマのリストを受け取ります。このパラメーターはオプションです。

「gctx」パラメーターは、ページ全体にグローバル（コンテキスト）な呼び出しデータを受け取ります。このパラメーターはオプションです。

返される XML ノードは、次のようになります。

<propositions>
 <proposition id="" offer-id="" weight="" rank="" space="" div=""> //proposition identifiers
   ...XML content defined in Adobe Campaign...
 </proposition>
 ...
</propositions>

次の使用例は、XML モードを有効化し、エンジンの呼び出しの結果を HTML ページで表示するために Adobe Campaign で実行する設定について説明します。

  1. 環境とオファースペースの作成

    環境の作成について詳しくは、ライブ／デザイン環境を参照してください。

    オファースペースの作成について詳しくは、オファースペースの作成を参照してください。

  2. オファースキーマの拡張による新しいフィールドの追加

    このスキーマは、「Title 2」（タイトル 2）および「Price」（価格）フィールドを定義します。

    この例のスキーマの名前は cus:offer です。

    code language-none 
    <srcSchema _cs="Marketing offers (cus)" created="2013-01-18 17:14:20.762Z" createdBy-id="0"
           desc="" entitySchema="xtk:srcSchema" extendedSchema="nms:offer" img="nms:offer.png"
           label="Marketing offers" labelSingular="Marketing offers" lastModified="2013-01-18 15:20:18.373Z"
           mappingType="sql" md5="F14A7AA009AE1FCE31B0611E72866AC3" modifiedBy-id="0"
           name="offer" namespace="cus" xtkschema="xtk:srcSchema">
  <createdBy _cs="Administrator (admin)"/>
  <modifiedBy _cs="Administrator (admin)"/>
  <element img="nms:offer.png" label="Marketing offers" labelSingular="Marketing offer"
           name="offer">
    <element label="Content" name="view">
      <element label="Price" name="price" type="long" xml="true"/>
      <element label="Title 2" name="title2" type="string" xml="true"/>

      <element advanced="true" desc="Price calculation script." label="Script price"
               name="price_jst" type="CDATA" xml="true"/>
      <element advanced="true" desc="Title calculation script." label="Script title"
               name="title2_jst" type="CDATA" xml="true"/>
    </element>
  </element>
</srcSchema>
    note important
    IMPORTANT
    各要素は、2 回ずつ定義する必要があります。CDATA（"_jst"）タイプの要素には、パーソナライゼーションフィールドを含めることができます。
    忘れずにデータベース構造を更新してください。詳しくは、この節を参照してください。
    note note
    NOTE
    オファースキーマを拡張し、バッチモードまたは単一モードの両方で、あらゆる形式（テキスト、HTML、および XML）の新しいフィールドを追加できます。

  3. 新しいフィールドを編集し、既存のフィールドを修正するためのオファー数式の拡張

    オファー（nsm） ​入力フォームを編集します。

    「Views」セクションに、次の内容を含んだ 2 つの新しいフィールドを挿入します。

    code language-none 
    <input label="Title 2" margin-right="5" prebuildSubForm="false" type="subFormLink"
                     xpath="title2_jst">
                <form label="Edit title 2" name="editForm" nothingToSave="true">
                  <input nolabel="true" toolbarAlign="horizontal" type="jstEdit"
                         xpath="." xpathInsert="/ignored/customizeTitle2">
                    <container>
                      <input menuId="viewMenuBuilder" options="inbound" type="customizeBtn"
                             xpath="/ignored/customizeTitle2"/>
                    </container>
                  </input>
                </form>
              </input>
              <input nolabel="true" type="edit" xpath="title2_jst"/>

              <input label="Price" margin-right="5" prebuildSubForm="false" type="subFormLink"
                     xpath="price_jst">
                <form label="Edit price" name="editForm" nothingToSave="true">
                  <input nolabel="true" toolbarAlign="horizontal" type="jstEdit"
                         xpath="." xpathInsert="/ignored/customizePrice">
                    <container>
                      <input menuId="viewMenuBuilder" options="inbound" type="customizeBtn"
                             xpath="/ignored/customizePrice"/>
                    </container>
                  </input>
                </form>
              </input>
              <input colspan="2" label="Prix" nolabel="true" type="number" xpath="price_jst"/>

    宛先 URL フィールドをコメントアウトします。

    note important
    IMPORTANT
    （<input>）フォームのフィールドは、作成したスキーマに定義された CDATA タイプの要素を指している必要があります。

    オファー表示域フォームのレンダリングは、次のようになります。

    「Title 2」および「Price」フィールドが追加され、「宛先 URL」フィールドは表示されません。

  4. オファーの作成

    オファーの作成について詳しくは、オファーの作成を参照してください。

    この例では、オファーは次のように入力されます。

  5. オファーを承認するか、誰かにオファーの承認を得てから、前の手順で作成したオファースペースで有効化します。これにより、リンクされたライブ環境でオファーが利用可能になります。

  6. エンジン呼び出しと、HTML ページでの結果

    HTML ページでのインタラクションエンジンの呼び出しは、次のようになります。

    code language-none 
    <script id="interactionProposalScript" src="https://<SERVER_URL>/nl/interactionProposal.js?env=OE7&cb=alert" type="text/javascript">

    「env」パラメーターの値は、ライブ環境の内部名です。

    「cb」パラメーターの値は、エンジンから返された XML ノードを解釈する必要のある関数の名前です。この例では、呼び出される関数がモーダルウィンドウを開きます（alert() 関数）。

    インタラクションエンジンから返される XML ノードは、次のようになります。

    code language-none 
    <propositions>
 <proposition id="a28002" offer-id="10322005" weight="1" rank="1" space="SPC14" div="i_SPC14">
  <xmlOfferView>
   <title>Travel to Russia</title>
   <price>3456</price>
   <description>Discover this vacation package!INCLUDES 10 nights. FEATURES buffet breakfast daily. BONUS 5th night free.</description>
   <image>
    <path>https://myinstance.com/res/Track/ae1d2113ed732d58a3beb441084e5960.jpg</path>
    <alt>Travel to Russia</alt>
   </image>
  </xmlOfferView>
 </proposition>
</propositions>

レンダリング関数の使用 using-a-rendering-function-

XML レンダリング関数を使用して、オファーのプレゼンテーションを作成できます。この関数は、エンジンの呼び出し中に HTML ページに返された XML ノードを修正します。

  1. オファースペースに移動し、「関数を編集」リンクをクリックします。

  2. 「XML レンダリング関数をオーバーロード」を選択します。

  3. 「XML レンダリング」タブに移動し、目的の関数を挿入します。

    関数は、次のようになります。

    code language-none 
    function (proposition) {
  delete proposition.@id;
  proposition.@newAttribute = "newValue";
}

recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1