Module: TorgMailruApi::APIMethods

Included in:
TorgMailruApi
Defined in:
lib/torg_mailru_api.rb

Товарные категории collapse

Модели товаров collapse

Товарные предложения collapse

Поиск collapse

Отзывы collapse

Магазины collapse

Производители collapse

Геоинформация collapse

Instance Method Details

#categories(params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список категорий: получение списка товарных категорий верхнего уровня.

Parameters:

  • params (Hash) —

    Хеш параметров

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



196
197
198
 
# File 'lib/torg_mailru_api.rb', line 196

def categories params
  listing "category", params
end

#category(category_id, params) ⇒ DeepOpenStruct

Note:

Ресурс является геозависимым.

Информация о категории: получение информации о товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

Returns:



217
218
219
 
# File 'lib/torg_mailru_api.rb', line 217

def category category_id, params
  get "category/#{category_id}", params
end

#category_children(category_id, params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список подкатегорий: получение списка подкатегорий для товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :type (Symbol) — default: :all —

    Фильтрация выходных данных по типу товарной категории (:all | :model | :parameterized | :general)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: выводятся все результаты —

    Количество результатов на страницу (max: 30)

Returns:



208
209
210
 
# File 'lib/torg_mailru_api.rb', line 208

def category_children category_id, params
  listing "category/#{category_id}/children", params
end

#category_filter(category_id, params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Параметрический поиск: получение списка моделей категории, удовлетворяющих набору заданных параметров.

Parameters:

  • params (Hash) —

    Хеш параметров

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • <parameter_id> (String) —

    Параметр товарной категории. В запросе вместо <parameter_id> указыватся id параметра. Список параметров и их id для определенной товарной категории можно получить с помощью ресурса “Список параметров категории”. Значение зависит от типа выбранного параметра категории:

    • тип параметра numeric — числовое значение <value> или числовой диапазон, значения границ которого разделяются запятой “<min_value>,<max_value>”;

    • тип параметра enum — список идентификаторов допустимых значений параметра, разделенный запятыми, “<value1_id>,<value2_id>,<value3_id>”, где <valueN_id> — идентификатор значения;

    • тип параметра bool — допустимые значения параметра: “true” и “false”.

  • :sort (Symbol) — default: :popular —

    Тип сортировки результатов поиска (:date — по новизне; :popular — по популярности; :price — по цене)

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



369
370
371
 
# File 'lib/torg_mailru_api.rb', line 369

def category_filter category_id, params
  listing "category/#{category_id}/filter", params
end

#category_hits(category_id, params) ⇒ DeepOpenStruct

Note:

Список отсортирован по степени убывания популярности у покупателей.

Note:

Для обычных категорий ресурс возвращает ошибку.

Note:

Ресурс является геозависимым.

Список хитов продаж категории: получение списка 50 моделей-хитов продаж модельной товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

Returns:



263
264
265
 
# File 'lib/torg_mailru_api.rb', line 263

def category_hits category_id, params
  get "category/#{category_id}/hits", params
end

#category_models(category_id, params) ⇒ Listing

Note:

Для обычных категорий ресурс возвращает ошибку.

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список моделей категории: получение списка моделей в модельной товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :vendor_id (Integer) —

    Идентификатор производителя

  • :sort (Symbol) — default: :popular —

    Тип сортировки моделей (:date — сортировка по новизне; :popular — сортировка по популярности; :price — сортировка по цене)

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию)

Returns:



239
240
241
 
# File 'lib/torg_mailru_api.rb', line 239

def category_models category_id, params
  listing "category/#{category_id}/models", params
end

#category_newmodels(category_id, params) ⇒ Listing

Note:

Для обычных категорий ресурс возвращает ошибку.

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список новинок категории: получение списка моделей в модельной товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :sort (Symbol) — default: :popular —

    Тип сортировки моделей (:popular — сортировка по популярности; :price — сортировка по цене)

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



276
277
278
 
# File 'lib/torg_mailru_api.rb', line 276

def category_newmodels category_id, params
  listing "category/#{category_id}/newmodels", params
end

#category_offers(category_id, params) ⇒ Listing

Note:

Для модельных и параметризированных категорий ресурс возвращает ошибку.

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список товарных предложений категории: получение списка товарных предложений в обычной товарной категории.

Parameters:

  • params (Hash) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :sort (Symbol) — default: :auction —

    Тип сортировки предложений (:auction — по убыванию ставки; :price — сортировка по цене)

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



252
253
254
 
# File 'lib/torg_mailru_api.rb', line 252

def category_offers category_id, params
  listing "category/#{category_id}/offers", params
end

#category_parameters(category_id, params = nil) ⇒ DeepOpenStruct

Список параметров категории: получение списка параметров товарной категории.

Parameters:

  • params (Hash) (defaults to: nil) —

    Хеш параметров

  • category_id (Integer) —

    Идентификатор товарной категории

Options Hash (params):

  • :parameter_set (Symbol) — default: :popular —

    Тип набора параметров категории (:popular — популярные; :all — все)

Returns:



226
227
228
 
# File 'lib/torg_mailru_api.rb', line 226

def category_parameters category_id, params=nil
  get "category/#{category_id}/parameters", params
end

#model(model_id, params) ⇒ DeepOpenStruct

Note:

Ресурс является геозависимым.

Информация о модели: получение информации об указанной модели.

Parameters:

  • params (Hash) —

    Хеш параметров

  • model_id (Integer) —

    Идентификатор модели

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

Returns:



287
288
289
 
# File 'lib/torg_mailru_api.rb', line 287

def model model_id, params
  get "model/#{model_id}", params
end

#model_offers(model_id, params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список предложений модели: получение списка товарных предложений указанной модели.

Parameters:

  • params (Hash) —

    Хеш параметров

  • model_id (Integer) —

    Идентификатор модели

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :sort (Symbol) — default: :auction —

    Тип сортировки предложений (:auction — по убыванию ставки; :price — по цене, :rating — по рейтингу магазина + цене, :range — по расстоянию до ближайшей точки продаж (при указании местоположения пользователя)).

    • Если у параметра :sort указано значение :price, сортировка по возрастанию;

    • если у параметра :sort указано значение :rating, сортировка по убыванию;

    • если у параметра :sort указано значение :range, сортировка по возрастанию.

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию). Задается только в том случае, если у параметра :sort указано значение :price

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

  • :latitude (Float) —

    Широта точки нахождения пользователя

  • :longitude (Float) —

    Долгота точки нахождения пользователя

Returns:



314
315
316
 
# File 'lib/torg_mailru_api.rb', line 314

def model_offers model_id, params
  listing "model/#{model_id}/offers", params
end

#model_outlets(model_id, params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список точек продаж модели: получение списка точек продаж указанной модели.

Parameters:

  • params (Hash) —

    Хеш параметров

  • model_id (Integer) —

    Идентификатор модели

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

  • :latitude (Float) —

    Широта точки нахождения пользователя

  • :longitude (Float) —

    Долгота точки нахождения пользователя

Returns:



325
326
327
 
# File 'lib/torg_mailru_api.rb', line 325

def model_outlets model_id, params
  listing "model/#{model_id}/outlets", params
end

#model_parameters(model_id, params = nil) ⇒ DeepOpenStruct

Список характеристик модели: получение списка характеристик указанной модели.

Parameters:

  • params (Hash) (defaults to: nil) —

    Хеш параметров

  • model_id (Integer) —

    Идентификатор модели

Options Hash (params):

  • :parameter_set (Symbol) — default: :popular —

    Тип набора параметров категории (:popular — популярные, :all — все)

Returns:



296
297
298
 
# File 'lib/torg_mailru_api.rb', line 296

def model_parameters model_id, params=nil
  get "model/#{model_id}/parameters", params
end

#offer(offer_id, params = nil) ⇒ DeepOpenStruct

Информация о товарном предложении: получение расширенной информации об указанном товарном предложении магазина.

Parameters:

  • params (Hash) (defaults to: nil) —

    Хеш параметров

  • offer_id (Integer) —

    Идентификатор товарного предложения

Returns:



335
336
337
 
# File 'lib/torg_mailru_api.rb', line 335

def offer offer_id, params=nil
  get "offer/#{offer_id}", params
end

#region(region_id) ⇒ DeepOpenStruct

Информация о регионе: получение информации о выбранном регионе.

Parameters:

  • region_id (Integer) —

    Идентификатор региона

Returns:



447
448
449
 
# File 'lib/torg_mailru_api.rb', line 447

def region region_id
  get "region/#{region_id}"
end

#region_children(region_id, params = nil) ⇒ Listing

Note:

Ресурс в ответе возвращает листинг.

Список дочерних регионов: получение списка дочерних регионов для выбранного региона.

Parameters:

  • params (Hash) (defaults to: nil) —

    Хеш параметров

  • region_id (Integer) —

    Идентификатор региона

Options Hash (params):

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



440
441
442
 
# File 'lib/torg_mailru_api.rb', line 440

def region_children region_id, params=nil
  listing "region/#{region_id}/children", params
end

#region_suggest(params) ⇒ DeepOpenStruct

Текстовый поиск региона: получение списка регионов, удовлетворяющих строке запроса.

Parameters:

  • params (Hash) —

    a customizable set of options

Options Hash (params):

  • :query (String) —

    Полное или частичное название региона (обязательно!)

  • :total (Integer) — default: 5 —

    Количество результатов (max: 10)

Returns:



455
456
457
 
# File 'lib/torg_mailru_api.rb', line 455

def region_suggest params
  get "region/suggest", params
end

#regions(params = nil) ⇒ Listing

Note:

Ресурс в ответе возвращает листинг.

Список регионов: получение списка регионов верхнего уровня.

Parameters:

  • params (Hash) (defaults to: nil) —

    Хеш параметров

Options Hash (params):

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



431
432
433
 
# File 'lib/torg_mailru_api.rb', line 431

def regions params=nil
  listing "regions", params
end

#search(params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Полнотекстовый поиск: получение списка моделей и товарных предложений, удовлетворяющих строке запроса.

Parameters:

  • params (Hash) —

    Хеш параметров

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :query (String) —

    Поисковый запрос (обязательно!)

  • :category_id (Integer) —

    Фильтрация результатов поиска по товарной категории

  • :seller_id (Integer) —

    Фильтрация результатов поиска по магазину

  • :price_min (Integer) —

    Фильтрация результатов поиска по минимальной цене товарных предложений

  • :price_max (Integer) —

    Фильтрация результатов поиска по максимальной цене товарных предложений

  • :sort (Symbol) — default: :relevance —

    Тип сортировки результатов поиска (:price — сортировка по возрастанию цены, :relevance — по релевантности)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

Returns:



352
353
354
 
# File 'lib/torg_mailru_api.rb', line 352

def search params
  listing "search", params
end

#seller(seller_id) ⇒ DeepOpenStruct

Информация о магазине: получение информации о выбранном магазине.

Parameters:

  • seller_id (Integer) —

    Идентификатор магазина

Returns:



392
393
394
 
# File 'lib/torg_mailru_api.rb', line 392

def seller seller_id
  get "seller/#{seller_id}"
end

#seller_outlets(seller_id, params) ⇒ Listing

Note:

Ресурс является геозависимым.

Note:

Ресурс в ответе возвращает листинг.

Список точек продаж магазина: получение списка точек продаж выбранного магазина.

Parameters:

  • params (Hash) —

    Хеш параметров

  • seller_id (Integer) —

    Идентификатор магазина

Options Hash (params):

  • :geo_id (Integer) —

    Идентификатор региона (обязательно!)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: 10 —

    Количество результатов на страницу (max: 30)

  • :latitude (Float) —

    Широта точки нахождения пользователя

  • :longitude (Float) —

    Долгота точки нахождения пользователя

Returns:



403
404
405
 
# File 'lib/torg_mailru_api.rb', line 403

def seller_outlets seller_id, params
  listing "seller/#{seller_id}/outlets", params
end

#seller_reviews(seller_id, params) ⇒ Listing

Note:

Ресурс в ответе возвращает листинг.

Отзывы о магазине: получение списка отзывов о магазине.

Parameters:

  • params (Hash) —

    Хеш параметров

Options Hash (params):

  • :sort (Symbol) — default: :date —

    Тип сортировки отзывов (:mark — по оценке пользователя; :date — по дате добавления отзыва; :valuable — по оценке полезности отзыва)

  • :sort_order (Symbol) — default: :desc —

    Направление сортировки (:asc — по возрастанию; :desc — по убыванию)

  • :mark (Integer, Symbol) — default: :all —

    Фильтрация отзывов по оценке магазина (1, 2, 3, 4, 5; :all — все значения)

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: выводятся все результаты —

    Количество результатов на страницу (max: 30)

Returns:



383
384
385
 
# File 'lib/torg_mailru_api.rb', line 383

def seller_reviews seller_id, params
  listing "seller/#{seller_id}/reviews", params
end

#vendor(vendor_id) ⇒ DeepOpenStruct

Информация о производителе: получение информации о производителе.

Parameters:

  • vendor_id (Integer) —

    Идентификатор производителя

Returns:



421
422
423
 
# File 'lib/torg_mailru_api.rb', line 421

def vendor vendor_id
  get "vendor/#{vendor_id}"
end

#vendors(params = nil) ⇒ Listing

Note:

Ресурс в ответе возвращает листинг.

Список производителей: получение списка производителей, товары которых представлены в каталоге моделей на Товарах@Mail.Ru

Parameters:

  • params (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (params):

  • :category_id (Integer) —

    Идентификатор товарной категории, для которой нужно получить список производителей

  • :page (Integer) — default: 1 —

    Номер страницы

  • :results_per_page (Integer) — default: выводятся все результаты —

    Количество результатов на страницу (max: 30)

Returns:



414
415
416
 
# File 'lib/torg_mailru_api.rb', line 414

def vendors params=nil
  listing "vendor"
end