adobe.target.getOffer(options)
この関数は、Target しいオファーを取得するリクエストをトリガーします。
adobe.target.applyOffer() と併用して、応答を処理するか、独自の成功処理を使用します。options パラメーターは必須で、以下の構造を持ちます。
mbox パラメーター。次の構造を持つキーと値のペアのオブジェクト。
{ "param1": "value1", "param2": "value2"}
サーバーから応答を受け取ると、コールバックが実行されます。success コールバック関数は、オファーオブジェクトの配列を表す単一のパラメーターを受け取ります。成功コールバックの例を次に示します。
function handleSuccess(response){......}
詳しくは、以下の「応答」を参照してください。
エラーを受け取ると、コールバックが実行されます。エラーと見なされる状況がいくつかあります。
- HTTP ステータスコードが 200 OK ではない
- 応答が解析できない。例えば、脆弱な構造の JSON や、JSON ではなく HTML など。
- 応答には「エラー」キーが含まれます。例えば、危険にさらされて例外がスローされ、リクエストが適切に処理されない可能性があります。mbox がブロックされ、そのコンテンツを取得できないなどの場合にエラーが発生する可能性があります。error コールバック関数は、status と error の 2 つのパラメーターを受け取ります。エラーコールバックの例を次に示します。
function handleError(status, error){......}
詳しくは、以下の「エラー応答」を参照してください。
タイムアウト（ミリ秒）。指定しない場合は、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
});
応答
success コールバックに渡された応答パラメーターはアクションの配列になります。アクションは、通常は次の形式のオブジェクトです。
例
{
"sessionId": "1444512212156-384616",
"tntId": "1444512212156-384616.17_35",
"offers": [{
"plugins": ["<script type=\"text/javascript\">\r\n/*mboxHighlight+ (1of2) v1 ==> Response Plugin*/\r\nwindow.ttMETA=(typeof(window.ttMETA)!='undefined')?window.ttMETA:[];window.ttMETA.push({'mbox':'target-global-mbox','campaign':'at: redirect ootb','experience':'Experience B','offer':'/at_redirect_ootb/experiences/1/pages/0/1442082890250'});window.ttMBX=function(x){var mbxList=[];for(i=0;i<ttMETA.length;i++){if(ttMETA[i].mbox==x.getName()){mbxList.push(ttMETA[i])}}return mbxList[x.getId()]}\r\n</script>"],
"actions": {
"content": [{
"passMboxSession": false,
"selector": "body",
"action": "redirect",
"url": "https://example.com/04.html",
"includeAllUrlParameters": true
}]
}
}]
}
エラー応答
error コールバックに渡される「status」および「error」パラメーターは、次の形式を持ちます。
エラーの状態を表します。このパラメーターは次の値を持つことができます。
- timeout：リクエストがタイムアウトしたことを示します。
- parseerror：例えば、JSON ではなく HTML またはプレーンテキストを受け取るなど、応答が解析できなかったことを示します。
- error：200 OK ではない HTTP ステータスを受け取ったなど、一般的なエラーを示します。