JavaScript API

Модули и методы

Модули предоставляют доступ к низкоуровневому API скрипта. Используйте этот API, если ваш сайт использует подгрузку контента с помощью AJAX.

Доступ к модулю осуществляется через вызов:

Shoppilot.require("module_name");

Доступны следующие модули:

Омнибокс

Модуль omnibox предоставляет методы для управления поведением Омнибокса.

send(command)

Отправляет соответствующую команду Омнибоксу. Параметры:

Пример вызова:

var omnibox = Shoppilot.require("omnibox");
// отобразить форму отзыва
omnibox.send("showReviewForm");

setContext(options)

Меняет контекст Омнибокса. Следует использовать при AJAX-навигации на сайте.

Пример вызова:

var omnibox = Shoppilot.require("omnibox");
//  Новый контекст — товар с id=123
omnibox.setContext({ type: "product", id: "123" });

isLoggedIn()

Возвращает Promise. Пример вызова:

var LOGGED_IN_TO_WEBSITE; // TODO
var Omnibox = Shoppilot.require("omnibox");
Omnibox.isLoggedIn().then(function (logged_in_to_shoppilot) {
  if (LOGGED_IN_TO_WEBSITE && !logged_in_to_shoppilot) {
    // To do some SMART things
  }
});

Виджет

Для каждого контекста есть свой модуль: product_widget, category_widget, brand_widget, store_widget. Методы модулей идентичны.

new Widget(options)

Конструктор виджета.

Параметр options.container указывается только при использовании мульти-виджета (см. ниже).

Пример вызова:

var ProductWidget = Shoppilot.require("product_widget");
var product_reviews = new ProductWidget({
  name: "product-reviews",
  product_id: "123",
});

appendTo(container)

Вставляет виджет в DOM дерево. Возвращает Promise.

Пример вызова:

var ProductWidget = Shoppilot.require("product_widget");
var w = new ProductWidget({ name: "product_reviews", product_id: "123" });
w.appendTo("#product-reviews"); // <div id="product-reviews"></div>

Мульти-виджет

Модуль multi_widget позволяет получить несколько виджетов одним запросом. Это очень удобно, когда на странице больше одного виджета.

render(widgets)

Добавить в DOM дерево несколько виджетов.

Пример вызова:

var ProductWidget = Shoppilot.require("product_widget");
var inline_rating = new ProductWidget({
  name: "inline-rating",
  product_id: "123",
  container: ".inline-rating",
});
var product_reviews = new ProductWidget({
  name: "product-reviews",
  product_id: "123",
  container: ".product-reviews",
});

var MultiWidget = Shoppilot.require("multi_widget");
MultiWidget.render([inline_rating, product_reviews]);

Отслеживание событий

Модуль events позволяет отслеживать события виджетов и омнибокса.

on(event_name, callback)

Возможные значения параметра event_name:

Параметры функции обратного вызова callback(event)

Пример перехвата события «просмотр отзывов»:

var events = Shoppilot.require("events");
events.on("widget.impression", function (event) {
  var widget = event.data.widget;
  // отправляем событие в Google Analytics
  ga("send", "event", "widget-" + widget.name, "impression");
});

Пример перехвата события «открытие формы отзыва»:

var events = Shoppilot.require("events");
events.on("omnibox.review_form.open", function (event) {
  // отправляем событие в Google Analytics
  ga("send", "event", "review form", "open");
});

Пользовательские настройки

set(key, value)

Устанавливает или изменяет параметр по умолчанию

Например, чтобы добавить пользовательские атрибуты к отзыву, нужно выполнить следующий код:

var config = Shoppilot.require("user_config");
config.set("review_custom_attributes", { shop: { string: "Магазин Химки" } });

На странице отзывов во вкладке «Пользовательские атрибуты» вы увидите атрибут shop: Магазин Химки.