adobe.target.getOffer(options)

最終更新日： 2024年7月22日
  • トピック：

作成対象：

  • 開発者

この関数は、Target しいオファーを取得するリクエストをトリガーします。

adobe.target.applyOffer() と併用して、応答を処理するか、独自の成功処理を使用します。options パラメーターは必須で、以下の構造を持ちます。

キータイプ必須説明
mbox文字列○mbox 名
paramsオブジェクト×

mbox パラメーター。次の構造を持つキーと値のペアのオブジェクト。

{ "param1": "value1", "param2": "value2"}

success関数○

サーバーから応答を受け取ると、コールバックが実行されます。success コールバック関数は、オファーオブジェクトの配列を表す単一のパラメーターを受け取ります。成功コールバックの例を次に示します。

function handleSuccess(response){......}

詳しくは、以下の「応答」を参照してください。

error関数○

エラーを受け取ると、コールバックが実行されます。エラーと見なされる状況がいくつかあります。

  • HTTP ステータスコードが 200 OK ではない
  • 応答が解析できない。例えば、脆弱な構造の JSON や、JSON ではなく HTML など。
  • 応答には「エラー」キーが含まれます。例えば、危険にさらされて例外がスローされ、リクエストが適切に処理されない可能性があります。mbox がブロックされ、そのコンテンツを取得できないなどの場合にエラーが発生する可能性があります。error コールバック関数は、status と error の 2 つのパラメーターを受け取ります。エラーコールバックの例を次に示します。function handleError(status, error){......}

詳しくは、以下の「エラー応答」を参照してください。

timeout数値×

タイムアウト（ミリ秒）。指定しない場合は、at.js のデフォルトのタイムアウトが使用されます。

デフォルトのタイムアウトは、Target UI の Administration > Implementation で設定できます。

例

getOffer() を使用したパラメーターの追加と、成功処理での applyOffer() の使用：

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);
  }
});

getOffer() でのパラメーターおよびプロファイルパラメーターの追加、および成功処理での applyOffer() の使用：

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

getOffer() でのカスタムタイムアウトとカスタム成功処理の使用：

「YOUR_OWN_CUSTOM_HANDLING_FUNCTION」は、お客様が定義する関数のプレースホルダーです。

adobe.target.getOffer({
  "mbox": "target-global-mbox",
  "success": function(offer) {
    YOUR_OWN_CUSTOM_HANDLING_FUNCTION(offer);
  },
  "error": function(status, error) {
    console.log('Error', status, error);
  },
  "timeout": 2000
});