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. Send optional fields only if they’re relevant to the transaction (for instance, LineItem.item.price
) or if they aren’t already included with web activity in the same dataset.
Direct known subclasses:
Also refer to:
Field | Description | Modifier and Type |
---|---|---|
description | Overview text about the item. | java.lang.String |
expiration | If set, this item will be expired/unavailable on or after this time. | java.util.Date |
id | The item's ID. Required. | java.lang.String |
imageUrl | Fully qualified URL for the image representing this item. | java.lang.String |
location | Location related to this item. | Location |
name | Name of a Product , Category , or Tag . | java.lang.String |
numRatings | Total number of ratings given to this item. | java.lang.Integer |
promotionState | An optional promotion state that modifies how items are selected and ordered for promotion. | java.lang.String |
published | If set, this item is published or made available on or after this time. | java.util.Date |
rating | Overall score for the item. | java.lang.Double |
tags | Additional descriptive tags about an item such as Brand for products or Author and Keywords for articles. | java.util.List<Tag> |
url | Link 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 name 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 are selected and ordered for promotion. For a list of allowed values and meanings, see PromotionState
.
If set, this item is published or made available on or after this time. Unpublished items are excluded from promotion campaigns.
If set, this item will be expired/unavailable on or after this time. Expired items are excluded from promotion campaigns.
Method | Modifier and Type |
---|---|
fromJSONString(java.lang.String jsonString) | static Item |
getItemType() | abstract String |