Информация о ставках

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

Описание

POST /campaigns/{campaignId}/bids

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

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

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

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

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

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

Тип

Значение

offers offers

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

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

offer

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

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

Параметры, вложенные в 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.

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

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

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

<bids>
  <bid bid="{double}" cbid="{double}" dont-pull-up-bids="{boolean}" feed-id="{int64}" modified="{date}" offer-id="{string}" offer-name="{string}" status="{enum}"/>
  ...
</bids>

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

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

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

Тип

Значение

bids bids

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

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

bid

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

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

Параметры, вложенные в bid / bids

bid bid Double

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

Внимание.

Выводится размер ставки, который был передан магазином.

Если переданная магазином ставка выше максимально допустимого размера либо ниже минимально допустимого значения (и не передан параметр dont-pull-up-bids="true"), то применяется ставка, скорректированная системой до допустимого значения. В этом случае размер ставки, указанный в данном параметре, отличается от применяемого.

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

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

cbid cbid Double

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

Внимание.

Выводится размер ставки, который был передан магазином.

Если переданная магазином ставка выше максимально допустимого размера либо ниже минимально допустимого значения (и не передан параметр dont-pull-up-bids="true"), то применяется ставка, скорректированная системой до допустимого значения. В этом случае размер ставки, указанный в данном параметре, отличается от применяемого.

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

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

dont-pull-up-bids dontPullUpBids Boolean

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

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

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

feed-id feedId Int64

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

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

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

modified modified Date

Дата и время последнего изменения ставки в формате «ДД-ММ-ГГГГ ЧЧ:ММ:СС» .

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

offer-id offerId String

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

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

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

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

offer-name offerName String

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

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

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

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

status status Enum

Статус ставки или код произошедшей ошибки.

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

  • ERROR_INVALID_BID_VALUE — произошла ошибка, некорректное значение ставки.

  • ERROR_OFFER_NOT_FOUND — произошла ошибка, указанное в запросе предложение не опубликовано.

  • ERROR_UNKNOWN — произошла неизвестная ошибка, попробуйте вызвать метод через некоторое время, при повторении ошибки обратитесь в службу технической поддержки личного кабинета Яндекс.Маркета.

  • INDEXING — ставка применяется.

  • PUBLISHED — ставка опубликована.

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

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

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

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

Описание

Пояснение

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

Ошибка 400 Bad Request

Current offer identification type is: 'idType'

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

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

Duplicate offers are not allowed: 'offerName' / 'offerId'

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

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

Either offer-id or offer-name should be specified

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

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

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

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

Feed should be specified

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

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

Feed-id should be specified

Не указан идентификатор прайс-листа.

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

Offer name should not be empty

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

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

Too many offers: 'offersCount'

В запросе указано больше 500 предложений.

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

Ошибка 403 Forbidden

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

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

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

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

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

  • SOURCE_NOT_WEB — в личном кабинете в качестве источника информации о ставках указан источник, отличный от «Партнерский интерфейс и API».

При возникновении причины SOURCE_NOT_WEB укажите в личном кабинете в качестве источника информации о ставках вариант «Партнерский интерфейс и API». В остальных случаях управление ставками не доступно.

Ошибка 404 Not Found

Feed not found: 'feedId'

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

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

Ограничения

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

  • количество предложений.

Примечание.

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

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

Примеры

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

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

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

-d '<offers>
  <offer feed-id="31920" id="120"/>
  <offer feed-id="31920" id="121"/>
  <offer feed-id="31920" id="122"/>
</offers>'

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

HTTP/1.1 200 OK
Date: Sat, 19 Mar 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <bids>
    <bid bid="0.22" cbid="0.33" dont-pull-up-bids="false" feed-id="31920" modified="16-11-2012 12:31:47" offer-id="120" status="PUBLISHED"/>
    <bid bid="1.12" dont-pull-up-bids="false" feed-id="31920" modified="12-11-2012 16:49:05" offer-id="122" status="ERROR_OFFER_NOT_FOUND"/>
    <bid cbid="0.51" dont-pull-up-bids="false" feed-id="31920" modified="16-11-2012 20:01:38" offer-id="121" status="INDEXING"/>
  </bids>
</response>