JS SDK API

JS SDK API — клиентский интерфейс web-скрипта Gravity Field. Через него можно отправлять события, получать рекомендации и данные товаров, запускать embed-кампании, ждать появления элементов на странице и отправлять трекинг для API-driven сценариев.

Скрипт публикует один и тот же объект в window.GF и window.SL. В новом клиентском коде используйте GF; SL остается совместимым legacy-алиасом.

Что должно быть настроено

Перед использованием JS SDK проверьте базовую web-интеграцию:

• на странице подключен core.js;
• до загрузки скрипта объявлен window.GF;
• задан GF.section;
• задан GF.pageContext с типом страницы и данными контекста.

Подробнее: Установка скрипта и Контекст страницы.

С чего начать

Структура раздела

• Работа с рекомендательными виджетами — получение товаров рекомендаций, ручная разметка виджета, GF.Recommendations.track, события gf_wrimp и gf_pimp, динамические правила.
• Получение информации о товаре — данные товара из фида, social proof, product sets и GF.pageData.
• Получение аффинити профиля пользователя — GF.ServerUtils.getAffinity() и GF.userAffinity.
• Ожидание элементов, переменных — GF.waitForElement, GF.waitForVariable, GF.PubSub, GF.Utils.waitUntil, GF.Utils.sendEventInViewport.
• Вставка embed виджетов — запуск кампании через GF.Utils.runCampaign.
• Другие полезные функции — overlay, аудитории, API engagement tracking и низкоуровневые методы.

Готовность скрипта

После инициализации скрипт отправляет событие gf-ready. Используйте его, если код должен выполняться только после загрузки пользовательских данных, dynamic.js, кампаний и публичных методов SDK.

document.addEventListener('gf-ready', function () {
  // JS SDK is ready
});

Отправка событий и SPA

GF.API() добавляет действие в очередь скрипта. Если метод вызван до полной инициализации, действие будет выполнено после запуска очереди.

GF.API('event', {
  name: 'Add to Wishlist',
  properties: {
    eventType: 'add-to-wishlist-v1',
    productId: 'item-34454',
  },
});

Карта методов