Newer Version Available
Let us know so we can improve!
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.
1public abstract class Item
2extends java.lang.ObjectDirect 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 will be selected and ordered for promotion. | java.lang.String |
published | If set, this item will be published/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 |
1public java.lang.String idRequired. 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”.
1public java.lang.String nameName of a Product, Category or Tag. This serves as the title for an Article or Blog.
1public java.lang.String descriptionOverview text about the item.
1public java.lang.String urlLink to this item.
1public java.lang.String imageUrlFully-qualified URL for the image representing this item.
1public Location locationLocation related to this item.
1public java.util.List<Tag> tagsAdditional descriptive tags about an item such as Brand for products or Author and Keywords for articles.
See Also
1public java.lang.Double ratingOverall score for the item.
1public java.lang.Integer numRatingsTotal number of ratings given to this item.
1public java.lang.String promotionStateAn optional promotion state that modifies how items will be selected and ordered for promotion. For a list of allowed values and meanings, see PromotionState.
1public java.util.Date publishedIf set, this item will be published/available on or after this time. Unpublished items will be excluded from promotion campaigns.
1public java.util.Date expirationIf set, this item will be expired/unavailable on or after this time. Expired items will be excluded from promotion campaigns.
| Method | Modifier and Type |
|---|---|
fromJSONString(java.lang.String jsonString) | static Item |
1public static Item fromJSONString(java.lang.String jsonString)Newer Version Available