Рекомендации для поиска Яндекса

Внимание. Запрос устарел и прекратит работу с 30 октября 2018 года. Чтобы получить рекомендации ставок для поиска Яндекса, используйте запрос POST /campaigns/{campaignId/auction/recommendations/bids.
  1. Описание
  2. Входные данные
  3. Выходные данные
  4. Описание ошибок
  5. Ограничения
  6. Примеры

Описание

POST /campaigns/{campaignId}/bids/recommended

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

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

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

target

Enum

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

  • SEARCH — ставка для размещения в блоке предложений Яндекс.Маркета в поиске Яндекса.

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

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

positions

String

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

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

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

Структура тела 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 и / или размер комиссии fee.

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

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

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

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

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

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

<response>
  <recommendations>
    <offer bid="{double}" cbid="{double}" dont-pull-up-bids="{boolean}" error="{enum}" feed-id="{int64}" min-bid="{double}" min-cbid="{double}" offer-id="{string}">
      <name>{string}</name>
      <search>
        <position pos="{string}" bid="{double}" error="{enum}"/>
        ...
      </search>
    </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.

dont-pull-up-bids dontPullUpBids Boolean

Автоматическое повышение ставок bid и cbid до минимальных:

  • true — отключено. Будут действовать установленные магазином ставки.
    Примечание. Если ставки bid и cbid установлены ниже минимальных, предложение не будет показываться.
  • false — включено. Если установлена ставка ниже минимальной, Яндекс.Маркет автоматически поднимет ее до минимальной.

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

error error Enum

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

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

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

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

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

  • STOP_QUERY — указанная в запросе позиция недостижима, так как используется стоп-запрос (по этому запросу предложения из Яндекс.Маркета не показываются в поиске Яндекса).

Для формата 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.

name offerName String

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

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

search search

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

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

position posRecommendations

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

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

pos String

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

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

bid bid Double

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

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

error error Enum

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

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

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

  • OFFER_BAD_CATEGORY — указанная в запросе позиция недостижима, так как предложение относится к категории товаров Яндекс.Маркета, которые не показываются в результатах поиска Яндекса (например, товары категории «Ножи»).

  • OFFER_LOW_CTR — указанная в запросе позиция недостижима из-за низкого CTR предложения (по данному предложению недостаточно переходов по отношению к показам).

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

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

Для формата 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'

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

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

Ограничения

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

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

Примечание.

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

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

Примеры

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

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

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

-d '<offers>
  <offer feed-id=383610 name="Часы Casio SHE-3800SG-7A (серебристый)" query="Часы Casio SHE-3800SG-7A (серебристый)"/>
</offers>'

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

HTTP/1.1 200 OK
Date: Wed, 14 Jun 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <recommendations>
    <offer bid="5.00" cbid="1.10" min-bid="0.32" min-cbid="0.09">
      <name>Часы Casio SHE-3800SG-7A (серебристый)</name>
      <search>
        <position pos="1" bid="55.01"/>
        <position pos="5" bid="0.36"/>
      </search>
    </offer>
  </recommendations>
</response>