DocumentationTarget Developer Guide

adobe.target.applyOffer(options)

Last update: Mon Jul 17 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

This function is for applying the response content with Adobe Target.

NOTE
applyOffer requires the mbox parameter. If no mbox name is specified, an error occurs.

The options parameter is mandatory and has the following structure:

Key
Type
Required
Description
mbox
String
Yes
Mbox name
With at.js 1.3.0 (and later) Target enforces that the mbox key is used. This key has been required in the past, but Target now enforces its use to ensure that Target has proper validation and customers are using the function correctly.
selector
String or DOM Element
No
HTML element or CSS selector used to identify the HTML element where Target should place the offer content. If selector is not provided, Target assumes that the HTML element should use HTML HEAD.
Offer
Array
Yes
An array actions that should be applied to the element.

Example

The following example shows how to use getOffer and applyOffer together:

adobe.target.getOffer({
  "mbox": "mbox",
  "success": function(offers) {
        adobe.target.applyOffer( {
           "mbox": "mbox",
           "offer": offers
        } );
  },
  "error": function(status, error) {
      if (console && console.log) {
        console.log(status);
        console.log(error);
      }
  },
 "timeout": 5000
});
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3