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
If using the XDM object, list variables use the XDM fields xdm._experience.analytics.customDimensions.lists.list1.list[] to xdm._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; Adobe data collection servers automatically detect and include the correct delimiter set in Report suite settings.
"xdm": {
"_experience": {
"analytics": {
"customDimensions": {
"lists": {
"list1": {
"list": [
{
"value": "Example value 1"
},
{
"value": "Example value 2"
},
{
"value": "Example value 3"
}
]
}
}
}
}
}
}
key objects in addition to value objects in each list[] array. Adobe does not use these key objects when sending data to Adobe Analytics.If using the data object, list variables use data.__adobe.analytics.list1 - data.adobe.analytics.list3 following AppMeasurement syntax. Make sure that you use the correct delimiter set in Report suite settings.
"data": {
"__adobe": {
"analytics": {
"list1": "Example value 1,Example value 2,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. This variable does not have a maximum byte count; however, each individual value has a maximum limit 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";
s.list1 = "Brick,Brick";, one instance is counted in reports.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.
- Any prop can become a list prop. You effectively can have up to 75 list props, if every prop is a list prop. There are only three list vars available.
- List props have a 100-byte limit for the entire variable. List variables have a 255-byte limit per value, and no total byte limit.
- List props do not persist beyond the hit they are set. List variables have any expiration setting that you want. However, with report time processing, you can apply custom attribution to both list props and list variables.