prop
This help page describes how to implement props. For information on how props work as a dimension, see prop in the Components user guide.
Props are custom variables that you can use however you’d like. They do not persist beyond the hit that they are set.
If you have a solution design document, you can allocate these custom dimensions to values specific to your organization. The number of available props depends on your contract with Adobe. Up to 75 props are available if your contract with Adobe supports it.
Props using the Web SDK
Props are mapped to the following variables:
- XDM object:
xdm._experience.analytics.customDimensions.props.prop1-xdm._experience.analytics.customDimensions.props.prop75- list props are specified in a separate set of fields. - Data object:
data.__adobe.analytics.prop1-data.__adobe.analytics.prop75; ordata.__adobe.analytics.c1-data.__adobe.analytics.c75- list props are included in these fields.
Props using the Adobe Analytics extension
You can set props either while configuring the Analytics extension (global variables) or under rules.
- Log in to Adobe Experience Platform Data Collection using your AdobeID credentials.
- Click the desired tag property.
- Go to the Rules tab, then click the desired rule (or create a rule).
- Under Actions, click an existing Adobe Analytics - Set Variables action or click the ‘+’ icon.
- Set the Extension drop-down list to Adobe Analytics, and the Action Type to Set Variables.
- Locate the Props section.
You can set a prop to a value or a data element. You can also copy the value from another Analytics variable.
s.prop1 - s.prop75 in AppMeasurement and the Analytics extension custom code editor
Each prop variable is a string that contains custom values specific to your organization. Their max length is 100 bytes; values longer than 100 bytes are automatically truncated when sent to Adobe.
s.prop1 = "Example custom value";
List props
List props are a setting applied to props that allow the variable to hold multiple values in the same hit. If this setting is not enabled, or if the wrong delimiter is used, the variable is treated as a single value.
Configure list props
Enable list props in Traffic variables under report suite settings. Make sure that the desired delimiter is configured correctly. Adobe does not provide a default delimiter.
,), colon (:), semicolon (;), or pipe (|). You can use any non-extended ASCII delimiter that best fits your implementation.Set list props using the Web SDK list-props-web-sdk
If using the XDM object, list props are mapped to xdm._experience.analytics.customDimensions.listProps.prop1.values[] - xdm._experience.analytics.customDimensions.listProps.prop75.values[]. The Web SDK automatically uses the correct delimiter listed under report suite settings. If you set the delimiter in the XDM field (for example, xdm._experience.analytics.customDimensions.props.prop1.delimiter), that overrides the delimiter automatically retrieved from report suite settings and can lead to incorrect parsing of the list prop string.
If using the data object, list props use the same fields as standard props and follow AppMeasurement syntax.
Set list props using the Adobe Analytics extension and AppMeasurement
Once you configure list props in report suite settings with the desired delimiter, there are no implementation differences other than using the delimiter.
// List prop delimited with a comma
s.prop1 = "value1,value2,value3";
If you set the same value more than once in a list prop, they are de-duplicated in reporting. Analysis Workspace counts the number of hits where a value is seen, and not the number of times a value exists in data.