Pass Parameters to a global mbox

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

Topics:
at.js

CREATED FOR:

Developer

The JavaScript targetPageParams function is used to pass parameters to the global mbox in Adobe Target. This is needed in any scenario where additional targeting/context information is to be passed into Target.

For example, in a Recommendations activity, use the parameters to represent the current product or category that is being viewed.

The code to call the JavaScript function must come before the global mbox on the page, whether the global mbox is fired as a part of at.js or is manually included in the page code.

NOTE

If you want to add parameters to all mboxes on the page, not just to the global mbox, use the targetPageParamsAll() function.

You can pass in parameters to target-global-mbox using the targetPageParams() function in any of the following ways:

An array
A JSON object
An ampersand-delimited list

Use these three methods to verify that the parameters are being passed correctly. You might also be able to verify the passing of parameters using the Adobe Experience Cloud Debugger.

You must define the JavaScript function before adding the global mbox to the page. The name must be targetPageParams.

Query String

p1=v1&p2=v2&p3=hello%20world

Name: targetPageParams
Return value: a “&” delimited parameters, with URL encoded parameter values.

Example:

In this example, p3 has the value hello world, which is URL encoded.

Consider the following example page code:

<html>
  <head>
    <title>Title here..</title>
    <script type="text/javascript">
        function targetPageParams() {
          return "p1=v1&p2=v2&p3=hello%20world";
        }
    </script>
    <script src="mbox.js" type="text/javascript"></script>
  </head>
  <body>Body here...
  </body>
</html>

This example sends the following data to the mbox edge:

p1=v1
p2=v2
p3=hello world

Array

<!--window.-->targetPageParams = function() {
  return ["a=1", "b=2", "c=hello world"];
};

Values do not need to be URL encoded. For example, if a value contains a space, there is no need to encode the space.

This example sends the following data to the mbox edge:

a=1
b=2
c=hello world

JSON

JSON is a powerful way to pass parameters. Target uses the JSON object keys to flatten complicated structures into simple parameters.

<!--window.-->targetPageParams = function() {
  return {
    "a": 1,
    "b": 2,
    "profile": {
                  "memberStatus": Gold,
                  "country": {
                                "city": "San Francisco"
                            }
              }
  };
};

Values do not need to be URL encoded. For example, “San Francisco” does not require the space to be encoded. A space suffices.

This example sends the following data to the mbox edge:

a=1
b=2
profile.memberStatus=Gold
profile.country.city=San Francisco

recommendation-more-help

6906415f-169c-422b-89d3-7118e147c4e3