Настройка передачи рекомендаций с помощью JavaScript API

Если вы планируете использовать алгоритмы товарных рекомендации eSputnik, а отображение (внешний вид блоков, страницы показа и т. д.) настроить на своей стороне, вам необходимо

установить на сайт скрипт для отслеживания поведения посетителей сайта;
загрузить фид товарных данных в аккаунт eSputnik;
настроить передачу рекомендаций из eSputnik на ваш сайт.

Описание настроек

Функция JS API необходима для получения рекомендаций и дальнейшего их использования в товарных блоках на сайте.

Скрипты получения рекомендаций

На главной и 404 странице

eS('getRecommendations', {
  'variantId': 'r554v778'
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

На странице товара

eS('getRecommendations', {
  'variantId': 'r554v778',
  'productId': 'MX-1512\42'
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

На странице корзины

eS('getRecommendations', {
  'variantId': 'r554v778',
  'productIds': ['123', '543534']
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

На странице категорий

eS('getRecommendations', {
  'variantId': 'r554v778',
  'categoryKey': 'cK'
  }, function(error, products) {


  if (error) {
            console.error(error);
            return ;
        }
});

Метод JS API – асинхронный, что позволяет не ждать выполнения других функций на сайте.

Параметры запроса

Название	Тип	Пример	Описание
variantId	Required String	r262v361	Уникальный идентификатор варианта рекомендации, созданный в аккаунте eSputnik.
productId	Optional String	MX-1512\42	Для передачи id товара со страницы, на которой находится пользователь. Обязательный параметр для рекомендаций с использованием продуктового алгоритма (похожие товары, с этим товаром покупают), для других типов алгоритмов передавать не нужно.
productIds	Optional List	['123', '543534']	Для передачи id товара или массива ids товаров корзины. Обязательный параметр для рекомендаций с использованием продуктового алгоритма (похожие товары, с этим товаром покупают), для других типов алгоритмов передавать не нужно.
categoryKey	Optional String	Jackets	Для передачи ключа категории, в которой находится пользователь. Обязательный параметр для рекомендаций с использованием категориального алгоритма (персонально для вас в этой категории), для других типов алгоритмов передавать не нужно.
allFields	Optional Boolean	true\false	Параметр для определения того, какие атрибуты товара будут в запросе рекомендаций: Все (которые имеются в фиде товарных данных) или только Обязательные: product_id url container_type По умолчанию параметр = false

Пример ответа

При успешной отправке запроса вы получите ответ следующего вида:

Тело ответа	Тип	Описание
`[ { "product_id": "02G439", "container_type": "19534_r24v435", "url": "https://…?sc_content=19534_r24v435" // и другие атрибуты товара из фида } ]`	List<object>	● product_id - идентификатор рекомендуемого товара ● container_type необходимо использовать при передаче события ProductImpression ● url содержит ссылку на товар, с дополнительным параметром для правильного трекинга кликов.

📌 Важно!
Вы не должны редактировать, возвращаемое значение в поле URL-адреса, чтобы веб-трекинг работал правильно.

Пример ошибки

Пример	Тип	Описание
variantId r262v361 was not found in config	String	Такой идентификатор варианта рекомендации не найден.

📌 Важно!
После вызова и отображения блока рекомендаций для правильного трекинга необходимо передавать событие ProductImpressions.

Если вы хотите задавать отображение внешнего вида рекомендательных блоков в eSputnik, ознакомьтесь с этой инструкцией.