• Главная
  • Документация
  • Цены
  • Партнерам
  • Блог
  • API рекомендаций

    Запрос информации

    Вызов метода из JavaScript

    Для получения списка рекомендаций используйте одну из функций:

    ФункцияОписание метода
    stcl.recommendationsВозвращает массив строк-идентификаторов предложений
    stcl.recommendationsScoreВозвращает массив объектов идентификатор-вес предложения
    stcl.recommendationsPropsВозвращает массив объектов идентификатор-свойства предложения

    Выполнение функции с параметрами и получение результата:

    stcl.recommendations({
    	count : 20,
    	rule : "rule",
    	limit : "category=Телефон",
    	sort : ":20",
    	check : true,
    	mode : "offer",
    	collection : "sold",
    	offer : "267391-327",
    	excludeGoal : "Изменение корзины",
    	sameGroup : "cat",
    	offers : ["599728-600","724824-100"]
    }, function(data){
    	// действия с полученной информацией
    }, function(){
    	// действия в случае ошибки
    });
    

    Описание параметров:

    ПараметрОписание
    countМаксимальное количество предложений в ответе, по умолчанию 20
    ruleИмя правила для фильтрации предложений, по умолчанию отсутствует
    limitФильтрация возвращаемых предложений по одному из свойств в формате тип=значение. По умолчанию отсутствует.

    Пример использования:

    limit = "category=Телефон";
    sortПараметры сортировки возвращаемого списка. Состоит из трех компонентов, разделенных символом двоеточие (“:”): имя_параметра:количество:тип.

    имя_параметра – параметр, по которому производится сортировка. Если отсутствует, то вместо сортировки производится перемешивание (shuffle)
    количество – количество первых элементов, которые будут отсортированы.
    тип – тип сортировки: na – числовой, nd – числовой в обратном порядке, sa – строковый, sd – строковый в обратном порядке.

    Пример использования:

    sort = ":20"; // перемешать первые 20 элементов
    sort = "gender:5:nd"; // отсортировать первые 5 элементов по строковому полю gender в обратном порядке.
    checkВозвращать только те предложения, данные по которым известны. Позволяет отфильтровать предложения, которые были недавно удалены, но все еще присутствуют в статистике за последние дни.

    Пример использования:

    check = true;
    modeРежим показа рекомендаций. Можно выбрать один из режимов:

    interest – Рекомендации по интересам
    offer – Рекомендации относительно данного товара

    Пример использования:

    mode = "interest";
    collectionКоллекция данных для показа рекомендаций. Можно выбрать один из режимов:

    sold – Самые продаваемые товары
    viewed – Самые просматриваемые товары

    Пример использования:

    collection = "sold";
    offerID текущего предложения для использования в режиме mode=offer.

    Пример использования:

    offer = "267391-327";
    excludeGoalИсключать предложения, которые были добавлены в корзину или куплены.

    Пример использования:

    excludeGoal = "Изменение корзины";

    Ключевое слово all в значении уберет все предложения, для которых была достигнута цель.
    sameGroupВыводить предложения только из той же группы, что и текущее в режиме mode=offer. Можно указать несколько групп через запятую.

    Пример использования:

    sameGroup = "cat";
    offersМассив предложений для сортировки. При использовании этого параметра только указанные предложения могут быть возвращены.

    Пример использования:

    offers = ["599728-600","724824-100"];

    Если параметр не определен, то его необходимо заменить на ключевое слово null.

    Вызов метода с серверной стороны

    Список рекомендаций может быть получен GET-запросом на один из следующих URL:

    URLТип запросаОписание метода
    /my/offersGETВозвращает массив строк-идентификаторов предложений
    /my/offers/scoreGETВозвращает массив объектов идентификатор-вес предложения
    /my/offers/propsGETВозвращает массив объектов идентификатор-свойства предложения

    При вызове данных методов используются следующие параметры запроса:

    ПараметрОписаниеОбязательный
    keyКлюч ресурсаДа
    uidИдентификатор пользователя.Да
    cМаксимальное количество предложений в ответе, по умолчанию 20Нет
    rИмя правила для фильтрации предложений, по умолчанию отсутствуетНет
    lФильтрация возвращаемых предложений по одному из свойств в формате тип=значение. По умолчанию отсутствует.

    Пример использования:

    l=category%3DТелефон
    Нет
    sПараметры сортировки возвращаемого списка. Состоит из трех компонентов, разделенных символом двоеточие (“:”): имя_параметра:количество:тип.

    имя_параметра – параметр, по которому производится сортировка. Если отсутствует, то вместо сортировки производится перемешивание (shuffle)
    количество – количество первых элементов, которые будут отсортированы.
    тип – тип сортировки: na – числовой, nd – числовой в обратном порядке, sa – строковый, sd – строковый в обратном порядке.

    Пример использования:

    s=:20 – перемешать первые 20 элементов
    s=gender:5:nd – отсортировать первые 5 элементов по строковому полю gender в обратном порядке.
    Нет
    chkВозвращать только те предложения, данные по которым известны. Позволяет отфильтровать предложения, которые были недавно удалены, но все еще присутствуют в статистике за последние дни.

    Пример использования:

    chk=1
    Нет
    modeРежим показа рекомендаций. Можно выбрать один из режимов:

    interest – Рекомендации по интересам
    offer – Рекомендации относительно данного товара

    Пример использования:

    mode=interest
    Нет
    colКоллекция данных для показа рекомендаций. Можно выбрать один из режимов:

    sold – Самые продаваемые товары
    viewed – Самые просматриваемые товары

    Пример использования:

    col=sold
    Нет
    offerID текущего предложения для использования в режиме mode=offer.

    Пример использования:

    offer=267391-327
    Нет
    eИсключать предложения, которые были добавлены в корзину или куплены.

    Пример использования:

    excludeGoal = "Изменение корзины";

    Ключевое слово all в значении уберет все предложения, для которых была достигнута цель.
    Нет
    gВыводить предложения только из той же группы, что и текущее в режиме mode=offer. Можно указать несколько групп через запятую.

    Пример использования:

    sameGroup = "cat";
    Нет
    oСписок предложений для сортировки. При использовании этого параметра только указанные предложения могут быть возвращены.

    Пример использования:

    o=599728-600,724824-100
    Нет

    В ответе будет получен JSON-объект, содержащий информацию.

    Результат

    В зависимости от выбранного метода будет получена различная информация по предложениям в виде отсортированного массива.

    Следующие параметры могут присутствовать в ответе.

    ПараметрТипОписание
    offerСтрокаИдентификатор предложения
    propsОбъектСвойства данного предложения
    scoreЧислоРелевантность - чем выше, тем больше