Перші кроки

Якщо ви плануєте використовувати алгоритми товарних рекомендацій 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 ;
        }

});

На поп-апі кошика використання події StatusCartPage

eS('sendEvent', 'StatusCartPage');

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

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" // та iншi атрибути товару з фiда } ]`	List<object>	● product_id - ідентифікатор товару, що рекомендується ● container_type необхідно використовувати для передачі події ProductImpression ● url містить посилання на товар з додатковим параметром для правильного трекінгу кліків.

Важливо!

Ви не повинні редагувати значення, що повертається в поле URL-адреси, щоб веб-трекінг працював правильно.

Приклад помилки

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

Важливо!

Після виклику та відображення блоку рекомендацій для правильного трекінгу необхідно передавати подію ProductImpressions.

Якщо ви хочете задавати відображення зовнішнього вигляду рекомендаційних блоків у eSputnik, ознайомтеся з цією інструкцією.