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

Ключ

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

...

Search conditions are also identical. They are sent into xmlParameters and presented by structure OtapiSearchItemsParameters. It has xml format (like other structure parameters). Examples will be described below. 

В следующей таблице представлено сравнительное описание условий поиска, как они представлены в структуре параметров, и как они представлены в описании способов поиска.

The following table provides a comparative description of search methods as they appear in parameters structure and how they are presented in search methods description.

 

Parameter

Search methodsSearch method information
Parameter nameValue exampleParameter desription

Parameter title

Value exampleParameter desription
Provider

Параметр

Условия поискаИнформация о способе поискаНазвание параметраПример значенияОписание параметра

Название параметра

Пример значенияОписание параметраПровайдер
ProviderTaobao

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

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

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

 

 

SearchMethodOfficialЕсли не указано, используется определенный в настройках способ поиска по умолчанию.SearchMethodOfficialНазвание способа поиска
DisplayNameФирменные товары (Tmall)Отображаемое название способа поиска (на нужном языке)
Flags Список особенностей способа поиска
Ограничения на число товаров
Goods quantity limitationsUseOptimalFrameSizetrue/false

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

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

   
   OptimalFrameSize40

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

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

   MaximumFrameSize200Максимальное число товаров, которое можно получить за 1 запрос. Может работать значительно медленнее, чем при использовании оптимального числа.
   MaximumItemsCount4000Число товаров, до которого в принципе можно получить по одним и тем же условиям поиска. Чтобы получать больше товаров, надо менять и уточнять условия поиска.
Сортировка товаров
Goods orderOrderByPrice:AscЕсли не указано, или указанное значение не входит в число допустимых, будет использована определенная в настройках сортировка по умолчанию.AvailableSorts Список допустимых сортировок в способе поиска.
Категория

Category

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

Item title

ItemTitle

платье

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

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

   
LanguageOfQueryru

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

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

   
Продавец

Vendor

VendorId Идентификатор продавцаVendortrue/falseПоддерживается ли поиск по продавцу
VendorName Имя продавца
Местонахождение продавца

Vendor area

VendorAreaId Идентификатор местонахождения продавца (зоны)VendorLocationtrue/falseПоддерживает ли способ поиска местонахождение продавца
Рейтинг продавца

Vendor rating

 
   VendorRatingRangetrue/falseПоддерживает ли способ поиска фильтр по рейтингу продавца
MinVendorRating5Минимальное значение рейтинга продавцаMinVendorRating1Минимальное значение рейтинга продавца
MaxVendorRating15Максимальное значение рейтинга продавцаMaxVendorRating20Максимальное значение рейтинга продавца
Бренд
BrandBrandId Идентификатор искомой торговой марки
Brand
true/falseПоддерживает ли способ поиска бренды
BrandPropertyValueId Идентификатор значения искомой торговой марки (устаревший параметр, используйте BrandId)
Цена
PriceMinPrice10Минимальная ценаPriceRangetrue/false

 

Поддерживает ли способ поиска фильтр по цене товара
MaxPrice1000Максимальная цена
CurrencyCodeCNY

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

Объем продаж

Sales volume

MinVolume100Минимальный объем продажVolumeRange true/falseПоддерживает ли способ поиска фильтр по объему продаж 
MaxVolume500Максимальный объем продаж
   VolumeRangeLogicNone / Range / OnlyMin / OnlyMaxЛогика работы условий по объему продаж: диапазон, только минимум, только максимум.
Состояние товара
Item status (
новый, б/у, неиспользованый
new, second-hand, unused)StuffStatusNew / Unused / SecondСостояние товараStuffStatustrue/falseПоддерживает ли способ поиска фильтр по состоянию товара
Характеристики товара (цвет, модель и тд

Item configurations (color, model, etc.)

Configurators 

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

Configuratorstrue/false

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

MultipleConfiguratorLogicNone / All / And

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

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

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

 

Особенности товара
Item featuresFeatures 

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

Features

 

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

Управление выдачей
Output modeOutputModeFull / TotalCount / Provider

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

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

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

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

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

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

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

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

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

   
Устаревшие условия
Old conditionsIsOriginaltrue/falseПризнак выбора только оригинальных товаров   
IsTmalltrue/falseПризнак выбора только товаров из Tmall   

 

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

...

Название блокаОписание
SubCategoriesсразу получить подкатегории, если поиск был по категории
SearchPropertiesсразу получить фильтры по характеристикам/свойствам
RootPath сразу получить путь к корню, если поиск был по категории
Vendorсразу получить информацию о продавце, если поиск был по продавцу
Brandсразу получить информацию о бренде, если поиск был по бренду
Categoryсразу получить информацию о категории, если поиск был по категории
HintCategoriesсразу получить подходящие по названию категории, если поиск был по тексту
get all subcategories if search by category
SearchPropertiesget filters by characteristics/properties
RootPath get path to root if search by category
Vendorget information on seller if search by seller
Brandget information on brand if search by brand
Categoryget information on category of search by category
HintCategoriesget appropriate categories for title if search by text
AvailableSearchMethodsget list of appropriate matching data for search methods parameters and all information on themAvailableSearchMethodsсразу получить список подходящих под данные параметры способов поиска, и всю информацию по ним