Adobe Target のadobe.target.trackEvent、adobe.target.getOffer、adobe.target.getOffersについて

はじめに

Adobe Target の関数 adobe.target.trackEvent、adobe.target.getOffer、adobe.target.getOffersはAdobe Targetの実装でmboxパラメーターをリクエストする際に使用する関数ですが、その違いについて説明します。

前提条件

at.jsのバージョンは2.xを対象としています。

それぞれの主な機能

adobe.target.trackEvent

クリックの追跡やコンバージョンの計測に使用します。レスポンスは受け取りません。
リクエストにはtimestampが含まれており、閲覧している端末の内部時計のずれが大きいと400エラーになり計測がされない場合があります。
内部的には navigator.sendBeacon() が呼ばれています。

adobe.target.getOffer

ターゲットのオファーを受け取るためのリクエストを発行します。レスポンスでオファーを受け取り、必要に応じてadobe.target.applyOfferを実行します。
リクエストにはwindow.targetPageParams()やwindow.targetPageParamsAll()が定義されている場合にはそれらで追加されたパラメーターが追加されます。
内部的には window.XMLHttpRequest()が呼ばれています。

adobe.target.getOffers

複数のオファーを同時にリクエストできます。それ以外に、有効なアクティビティの全てのオファーを受け取ることもできます。レスポンスでオファーを受け取り、必要に応じてadobe.target.applyOffersを実行します。
リクエストにはwindow.targetPageParams()やwindow.targetPageParamsAll()が定義されている場合にはそれらで追加されたパラメーターが追加されます。
at.js初期化パラメーターのpageLoadEnabledが有効な場合は自動的にパラメーターexecute -> pageLoadで呼び出されます。
内部的には window.XMLHttpRequest()が呼ばれています。

使用例

adobe.target.trackEvent

				
					adobe.target.trackEvent({ 
    "mbox": "clicked-cta", 
    "params": { 
        "param1": "value1" 
    } 
});

adobe.target.getOffer

				
					adobe.target.getOffer({   
  "mbox": "target-global-mbox", 
  "params": { 
     "a": 1, 
     "b": 2 
  }, 
  "success": function(offer) {           
        adobe.target.applyOffer( {  
           "mbox": "target-global-mbox", 
           "offer": offer  
        } ); 
  },   
  "error": function(status, error) {           
      console.log('Error', status, error); 
  } 
});

adobe.target.getOffers

				
					adobe.target.getOffers({
    request: {
        mboxes: [
        {
          index: 0,
          name: "first-mbox"
        },
        {
          index: 1,
          name: "second-mbox",
          parameters: {
            a: 1
          },
          profileParameters: {
            b: 2
          }
        }
      ]
    }
}).
then(response => adobe.target.applyOffers({ response: response }))
.catch(error => console.log("Error", error));

※adobe.target.getOffersのパラメーターのパターンは多数ありますが、getOfferと同じ使い方をする例だけを記載しています。