targetPageParams()

This method allows you to attach parameters to the global mbox from outside of the request code.

This function is very useful for including the same set of parameters on multiple mbox calls. The function needs to be defined by the customer. It should return an array of parameters that will be passed only to the global mbox request. This function can be defined before at.js is loaded or in Administration > Implementation > Edit > Library Header.

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

  • An ampersand-delimited list
  • An array
  • A JSON object

Examples

Ampersand-delimited list (values must be URL encoded):

function targetPageParams() {
    return "param1=value1¶m2=value2&p3=hello%20world";
}

Array (values do not need to be URL encoded):

targetPageParams = function() {
     return ["a=1", "b=2", "c=hello world"];
};

JSON (values do not need to be URL encoded):

targetPageParams = function() {
  return {
    "a": 1,
    "b": 2,
    "profile": {
        "age": 26,
        "country": {
          "city": "San Francisco"
        }
      }
  };
};
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3