list

List variables are custom variables that you can use however you’d like. They work similarly to eVars, except they can contain multiple values in the same hit. List variables do not have a character limit.

Make sure that you record how you use each list variable and their logic in your solution design document.

Set up list variables in report suite settings

Make sure that you configure each list variable in report suite settings before using them in your implementation. See Conversion variables in the Admin guide. This step applies to all implementation methods.

List variables using the Web SDK

List variables are mapped for Adobe Analytics under the XDM fields _experience.analytics.customDimensions.lists.list1.list[] to _experience.analytics.customDimensions.lists.list3.list[]. Each array element contains a "value" object that contains each string. There is no need to provide a delimiter; it is automatically included using the value specified in Report suite settings. For example, if a comma (‘,’) is configured as the delimiter for list variable 1, the following XDM object populates the list1 variable with "Example value 1,Example value 2,Example value 3".

"xdm": {
  "_experience": {
    "analytics": {
      "customDimensions": {
        "lists": {
          "list1": {
            "list": [
              {
                "value": "Example value 1"
              },
              {
                "value": "Example value 2"
              },
              {
                "value": "Example value 3"
              }
            ]
          }
        }
      }
    }
  }
}

List variables using the Adobe Analytics extension

There is not a dedicated field in the Adobe Analytics extension to use this variable. Use the custom code editor, following AppMeasurement syntax.

s.list1 - s.list3 in AppMeasurement and the Analytics extension custom code editor

Each list variable is a string that contains custom values specific to your organization. They do not have a maximum byte count; however, each individual value has a maximum of 255 bytes. The delimiter that you use is determined when setting up the variable in Report suite settings. Do not use spaces when delimiting multiple items.

// A list variable configured with a comma as a delimiter
s.list1 = "Example value 1,Example value 2,Example value 3";

Compare list props to list vars

List props and list vars can both contain multiple values in the same hit. However, there are several key differences between these two variable types.