Class Item

Abstract base class. An item is something in a site or app that users can view or otherwise engage with. Typical examples are products, articles, and blogs. Marketing Cloud Personalization tracks descriptive fields and user activity against items. This activity can be used to build reports and to promote relevant items to users.

All fields are optional unless otherwise stated. Generally, optional fields should only be sent if they are specific to this transaction (e.g. LineItem.item.price) or if they aren't already being sent along with web activity on the same dataset.

Direct known subclasses:

Also refer to:

FieldDescriptionModifier and Type
descriptionOverview text about the item.java.lang.String
expirationIf set, this item will be expired/unavailable on or after this time.java.util.Date
idThe item's ID. Required.java.lang.String
imageUrlFully-qualified URL for the image representing this item.java.lang.String
locationLocation related to this item.Location
nameName of a Product, Category or Tag.java.lang.String
numRatingsTotal number of ratings given to this item.java.lang.Integer
promotionStateAn optional promotion state that modifies how items will be selected and ordered for promotion.java.lang.String
publishedIf set, this item will be published/available on or after this time.java.util.Date
ratingOverall score for the item.java.lang.Double
tagsAdditional descriptive tags about an item such as Brand for products or Author and Keywords for articles.java.util.List<Tag>
urlLink to this item.java.lang.String

Required. Uniquely identifies an Item. The ID of a category must also identify its parents, separated by pipe (|) characters. If a category has the ID "parent" and another category is the child of the first, the child's ID might be "parent|child".

Name of a Product, Category or Tag. This serves as the title for an Article or Blog.

Overview text about the item.

Link to this item.

Fully-qualified URL for the image representing this item.

Location related to this item.

Additional descriptive tags about an item such as Brand for products or Author and Keywords for articles.

See Also

Overall score for the item.

Total number of ratings given to this item.

An optional promotion state that modifies how items will be selected and ordered for promotion. For a list of allowed values and meanings, see PromotionState.

If set, this item will be published/available on or after this time. Unpublished items will be excluded from promotion campaigns.

If set, this item will be expired/unavailable on or after this time. Expired items will be excluded from promotion campaigns.

MethodModifier and Type
fromJSONString(java.lang.String jsonString)static Item