The method returns an API response when requesting product recommendations.
Syntax and parameters
sdk.recommend(params) { callback }
Name
Type
Requirement
Description
params
enum
required
Request parameters.
callback
function
required
A callback function, to which the API response will be passed.
Request parameters
Name
Type
Requirement
Description
blockId
string
required
Unique code of the recommendation block. See this value in the "data-recommender-code" attribute of the block created in PersonaClick account.
currentProductId
string
required in some cases
Product ID. This parameter is mandatory for the requests of blocks that use the algorithms "Similar" and "Also bought".
API response properties
Name
Type
Description
html
string
HTML-code of the block with products. The template is customized in the PersonaClick account.
title
string
The block title. Corresponds to the value of the "Action" element in the block rules.
recommends
array/Object
Array with product IDs. If an extended response is requested, this property will have an object array with extended information for each product.
id
number
Unique block identifier. Corresponds to the block ID in the list of blocks in the PersonaClick account.
Examples of use
For blocks with algorithms without any additional parameters:
sdk.recommend(blockId: "1fd1b3495137bc3c9299816026acf36f") { recommendResult in
// the functionality of rendering a block of product recommendations
}
For blocks with algorithms that require the "Product ID":
sdk.recommend(blockId: "1fd1b3495137bc3c9299816026acf36f", currentProductId: "100500") { recommendResult in
// the functionality of rendering a block of product recommendations
}