Skip to main content

Deprecated Attributes Guide

Product Interaction Attributes

All Product Interaction attributes have their names derived by some value from the event that originated it. One example is the categories.v2.<category>.<type>.list set of attributes which are named after the category and event type. These types of attributes tend to work with fields that have a large number of unique values, such as product categories. This generates many attributes without immediate use, hampering performance and costs. These attributes were once introduced on the system as a means to widen the ability for our users to express more complex rules, but with the introduction of Custom Attributes, it is now possible to have a fine-grained level of control over the attributes generated.

We are deprecating all Product Interaction attributes. These are all the attributes under the selection group. 'Events' > 'E-commerce' > 'Product Interaction' when creating or editing Segments.

This document serves as a guide to aid in translating the deprecated attributes into Custom Attributes, as the use cases vary widely, this document lists the original attribute definitions and which fields are used to filter the events.

Helper and Considerations When Creating Custom Attributes

A helper is available for new and existing segmentation rules that use deprecated attributes. Its purpose is to simplify the attribute recreation by redirecting the user to the Custom Attribute Creation page with an event field rule pre-filled in. Reviewing the definition and applying the necessary changes according to the business needs is recommended.

Once the attribute is created, the segment rule should be manually updated to use the new attribute.

The following video exemplifies migrating an attribute using the migration helper and manually updating the segment afterward.

Deprecated Attributes Anatomy

The following section describes the anatomy of the deprecated attributes and suggests which fields from events to filter by. All of these attributes extract the Timestamp according to the Unique list concatenation aggregation with a maximum list size of 5 with no default value.

Product Interaction - Brand

brands.<brand-name>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
brand-nameProducts and LineItems > brand

Product Interaction - Size

sizes.<category>.<size>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
categoryProducts and LineItems > category OR Products and LineItems > categoriesList
sizeProducts and LineItems > size

Product Interaction - Category

categories.v2.<categories-list>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
categories-listProducts and LineItems > categoriesList

Product Interaction - List

productInteraction.customFields.list.<list>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
listProducts and LineItems > customFields > list

Product Interaction - Occasion

productInteraction.customFields.occasion.<occasion>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
occasionProducts and LineItems > customFields > occasion

Product Interaction - Stage Name

productInteraction.customFields.stageName.<stage-name>.<event-type>.list

ComponentSuggested Fields
event-typeEvent Type
stage-nameProducts and LineItems > customFields > stageName