Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

 

Параметр

Параметр в условиях поискаОписание условия поиска

Параметр в описании способа поиска

Описание в способе поиска
ПровайдерProvider

Если в условиях поиска не указан провайдер явно, он будет определен по другим условиям (например, категории). Если ни одно условие не определяет провайдера, поиск будет произведен в провайдере по умолчанию.

Если разные условия поиска ведут к различным провайдерам, то такой поиск невозможен и приведет к ошибке.

ProviderИдентификатор провайдера
Способ поиска

 

 

SearchMethodЕсли не указано, используется определенный в настройках способ поиска по умолчанию.SearchMethodНазвание способа поиска
DisplayNameОтображаемое название способа поиска (на нужном языке)
FlagsСписок особенностей способа поиска
Ограничения на число товаровUseOptimalFrameSize

Признак использования оптимального размера фрейма вместо переданного.

Если данное условие передано в значении true, то параметр frameSize игнорируется, и будет использовано OptimalFrameSize из выбранного способа поиска.

  
  OptimalFrameSize

Оптимальное число запрашиваемых товаров (размер страницы).

Если использовать страницы данного размера, это обеспечивает максимальную возможную скорость работы поиска, т.к. оно соответствует размерам страниц у провайдера.

  MaximumFrameSizeМаксимальное число товаров, которое можно получить за 1 запрос. Может работать значительно медленнее, чем при использовании оптимального числа.
  MaximumItemsCountЧисло товаров, до которого в принципе можно получить по одним и тем же условиям поиска. Чтобы получать больше товаров, надо менять и уточнять условия поиска.
Сортировка товаровOrderByЕсли не указано, или указанное значение не входит в число допустимых, будет использована определенная в настройках сортировка по умолчанию.AvailableSortsСписок допустимых сортировок в способе поиска.

Категория

CategoryIdИдентификатор категории, в которой искать товары.  

Название товара

ItemTitle

Поисковая строка по названию товара.

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

  
LanguageOfQuery

Язык поисковой строки по названию товара. Если не указан, считается равным языку выдачи товаров.

Если не равен языку провайдера, то производится автоперевод на язык провайдера.

  

Продавец

VendorIdИдентификатор продавцаVendorПоддерживается ли поиск по продавцу
VendorNameИмя продавца

Местонахождение продавца

VendorAreaIdИдентификатор местонахождения продавца (зоны)VendorLocationПоддерживает ли способ поиска местонахождение продавца

Рейтинг продавца

 
  VendorRatingRangeПоддерживает ли способ поиска фильтр по рейтингу продавца
MinVendorRatingМинимальное значение рейтинга продавцаMinVendorRatingМинимальное значение рейтинга продавца
MaxVendorRatingМаксимальное значение рейтинга продавцаMaxVendorRatingМаксимальное значение рейтинга продавца
БрендBrandIdИдентификатор искомой торговой марки
Brand
Поддерживает ли способ поиска бренды
BrandPropertyValueIdИдентификатор значения искомой торговой марки (устаревший параметр, используйте BrandId)
ЦенаMinPriceМинимальная ценаPriceRangeПоддерживает ли способ поиска фильтр по цене товара
MaxPriceМаксимальная цена
CurrencyCode

Код валюты, в которой указан диапазон цен.
По умолчанию считается первая витринная валюта. Для поиска конвертируется по обратным правилам наценок и курсов в валюту провайдера.

Объем продаж

MinVolumeМинимальный объем продажVolumeRange Поддерживает ли способ поиска фильтр по объему продаж 
MaxVolumeМаксимальный объем продаж
  VolumeRangeLogicЛогика работы условий по объему продаж: диапазон, только минимум, только максимум.
Состояние товара (новый, б/у, неиспользованый)StuffStatusСостояние товараStuffStatusПоддерживает ли способ поиска фильтр по состоянию товара

Характеристики товара (цвет, модель и тд)

Configurators

Список поисковых свойств, представленных структурой.

Configurators

Поддерживает ли способ поиска характеристики товара.

MultipleConfiguratorLogic

Логика работы способа поиска по нескольким значениям одной характеристики.

Использование в поиске нескольких значений одной характеристики.

(например, можно вывести только красное, красное И зеленое, красное ИЛИ зеленое)


Особенности товараFeatures

Список искомых фич товара

Features

Список специальных фильтров, поддерживаемых способом поиска

Управление выдачейOutputMode

Режим выдачи результатов поиска.

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

  • TotalCount — Выдача только общего количества товаров, без самих данных о товарах. Тем самым можно получить общее количество по данным условиям поиска, и не тратить время на обработку самих товаров.
  • Provider — Выдача только провайдера и способа поиска, которыми бы производился поиск, без самого поиска. Провайдер и способ поиска определяются на основе всех переданных условий поиска и различных настроек.
  
CategoryMode

Режим выдачи категорий в результатах поиска.

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

  • Nothing — Отсутствие выдачи категорий (если они не нужны)
  • External — Выдача внешних категорий как есть, без приведения к внутренним
  • InternalLeaf — Приведение внешних категорий к внутренним конечным (в любом месте каталога)
  • CurrentLevel — Приведение внешних категорий к внутренним категориям текущего уровня. Если поиск не по категории, то к корневым. Если поиск по категории, то к тем что внутри неё. Тем самым уточняющие категории никогда не выходят за рамки текущего уровня просмотра каталога.
  
IsClearItemTitles

Признак очистки заголовков товаров

  

.

По умолчанию true, то есть поиск выдает только оригинальные не-переведенные названия товаров, т.к. в большинстве случаев названия не показываются в списке товаров, то данное поведение сильно экономит ресурсы транслятора и немного ускоряет получение результатов поиска.

При значении false, в каждом товаре также выдается и переведенное название.

  
  Устаревшие условияIsOriginalПризнак выбора только оригинальных товаров  
IsTmallПризнак выбора только товаров из Tmall  

Поиск по всем товарным провайдерам

Кроме того, если у вас к ключу подключено сразу несколько товарных провайдеров, есть вариант поиска сразу для всех товарных провайдеров и всех возможных условиях поиска. Для этого необходимо воспользоваться специальным поиском по OT API. Описание метода: BatchSearchItemsFrame

 

...

Примеры параметров с условиями поиска и запросов поиска

...тут надо примеры

Описание результатов поиска

...тут надо описание для OtapiItemSearchResult 

Дополнительные блоки информации в BatchSearchItemsFrame

Используя метод BatchSearchItemsFrame, можно получить дополнительную информацию за тот же один запрос к OTAPI. Список дополнительных блоков передается в параметре blockList, через запятую. Результатом является BatchItemSearchResult, который включает в себя обычный OtapiItemSearchResult, а также все свойства для дополнительной информации.

Название блокаОписание