Page tree
Skip to end of metadata
Go to start of metadata

New Name: Marketing Cloud Personalization

Interaction Studio (formerly Evergage) is now known as Marketing Cloud Personalization. The new name reflects our mission and vision for innovation in Salesforce Marketing Cloud. We wish we could snap our fingers to update the name everywhere, but you can expect to see the previous name in various places until we replace it.

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.

This Article Explains

This article details the requirements and schema of the category ETL and provides a sample file structure and download.

Sections in this Article

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 Format

File Name Format: category-YYYY-MM-DD_HH-MM-SS.csv

Requirements and Schema

Field Name

Minimum Requirements

Example Values

Max Length

Interaction Studio Data Type

id

Required. Category IDs are strings that represent the identifier for the category.

  • Category IDs should should not contain any indication of hierarchy, as the hierarchy is constructed by the ETL itself.
  • If there are categories that appear to have the same identifier but have different parent categories, it is recommended that the IDs have some sort of unique identifier to help separate the individual instances.
    • An example on an Ecommerce site may be shirts which may be an intermediary category for top level categories like Athletic Wear and Sale. In this situation it is recommended that the ID for the intermediary shirt category becomes athleticshirts and saleshirts.

clothes

shirts

pants

cat0001

255String
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.

attribute:commonName
All Clothing

attribute:size
large

1023any
System Fields



attribute:parentCategoryId

Recommended. The singular parent to a category ID.

  • Root categories are not expected to have a parentCategoryId and instead are expected to have a value of true in the attribute:department column.
  • Each individual ID must only have a single parentCategoryId.
  • All parentCategoryIds are ingested and used to build an internal hierarchy that is stored in the Interaction Studio system.
    • For example, a category slacks whose parentCategoryId is dress pants, whose parentCategoryId is pants, full internal hierarchy would be pants|dress pants|slacks. The max allowed depth of hierarchy is 10.

clothes

pants

shoes

255String
attribute:departmentA boolean value representing whether a category is a top level category. This value is false by default.True
False
1023Boolean
attribute:nameRepresents the name of a category and must contain at least one alphanumeric character.Slick New Kicks1023String
attribute:urlRFC-3986 Complete URLs that represent the canonical display page for this category on site.https://example.com/category/cat1.html1023String
attribute:imageUrlFully-qualified URL for an image of this category.https://example.com/img/img1.png1023String
attribute:descriptionRepresents the description of the category and must contain at least one alphanumeric character to be set.Some excellent new shoes255String
attribute:promotable

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.

TRUE1023Boolean
attribute:publishedISO 8601 Date time string for category published date.2017-04-22T10:23:37Z1023Date
attribute:expirationISO 8601 Date time string for category expiration date.2017-04-22T10:23:37Z1023Date
attribute:ratingThe 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.51023Decimal/Float
attribute:numRatingsThe number of ratings associated with a category.51023Integer
attribute:archivedBoolean, 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
1023Boolean

  

Sample File

Sample File Download


id

attribute:parentCategoryIdattribute:department

attribute:name

attribute:archived

attribute:url

attribute:imageUrl

attribute:description

attribute:promotable

attribute:published

attribute:expiration

attribute:rating

attribute:numRatings

attribute:commonName

cat0001


TRUE

Home

FALSE

test.com/c/home

test.com/c/home.jpeg

All Home Goods

TRUE

2020-06-15

2100-01-01

5.0

5

Home Goods

cat002


TRUE

Shoes

FALSE

test.com/c/shoes

test.com/c/shoes.jpeg

All Shoes

TRUE

2020-06-15

2100-01-01

4.25

10

Our Shoes

cat003


TRUE

Shirts

FALSE

test.com/c/shirts

test.com/c/shirts.jpeg

All Shirts

TRUE

2020-06-15

2100-01-01

4.75

35

Our Shirts

cat004


TRUE

Pants

FALSE

test.com/c/pants

test.com/c/pants.jpeg

All Pants

TRUE

2020-06-15

2100-01-01

3.0

31

Our Pants

cat005


TRUE

Hats

FALSE

test.com/c/hats

test.com/c/hats.jpeg

All Hats

TRUE

2020-06-15

2100-01-01

3.0

11

Our Hats

cat006


TRUE

Accessories

FALSE

test.com/c/accessories

test.com/c/accessories.jpeg

All Accessories

FALSE

2020-06-15

2100-01-01


18

Our Accessories

cat0021

cat002


Sneakers

FALSE

test.com/c/home/shoes/sneakers

test.com/c/home/shoes/sneakers.jpeg

Sneakers for athletics, walking, running, and more

TRUE

2020-06-15




Our Sneakers

cat0041

cat004


Slacks

FALSE

test.com/c/pants/slacks

test.com/c/pants/slacks.jpeg

Slacks for work and date night

TRUE

2020-06-15


1.0

1

Our Business Slacks

cat0061

cat006


Watches

FALSE

test.com/c/accessories/watches

test.com/c/accessories/watches.jpeg

Our classic timepieces

TRUE

2020-06-15


4.5

8

Our Watches

cat00211

cat0021


Running Sneakers

FALSE

test.com/c/shoes/sneakers/running-sneakers

test.com/c/shoes/sneakers/running-sneakers.jpeg

Sneakers for road races, trail races, track races and more

TRUE

2020-06-15


4.0

6

Our Trainers and Racers

cat002111

cat00211


Racing Spikes

FALSE

test.com/c/shoes/sneakers/running-sneakers/racing-spikes

test.com/c/shoes/sneakers/running-sneakers/racing-spikes.jpeg

Shoes specifically for racing on tracks

TRUE

2020-06-15


2.33

23

Our track and Field Spikes