You are here:
Einstein Recommendations Catalog Field Definitions
Catalog fields store your catalog’s asset attributes for Einstein Recommendations. These attributes are both required and recommended catalog fields. You can also add custom attributes. Catalog field values can contain up to 1,024 single-byte characters or 512 double-byte characters.
Catalog Requirements
- Leave the catalog field blank rather than populating it with a Null value.
- Text fields can’t include carriage returns, new lines, or HTML.
- All characters in the catalog must either be UTF-8 encoded or converted to valid HTML, except for the pipe and tilde characters.
- Items with a price of $0 are recommended and displayed with the price of $0.
- The final catalog file must be automated and uploaded daily with a unique static file name.
Product Catalog
| Field Name | Required | Attribute Description |
|---|---|---|
| SkuID | No | A unique identifier for each product that’s specific to the customer. This ID must match the product SKU on the website and be passed via the Collect Tracking Code. |
| ProductCode | Yes | Identifies a group of related products. For example, a piece of apparel appears in the catalog multiple times with a unique SkuID for each size that the product is available in. All the size variations are sent with the same ProductCode. The ProductCode can’t contain spaces or special characters. |
| ProductName | Yes | Identifies a product in the title of product detail pages. |
| ProductType | Yes | Product category is open to retailers. The application maps your product types to our internal catalog system. |
| ProductLink | Yes | URL to reach the product detail page. |
| ImageLink | No | URL to the product image displayed in the recommendation. |
| RegularPrice | No | Regular price for the product. You can display this value in strikethrough text for a recommendation when a sale price is available. |
| SalePrice | No | Sale price for the product. It displays if a product is on sale. |
| OnlineAvailability | Yes | Indicates if a product is available for recommendation. This field accepts only two values: Y for available or N for not available. If the field isn’t sent with the feed, the default is Y. If it’s sent as N, the product isn’t returned in recommendations. |
Content Catalog
| Field Name | Required | Attribute Description |
|---|---|---|
| ContentID | Yes | A unique identifier for each piece of content that’s specific to the customer. This ID matches the content ID on the website and is passed via the Collect Tracking Code. |
| Title | No | Title of content included in recommendations. |
| Link | Yes | URL to reach the content detail page. |
| ImageLink | No | URL of the image displayed in the recommendation. |
| Author | No | Author of specific content used to influence recommendations or to be displayed within the recommendations. |
| Category | No | Content category or categories. |
| Availability | Yes | Indicates if content is available for recommendation. This field accepts two possible values: Y for available or N for not available. If the field isn’t sent with the feed, the default is Y. If it’s sent as N, the content isn’t returned in recommendations. |
| Publication Date | No | Date of publication to the site. Use the YYYY-MM-DD date format. |
| Keywords | No | Keywords that describe the content. |
Banner Catalog
| Field Name | Required | Attribute Description |
|---|---|---|
| BannerID | Yes | A unique identifier for each banner or offer that’s specific to the customer. This ID matches the banner ID on the website passed via the Collect code. |
| GroupID | Yes | Identifies a group of related banners. For example, the same banner can be available in multiple sizes. Each banner size must be sent with a separate BannerID, linked together with a matching GroupID. |
| Name | No | Used for easy identification and content management. |
| Category | No | Offer category, aligned to the catalog values sent for product and or content categories. |
| Link | Yes | URL to reach the banner or offer detail page. |
| ImageLink | Yes | URL to the banner image displayed in the recommendation. |
| LocationSize | Yes | Size of the banner location. This value can be a size value, such as 600x400, or a name value, such as HeroHome. |
| PPC | No | Price per click calculates key performance indicators. Round to the nearest 2 decimal places, and send without a currency symbol. |
| Availability | Yes | Indicates if the banner is available for recommendation. This field accepts two possible values: Y for available or N for not available. If the field isn’t sent with the feed, the default is Y. If it’s sent as N, the banner isn’t returned in recommendations. |
| StartDate | No | Banners are excluded from the recommendation pool before the start date. Use the suggested YYYY-MM-DD date format. |
| EndDate | No | Banners are excluded from the recommendation pool on the end date. Use the suggested date YYYY-MM-DD date format. |
| Keywords | No | Describes the banner or offer. |
Did this article solve your issue?
Let us know so we can improve!
