Find Reference Content Feed

This document should be used in tandem with the Product Feed document.

Reference content feed contains attributes (meta-data) about information such as recipes, articles, blogs, videos, or any other reference content on a commerce site which is to be indexed and searched. Find will index and search attributes about the content such as description, name, or any custom attribute. The Reference Content Feed consists of two separate files (three if you have regions), included inside the standard compressed Catalog Feed that you send. For updates, must supply the full feed again.

This feed can be sent in two ways: on its own, or zipped into the product feed.

Feed Files

Feed File	Details	Filename pattern
Content Feed	A list and description of every piece of content to be indexed and searched by Find.	content_full_sitename_YYYY_MM_DD.txt
Content Attribute Feed	The attributes for each piece of content. Each reference content requires at least the image and link attributes.	content_attribute_sitename_YYYY_MM_DD.txt
Region Full Feed	If regions are required, the Region Full Feed needs to be provided as specified: Product Region Feed Note: If using regions must provide all regions across the site even if not specific to the content.	region_full_sitename_YYYY_MM_DD.txt

Feed File

Details

Filename pattern

Content Feed

A list and description of every piece of content to be indexed and searched by Find.

content_full_sitename_YYYY_MM_DD.txt

Content Attribute Feed

The attributes for each piece of content. Each reference content requires at least the image and link attributes.

content_attribute_sitename_YYYY_MM_DD.txt

Region Full Feed

If regions are required, the Region Full Feed needs to be provided as specified: Product Region Feed

Note: If using regions must provide all regions across the site even if not specific to the content.

region_full_sitename_YYYY_MM_DD.txt

Note: These files can be included in the Flat File Catalog Feed when it is zipped for transfer to Algonomy.

File Specifications

See below for the specifications for each file.

The delimiter in the file must be a pipe (|) unless another delimiter is required. If, for some reason, you are not able to use a pipe as delimiter, alert your Algonomy representative who will work with you to accommodate your specific needs.

Reserved Words:

content_id

content_external_id

content_genre

content_genre_id

content_name

name

content_type (Note: value will be "4")

contentType

content_feed_date

content_start_date

startDate

content_end_date

endDate

content_recommendable

recommendable

content_findable

content_site_id

preview_url

previewUrl

Content Feed

Filename: content_full_sitename_YYYY_MM_DD.txt required

Note: Content cannot have the same IDs as products. Products and content must have unique IDs.

Name	Type	Required?	Definition
id	ASCII	Yes	A unique identifier for this piece of content. The IDs for each piece of content must remain consistent across time, i.e. this cannot be randomized. Note: Forward slashes (/) are not supported in the id field.
name	text	Yes	The name (title) of the content which is also searchable. The maximum length is 255 characters. By default this attribute is facetable, searchable, filterable, and storable.
start_date	date	No	The format for this date is YYYY-MM-DD. By default this attribute is facetable and filterable.
end_date	date	No	The format for this date is YYYY-MM-DD. By default this attribute is filterable.
findable	Boolean	Yes	A flag for Find Reference Content. Set to True if you want the content to be indexed by Find. Default is False.
recommendable	Boolean	Yes	Must be set to false. Default is true.

Sample

- Find Reference Content Full

Copy

id|name|findable|recommendable
100|How to fix a faucet|true|false
200|Gardening 101|true|false

Reference Content Attribute Feed

Filename: content_attribute_sitename_YYYY_MM_DD.txt required

Attributes values (and multi-valued attributes) can be listed in a column-based format or a row-based format. However, the file must adhere to one or the other; you cannot mix and match within the same file. The system automatically determines the format from the header.

The list must use a delimiter that does not exist in attribute values and should not be a list delimiter used elsewhere in the file. Values that have a period are treated as lists (this is the default behavior). The period delimits each value in the list. However, the list value delimiter may be customized when creating the feed profile.

Content attributes is where you specify attributes (meta-data) about the reference content. A custom attribute can be up to 32 thousand characters so descriptions or other information can indexed and searched.

Reference content must have one attribute for the image URL and another one for the link URL. Reference Content without images will be ignored in the search results. There is no naming convention required for these attributes, Both the image URL and link URL names will be added to the site configuration during the setup of the content search API.

Column-based format

Name	Type	Required?	Definition
content_id	ASCII	Yes	Identifier for the content as defined in the content file Note: Forward slashes (/) are not supported in the cotent_id field.
attribute.image_url	string	Yes	It can be any name but an image URL must be provided. The "attribute" prefix is required.
attribute.link_url	string	Yes	It can be any name but the link URL must be provided. The "attribute" prefix is required.
attribute.[attribute key 1]	text	No	custom attribute
attribute.[attribute key 2]	text	No	custom attribute
...
attribute.[attribute key N]	text	No	Nth distinct attribute

Sample

Basic example of the content attribute feed, in column-based format:

Copy

content_id|attribute.size|attribute.image_url|attribute.link_url
100|medium|http://mysite.com/images/100.jpg|http://mysite.com/content100
101|large|http://mysite.com/images/100.jpg|http://mysite.com/content101

Specifying multiple attributes (the list value delimiter defaults to the period but may be changed when creating the feed profile):

Copy

content_id|attribute.size|attribute.color|attribute.image_url|attribute.link_url
100|small.large|red.green
200|medium.large|red.blue.green

Row-based format

Name	Type	Required?	Definition
content_id	ASCII	Yes	Identifier for the content as defined in the content file Note: Forward slashes (/) are not supported in the ContentID field.
attr_name	text	Yes	Unique attribute key
attr_value	text	Yes	Name of the attribute
localization_type	text	No	Region or language
localization_value	text	No	Value for region or language.

Samples

Basic example of the content attribute feed, in row-based format:

Copy

content_id|attr_name|attr_value
100|size|medium
200|size|large
100|image_url|http://mysite.com/images/100.jpg
200|image_url|http://mysite.com/images/200.jpg
100|link_url|http://mysite.com/content100
200|link_url|http://mysite.com/content200

Specifying multiple attributes in separate rows:

Copy

content_id|attr_name|attr_value
100|image_url|http://mysite.com/images/100.jpg
100|link_url|http://mysite.com/content100
100|color|red
100|color|blue
100|color|green
100|size|small
100|size|medium
100|size|large

Passing multiple attributes in individual rows (the list value delimiter defaults to the period but may be changed when creating the feed profile):

Copy

content_id|attr_name|attr_value
100|image_url|http://mysite.com/images/100.jpg
100|link_url|http://mysite.com/content100
100|color|red.blue.green
100|size|s.m.l

Row-Based Example with Localization

Copy

content_id|attr_name|attr_value|localization_type|localization_value
100|on_sale|true||
100|on_sale|true|region|us
100|on_sale|false|region|de
100|on_sale|true|region|fr
200|has_documentation|true||
200|has_documentation|true|language|zh-CN
200|has_documentation|false|language|en-US