Recombee Docs
Visit recombee.comStart Free
docs20User Documentation
adminuiAdmin UI
reql32ReQL
codeAPI Clients & Integrations
suitcaseMisc

Catalog Feeds

Setting a catalog feed in the Recombee Admin UI is an alternative to uploading the items catalog using our API.

We periodicaly download your feed and update items accordingly. The default update period is 4 hours - if it does not match your specific needs, please contact support@recombee.com.

  • Supported protocols for fetching: http, https, ftp and sftp.
  • Supported feeds compressions: .zip and .gz.

We support following types of feed formats:

A step-by-step video tutorial on setting up a catalog feed#

General notes#

  • Property name itemId is reserved
  • Items deleted from feeds are not deleted in Recombee catalog. Instead, they can be updated as not available. For more details see Handling of removed items.

Google Merchant Feed#

Format#

Tips & Tricks#

  • You can use item property availability for filtering out from the recommendations the items that are not available anymore.

    The filter that should be passed to recommendation requests is:

    ReQL
    'availability' == "in stock"
    

    Only items in stock will be recommended. You can achieve this also by setting the predefined Filter Business Rule Items in stock [Google Merchant] to your Scenario.

  • Ids of items are case sensitive - please check that you are using the same case as is used in the feed when you send interactions.

  • You can use for example following javascript snippet to get recommended items along with their title, description, link, image link and price:

    JS
    client.send(new recombee.RecommendItemsToItem(itemId, userId, 3,
    {
    	returnProperties: true,
    	includedProperties: ['title', 'description', 'link', 'image_link', 'price'],
    	filter: "'availability' == \"in stock\"",
    	scenario: 'related_items'
    }),
    (err, resp) => {
    	if(err) {
    	console.log("Could not load recomms: ", err);
    	return;
    	}
    
    	console.log(resp);
    
    	// Show recommendations
    
    );
    
    

For more info see the javascript library.

Atom / RSS#

Atom / RSS feeds are used by the news websites and also many blog pages or podcasts to provide structured information about the offered content.

How to set up#

  1. Set the URL of your Atom / RSS feed.

  2. The feed gets processed and a list of properties that were recognized in the feed is presented in the Suggested properties section. You can pick from this list the properties that you want to synchronize to Recombee.

    You can also create a custom new property and set an XPath for it (relative to the item entry). This is needed especially in the case of large .zip feeds which cannot be fully processed in this step to obtain the suggested properties.

  3. Continue to Preview and check that you are getting expected data for all the properties. When you are satisfied, confirm the settings and the feed will get scheduled for processing.

Setting RSS feed

IDs with special characters#

The IDs of the items in Recombee may consist of digits, latin letters, underscores, colons, minus signs, at sign, and dot.

If the IDs in your feed do not follow this format (the ID is for example the URL of the item), enable the MD5 Item IDs option in the Settings. An MD5 hash of the original ID value is then used as the ID.

You then need to use the MD5 hash also when you send interactions to Recombee and when you request Items to Item recommendation.

In Javascript the MD5 hash of the original ID can be obtained for example like this:

HTML
<script src="https://cdnjs.cloudflare.com/ajax/libs/blueimp-md5/2.18.0/js/md5.js"></script>

<script type="text/javascript">
	var itemId = md5('<original item ID>');

	// Use the itemId when sending interactions to Recombee / asking for Items to Item recommendation
</script>

Custom XML#

An XML that contains structured information about the items.

How to set up#

  1. Set the URL of your XML feed.
  2. Set Items Path - the XPath to the root element of the items records
  3. Set Item ID Path - Path (relative to the item entry) to the element that contains the itemId. If your IDs contain some special characters, enable the MD5 Item IDs option (see this section for more details).
  4. The feed gets processed and a list of properties that were recognized in the feed is presented in the Suggested properties section. You can pick from this list the properties that you want to synchronize to Recombee.

You can also create a custom new property and set an XPath for it (relative to the item entry). This is needed especially in the case of large .zip feeds which cannot be fully processed in this step to obtain the suggested properties.

  1. Continue to Preview and check that you are getting expected data for all the properties. When you are satisfied, confirm the settings and the feed will get scheduled for processing.

For information about handling items deletion and updating items availability see Handling of removed items.

Custom JSON#

A JSON that contains structured information about the items.

How to set up#

  1. Set the URL of your JSON feed.

  2. Set Items Path - a path defined by keys of JSON objects to the array with items records

    JSON Structure Selector
  3. Set Item ID Path - a path (relative to the item entry) to the element that contains the itemId. If your IDs contain some special characters, enable the MD5 Item IDs option (see this section for more details).

  4. The feed gets processed and a list of properties that were recognized in the feed is presented in the Suggested properties section. You can pick from the list properties that you want to synchronize to Recombee.

    You can also create a new property and set a path of keys for it (relative to the item entry). This is needed especially in the case of large .zip feeds which cannot be fully processed in this step to obtain the suggested properties.

  5. Continue to Preview and check that you are getting expected data for all the properties. When you are satisfied, confirm the settings and the feed will get scheduled for processing.

For information about handling items deletion and updating items availability see Handling of removed items.

Custom CSV#

A CSV file where each line contains data for a single item.

It is expected that:

  • The IDs of the items are contained in the first column
  • The first row of the CSV file is a header (contains names of the columns)

The file is automatically analyzed to determine the used delimiter and quoting.

How to set up#

  1. Set the URL of your CSV feed.

  2. The feed gets processed and a list of properties (columns) that were recognized in the feed is presented in the Suggested properties section. You can pick from this list the properties that you want to synchronize to Recombee. You need to set the correct data type for each of the properties.

    You can also create a custom new property and set the column name for it. This is needed especially in the case of large .zip feeds which cannot be fully processed in this step to obtain the suggested properties.

  3. Continue to Preview and check that you are getting expected data for all the properties. When you are satisfied, confirm the settings and the feed will get scheduled for processing.

For information about handling items deletion and updating items availability see Handling of removed items.

Heureka XML Feed#

Format#

Tips & Tricks#

  • You can use item property AVAILABLE for filtering out from the recommendations the items that are not available anymore.

    The filter that should be passed to recommendation requests is:

    ReQL
    'AVAILABLE'
    

Handling of removed items#

The Feeds processor can automatically set items that have been removed from the feed as unavailable.

To use this feature, pick the item property that determines availability, and provide the value which denotes the unavailable items:

Setting Availability property

You can then use this item property in your Filters.

© Copyright 2024, Recombee s.r.o
docs.recombee.com