Interaction Studio supports ingesting of categories into the catalog while constructing a hierarchy of the category within Interaction Studio. Categories may be updated as well by sending subsequent files with the same CategoryId. Categories are configured by default but may have additional attributes setup in the Catalog Setup screen. Existing system fields pertaining to Categories include name - the name of the category, url - the qualified url on the website for the category, parentCategoryId - the direct ancestor parent category ID, and many others. All system fields are declared in the table below.
Requirements and Schema
Each category must only appear in a single record in any given file. Multiple records with the same ID are going to result in errors specifically if they have different parentCategoryIds.
The Category ETL does not accept delta files. The full category structure must be sent in every feed, regardless of whether each record in the feed has changed. Category attribute columns lacking values will have any existing values stored in the catalog removed.
Category IDs on products, or any other catalog items in Interaction Studio, should match the category IDs provided in the Category ETL.
Categories in Interaction Studio support a hierarchy structure which allows individual categories to have both parent and child categories. A single category can only have 1 parent but can have multiple child categories. Some example categories are clothes, shirts, jackets, t-shirt, dress-shirts, rain-jackets, and winter-jacket. Some examples of the full hierarchies would be clothes>shirts>t-shirt, clothes>shirts>dress-dress-shirts, clothes>jackets>rain-jackets, clothes>jackets>winter-jackets. These relationships are created automatically by the ETL and the corresponding value of the attribute:parentCategoryId column.
Categories lacking values will have any existing values for that column removed, if a column is included in the file.
File Name Format: category-YYYY-MM-DD_HH-MM-SS.csv
Requirements and Schema
Interaction Studio Data Type
Required. Category IDs are strings that represent the identifier for the category.
|attribute:||Any custom attributes for this category. Column titles are the word 'attribute', followed by a colon, followed by the attribute name as configured in the attributes portion of the Catalog Setup > Category screen. Attributes are parsed as the data type they are defined as in the config screen.|
All Clothing, large
Recommended. The singular parent to a category ID.
|attribute:department||A boolean value representing whether a category is a top level category. This value is false by default.||True, False||1023||Boolean|
|attribute:name||Represents the name of a category and must contain at least one alphanumeric character.||Slick New Kicks||1023||String|
|attribute:url||RFC-3986 Complete URLs that represent the canonical display page for this category on site.||https://example.com/category/cat1.html||1023||String|
|attribute:imageUrl||Fully-qualified URL for an image of this category.||https://example.com/img/img1.png||1023||String|
|attribute:description||Represents the description of the category and must contain at least one alphanumeric character to be set.||Some excellent new shoes||255||String|
Boolean (which defaults to true) - when false, the item won't be returned by the Einstein Recipes recommendation system.
Note: if no value is set, this field defaults to true.
|attribute:published||ISO 8601 Date time string for category published date.||2017-04-22T10:23:37Z||1023||Date|
|attribute:expiration||ISO 8601 Date time string for category expiration date.||2017-04-22T10:23:37Z||1023||Date|
|attribute:rating||The rating value associated with a category, no specific scale required, however only the value should be provided. 9/10 is invalid, while 9 is.||4.5||1023||Decimal/Float|
|attribute:numRatings||The number of ratings associated with a category.||5||1023||Integer|
|attribute:archived||Boolean, which defaults to false when no value is set. When true, the item will not be visible in the catalog. If this column is omitted from the feed file, no changes will be made to the archived attribute.||FALSE, false, TRUE, true||1023||Boolean|
All Home Goods
Sneakers for athletics, walking, running, and more
Slacks for work and date night
Our Business Slacks
Our classic timepieces
Sneakers for road races, trail races, track races and more
Our Trainers and Racers
Shoes specifically for racing on tracks
Our track and Field Spikes