Рекомендации для поиска Яндекс.Маркета

Описание

POST /campaigns/{campaignId}/bids/recommended

Возвращает рекомендованные значения ставок на предложения для размещения среди первых 12 предложений магазинов в поиске Яндекс.Маркета. Рекомендации по ставкам рассчитываются для региона, в котором находится магазин.

Внимание.

Возвращаемые ставки являются прогнозируемыми и не гарантируют попадание предложения на указанное место размещения.

Передача списка предложений, для которых надо получить рекомендации, осуществляется в теле POST-запроса. Действует ограничение на количество предложений в одном запросе: 500 предложений.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/bids/recommended.[format]

Входные данные

Параметр

Тип

Значение

Обязательные

campaignId

Int64

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

target

Enum

Тип ставки или комиссии, для которой устанавливается рекомендованное значение:

  • MARKET-SEARCH — ставка для размещения среди первых 12 предложений магазинов в поиске Яндекс.Маркета.

Примечание. Можно одновременно получить рекомендации для размещения в поиске Яндекс.Маркета и поиске Яндекса, если во входных данных указать сочетание значений параметра target: target=MARKET-SEARCH&target=SEARCH.

Необязательные

positions

String

Список номеров позиций в поиске Яндекс.Маркета, для которых необходимо получить рекомендации ставок. Номера позиций указываются через запятую.

Допустимые значения: от 1 до 12.

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

Структура тела POST-запроса:

<offers>
  <offer feed-id="{int64}" id="{string}" name="{string}" query="{string}"/>
  ...
</offers>

В теле POST-запроса передаются следующие параметры:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

offers offers

Список предложений.

Параметры, вложенные в offers

offer

Предложение.

Параметры, вложенные в offer / offers

feed-id feedId Int64

Идентификатор прайс-листа, содержащего предложение.

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

Для формата XML является атрибутом параметра offer.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

id id String

Идентификатор предложения из прайс-листа.

Укажите параметр id, если вы используете тип идентификации товаров по идентификатору предложения.

Взаимоисключающий с параметром name.

Для формата XML является атрибутом параметра offer.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

name name String

Название предложения.

Укажите параметр name, если вы используете тип идентификации товаров по названию предложения.

Взаимоисключающий с параметром id.

Максимальная длина: 512 символов.

Для формата XML является атрибутом параметра offer.

query query String

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

Минимальная длина: 2 символа.

Максимальная длина: 2000 символов.

Обязательный параметр.

Получить список запросов, популярных в поиске Яндекс.Маркета и рекомендованных для предложения, можно с помощью ресурса POST /campaigns/{campaignId}/bids/recommended/top/market-search.

Для формата XML является атрибутом параметра offer.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <recommendations>
    <offer bid="{double}" cbid="{double}" error="{enum}" feed-id="{int64}" min-bid="{double}" min-cbid="{double}" offer-id="{string}">
      <market-search current-pos-all="{int32}" model-count="{int32}">
        <position pos="{string}" bid="{double}" error="{enum}"/>
        ...
      </market-search>
      <name>{string}</name>
    </offer>
    ...
  </recommendations>
</response>

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

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

recommendations recommendations

Список рекомендаций.

Параметры, вложенные в recommendations

offer

Рекомендация ставок для предложения.

Параметр выводится только для формата XML.

Параметры, вложенные в offer / recommendations

bid bid Double

Примененная общая ставка, в условных единицах.

Для формата XML является атрибутом параметра offer.

cbid cbid Double

Примененная ставка для карточки модели Яндекс.Маркета, в условных единицах.

Для формата XML является атрибутом параметра offer.

error error Enum

Описание произошедшей ошибки. Параметр выводится только в случае возникновения ошибки.

Возможные значения:

  • OFFER_NOT_FOUND — предложение не опубликовано.

  • OFFER_NOT_MATCHED — предложение не соотнесено с карточкой модели Яндекс.Маркета.

  • SEARCH_TIMEOUT — по техническим причинам рекомендации для данного предложения временно недоступны.

Для формата XML является атрибутом параметра offer.

feed-id feedId Int64

Идентификатор прайс-листа, содержащего предложение.

Параметр выводится при получении информации о ставке, если вы используете тип идентификации товаров по идентификатору предложения.

Для формата XML является атрибутом параметра offer.

min-bid minBid Double

Минимальный размер применяемой общей ставки для данного предложения в поиске Яндекс.Маркета.

Для формата XML является атрибутом параметра offer.

min-cbid minCbid Double

Минимальный размер применяемой ставки для данного предложения на соответствующей карточке модели Яндекс.Маркета.

Для формата XML является атрибутом параметра offer.

offer-id offerId String

Идентификатор предложения из прайс-листа.

Параметр выводится при получении информации о ставке, если вы используете тип идентификации товаров по идентификатору предложения.

Взаимоисключающий с параметром offer-name.

Для формата XML является атрибутом параметра offer.

market-search marketSearch

Рекомендация ставки для размещения среди первых 12 предложений магазинов в поиске Яндекс.Маркета.

Внимание.

При выставлении ставки согласно данной рекомендации высокая позиция предложения в поиске Яндекс.Маркета не всегда достижима. В первую очередь на позицию предложения в поиске Яндекс.Маркета влияет релевантность предложения запросу пользователя.

name offerName String

Название предложения.

Параметр выводится при получении информации о ставке, если вы используете тип идентификации товаров по названию предложения.

Параметры, вложенные в market-search / marketSearch

current-pos-all currentPosAll Int32

Позиция в блоке предложений магазинов в поиске Яндекс.Маркета. Блок с предложениями магазинов расположен после блока с карточками моделей. Если параметр не выдается или имеет значение 0 — предложение не попало в число первых 12 из-за низкой релевантности запросу пользователя.

Для формата XML является атрибутом параметра market-search.

model-count modelCount Int32

Количество позиций в поиске Яндекс.Маркета, занятых карточками моделей. Блок с карточками расположен над блоком с предложениями магазинов.

Например, если по запросу нашлось три карточки модели, предложение сможет занять в поиске Яндекс.Маркета позицию, начиная с четвертой. Однако, это будет первая позиция в блоке с предложениями магазинов.

Для формата XML является атрибутом параметра market-search.

position posRecommendations

Рекомендация ставки для предложения магазина для размещения в поиске Яндекс.Маркета. Рекомендации выводятся для первых 12 позиций.

Параметры, вложенные в position / posRecommendations

pos String

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

Параметр выводится только для формата XML и является атрибутом параметра position. Для формата JSON выводится номер позиции в виде числа.

bid bid Double

Рекомендованная общая ставка для достижения указанной позиции на поиске Яндекс.Маркета, в условных единицах.

Для формата XML является атрибутом параметра position.

error error Enum

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

Возможные значения:

  • BID_UPPER_LIMIT — указанная в запросе позиция недостижима из-за выставления конкурентом максимальной ставки.

  • OFFER_NOT_DELIVERED — указанная в запросе позиция недостижима из-за того, что предложение не доставляется в регион.

  • UNKNOWN — указанная в запросе позиция недостижима по неизвестной причине. Обратитесь в службу поддержки.

  • UNREACHABLE — указанная в запросе позиция недостижима, так как предложение магазина имеет низкую релевантность поисковому запросу пользователя.

Для формата XML является атрибутом параметра position.

Описание ошибок

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 206 Partial Content

Запрос выполнен частично. По техническим причинам рекомендации для части предложений временно недоступны.

Выполните повторный запрос по тем предложениям offer, у которых error=SEARCH_TIMEOUT.

Ошибка 400 Bad Request

Current offer identification type is: 'idType'

Идентификация ставок не соответствует установленному режиму.

Идентифицируйте ставки в соответствии с установленным режимом. При необходимости смените режим идентификации в личном кабинете.

Either offer-id or offer-name should be specified

В теле запроса указаны взаимоисключающие параметры id и name.

Укажите в теле запроса только один из параметров: id или name.

Укажите параметр id, если вы используете тип идентификации товаров по идентификатору предложения.

Укажите параметр name, если вы выбрали тип идентификации товаров по названию предложения.

Feed should be specified

Не указан идентификатор прайс-листа, являющийся обязательным параметром, если у магазина зарегистрировано более одного прайс-листа и выбран режим получения информации о ставках по идентификатору предложения.

Проверьте корректность передаваемых в запросе данных.

Invalid position number: 'position'

Номер позиции, указанный в запросе, не число.

Проверьте корректность указанных в запросе позиций.

Offer name should not be empty

Название предложения, переданное в теле запроса, не должно быть пустым.

Проверьте корректность передаваемых в запросе данных.

Offer name should be 512 characters at most

Название предложения, переданное в теле запроса, не должно быть длиннее 512 символов.

Проверьте корректность передаваемых в запросе данных.

Position number should be in 'availablePositions': 'position'

Номер позиции должен быть из списка допустимых значений availablePositions.

Проверьте корректность указанных в запросе позиций.

Position number should be positive and not greater than 'maxPosition': 'position'

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

Проверьте корректность указанных в запросе позиций.

Query should be specified

Для каждого предложения должен быть указан поисковой запрос query.

Укажите поисковой запрос.

Search query should have 2 characters at least and 2000 at most

Длина поискового запроса query должна быть от 2 до 2000 символов включительно.

Проверьте корректность передаваемых в запросе данных.

Too many offers: 'offersCount'

В запросе указано количество предложений, превышающее максимальное количество: 500.

Уменьшите количество передаваемых предложений.

Too many positions specified

Количество позиций в параметре positions, превышает максимальное количество позиций.

Уменьшите количество позиций в параметре positions.

Ошибка 403 Forbidden

Auction is not allowed for campaign 'campaignId'. Reason: 'reason'

Установка или удаление ставок для магазина campaignId невозможно по причине reason.

Возможные причины:

  • FIXED_TARIFF — тип размещения магазина «Старт». Управление ставками для магазинов с типом размещения «Старт» недоступно.

  • OFFLINE_SHOP — розничный магазин. Управление ставками для розничных магазинов недоступно.

Управление ставками недоступно.

Ошибка 404 Not Found

Feed not found: 'feedId'

В path-параметре feedId передан некорректный идентификатор прайс-листа.

Проверьте корректность данных в запросе.

Ограничения

Для методов POST /campaigns/{campaignId}/bids/recommended, POST /campaigns/{campaignId}/bids/recommended/top/market-search и PUT /campaigns/{campaignId}/bids действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество предложений, по которым при помощи этих методов выставлены ставки или получены рекомендации.

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

  • количество предложений на карточках моделей Яндекс.Маркета.

Примечание.

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0. При размещении предложений этими магазинами ограничение пересчитывается только на следующий день.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml'-X POST 'https://api.partner.market.yandex.ru/v2/campaigns/10001/bids/recommended.xml?target=MARKET-SEARCH'

Тело POST-запроса:

-d '<offers>
  <offer feed-id="383610" id="1234" query="Часы Casio SHE-3800SG-7A"/>
</offers>'

Пример ответа:

HTTP/1.1 200 OK
Date: Thu, 30 Nov 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <recommendations>
    <offer bid="0.34" cbid="0.01" feed-id="383610" min-bid="0.27" min-cbid="0.01" offer-id="1234">
      <market-search current-pos-all="2" model-count="0">
        <position pos="1" error="UNREACHABLE"/>
        <position pos="2" bid="0.27"/>
        <position pos="3" bid="0.27"/>
        <position pos="4" bid="0.27"/>
        <position pos="5" bid="0.27"/>
        <position pos="6" bid="0.27"/>
        <position pos="7" bid="0.27"/>
        <position pos="8" bid="0.27"/>
        <position pos="9" bid="0.27"/>
        <position pos="10" bid="0.27"/>
        <position pos="11" bid="0.27"/>
        <position pos="12" bid="0.27"/>
      </market-search>
    </offer>
  </recommendations>
</response>