ドキュメントTarget デベロッパーガイド

adobe.target.applyOffers(options) - at.js 2.x

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

作成対象:

  • 開発者

この関数を使用すると、adobe.target.getOffers() で取得した複数のオファーを適用できます。

メモ
この関数は at.js 2 で導入されました。x を通じてクロスドメイントラッキングを使用している場合です。この関数は at.js バージョン 1 では使用できません。x.
キータイプ必須?説明
selector文字列×Target がオファーコンテンツを配置する必要がある HTML 要素を特定するために使用される HTML 要素または CSS セレクター。セレクターがない場合、Target は使用するHTMLHEADがHTML要素であると見なします。
応答オブジェクト○getOffers() からのレスポンスオブジェクト。
下の「リクエスト」の表を参照してください。

応答

メモ
以下に示すすべてのフィールドで使用可能なタイプについて詳しくは、 配信 API ドキュメントを参照してください。
フィールド名説明
response > prefetch > views > options > content注意:「オプション」の内容は明確に定義されておらず、オプションのタイプ/テンプレートの構造に直接依存しています。
response > prefetch > views > options > typeオプションのタイプ。「コンテンツ」フィールドのタイプを反映します。サポートされているタイプはアクションです。
response > prefetch > views > stateビューの表示通知で転送する必要がある不透明なビューステートトークン。
response > prefetch > views > options > responseTokens現在のオプションの処理時に収集された responseTokens のマップが含まれています。
response > prefetch > views > analytics > payload表示 Analytics 適用した後に Analytics に送信する必要があるクライアントサイド統合用のペイロード。
response > prefetch > views > traceビューごとのプリフェッチコールの全トレースデータを含むオブジェクト。
トレースオブジェクトにはトレースのバージョンも含まれます。
トレースオブジェクトには、現在のビューの詳細も含まれます。
response > prefetch > views > options > eventTokenイベントログはオプションごとに実行されます。適用されるオプションごとに、それぞれのイベントトークンを通知トークンのリストに追加する必要があります。注意: ビューは複数のオプションで構成されています。すべてのオプションの適用および表示されている場合、通知にすべての eventTokens を含める必要があります。
response > prefetch > views > name人間が解読可能な形式のビュー名。
response > prefetch > views > metrics監視してから Target に通知する必要のあるレポート指標。現在、クリック指標のみがサポートされています。要素がクリックされると、適切な eventTokens が収集され、通知が送信されます。
response > prefetch > views > keyビューを識別するキーまたはフィンガープリント。
response > prefetch > views > idビューの ID。
response > notifications > id通知 ID。
response > notifications > events > type通知、クリックまたは表示のタイプ。
response > notifications > events > trace通知イベントのトレース。
response > notifications > events > token通知イベントで送信されたトークン。
response > notifications > events > timestamp通知イベントで送信されたタイムスタンプ。
response > notifications > events > errorCode通知が失敗した場合、コードは失敗の理由を示します。
response > notifications > events現在の通知について記録されたか、記録が失敗したイベント。
response > notifications通知が記録されたか、記録が失敗したかを示します。
response > execute > mboxes > mbox > trace個々の mbox リクエストの全トレースデータを含むオブジェクト。
response > execute > mboxes > mbox > responseTokens特定の mbox リクエストの実行のための responseTokens のマップが含まれています。
response > execute > mboxes > mbox > option > content注意:「オプション」の内容は明確に定義されておらず、オプションのタイプ/テンプレートの構造に直接依存しています。
response > execute > mboxes > mbox > option > typeオプションのタイプ。「コンテンツ」フィールドのタイプを反映します。サポートされているタイプは、html、redirect、JSON、および dynamic です。
response > execute > mboxes > mbox > optionsレスポンスオプション。
response > execute > mboxes > mbox > metrics > eventTokenクリックイベントのトークン。
response > execute > mboxes > mbox > metrics > type"click"
response > execute > mboxes > mbox > metricsclickThrough 指標のリストが含まれています。
response > execute > mboxes > mbox > mboxmbox の名前。
response > execute > mboxes > mbox >indexレスポンスが、リクエストからのこのインデックスを持つ mbox に対するものであることを示します。
response > execute > mboxes > mbox > analytics > payloadmbox の適用後に Analytics に送信する必要があるクライアントサイド統合用の Analytics ペイロード。 (「A4T が有効なキャンペーン」セクションを参照してください)
response > execute > mboxes実行された mbox のリスト。
response > execute > pageLoad > options > content注意:「オプション」の内容は明確に定義されておらず、オプションのタイプ/テンプレートの構造に直接依存しています。
response > execute > pageLoad > options > typeオプションのタイプ。「コンテンツ」フィールドのタイプを反映します。サポートされているタイプは、html、redirect、JSON、dynamic、および action です。
response > execute > pageLoad > optionsビューでグループ化されていないオプション(target-global-mbox およびビューでグループ化されていないビューを持つアクティビティのオプション)。
response > execute > pageLoad > metrics特定のビューに属していないクリック指標。
response > execute > pageLoad > tracepageLoad リクエストのすべてのトレースデータを含むオブジェクト。
response > execute > pageLoad > analytics > payloadペ Analytics ジ読み込みコンテンツの適用後に Analytics に送信する必要があるクライアントサイド統合用のペイロード。 (「A4T が有効なキャンペーン」セクションを参照してください)

呼び出 applyOffers() 例

adobe.target.applyOffers({response:{
  "execute": {
    "pageLoad": {
      "options": [{
        "type": "html",
        "content": "page-load"
      },
      {
        "type": "actions",
        "content": [{
          "type": "setHtml",
          "content": "<h1>Container 1</h1>",
          "selector": "#container1",
          "cssSelector": "#container1"
        },
        {
          "type": "setHtml",
          "content": "<h3>Container 3</h3>",
          "selector": "#container3",
          "cssSelector": "#container3"
        }]
      }],


      "metrics": [{
        "type": "click",
        "selector": "#container1",
        "eventToken": "page-load-click-metric"
      }]
    }
  }
}});

getOffers() および applyOffers() を使用した Promise チェーンの呼び出しの例。これらの関数は Promise ベースであるためです。

adobe.target.getOffers({...})
.then(response => adobe.target.applyOffers({ response: response }))
.then(() => console.log("Success"))
.catch(error => console.log("Error", error));

getOffers ()の使用方法のその他の例については、getOffers ドキュメントを参照してください

ページ読み込みリクエストの例

adobe.target.getOffers({
    request: {
        execute: {
            pageLoad: {}
        }
    }
}).
then(response => adobe.target.applyOffers({ response: response }))
.then(() => console.log("Success"))
.catch(error => console.log("Error", error));
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3