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

Описание

POST /campaigns/{campaignId}/auction/bids

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

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

Параметры тела POST-запроса:

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

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

Тип

Значение

get-bids-request

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

Обязательный параметр, указывается только для формата XML.

offers

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

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

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

offers

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

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

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

offer

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

Обязательный параметр, указывается только для формата XML.

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

feed-id feedId Int64

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

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

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

offer-id offerId String

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

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

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

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

offer-name offerName String

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

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

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

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

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

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

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

<response>
  <status>{enum}</status>
  <result>
    <bids>
      <bid feed-id="{int64}" offer-id="{string}" offer-name="{string}" bid="{double}" dont-pull-up-bids="{boolean}" status="{enum}" modified="{date}"/>
      ...
    </bids>
  </result>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

status status Enum

Статус выполнения запроса.

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

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

result result

Результат выполнения запроса.

Выводится, если status="OK".

errors errors

Список ошибок при выполнении запроса.

Выводится, если status="ERROR".

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

bids bids

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

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

bid

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

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

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

feed-id feedId Int64

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

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

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

offer-id offerId String

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

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

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

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

offer-name offerName String

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

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

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

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

bid bid Double

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

Внимание.

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

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

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

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

dont-pull-up-bids dontPullUpBids Boolean

Запрет на автоматическое повышение ставки bid до минимальной:

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

Подробнее см. в разделе Минимальная стоимость клика Помощи Яндекс.Маркета.

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

status status Enum

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

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

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

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

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

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

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

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

modified modified Date

Дата и время последнего изменения ставки.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

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

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

error

Информация об ошибке.

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

Параметры, вложенные в error / errors

code code Enum

Код ошибки.

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

message message String

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

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

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

В случае ошибки сервер возвращает 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

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

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

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

Укажите параметр offer-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: SOURCE_NOT_WEB

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

Укажите в личном кабинете в качестве источника информации о ставках вариант «Партнерский интерфейс и API».

Ошибка 404 Not Found

Feed not found: 'feedId'

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

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

Ограничения

В одном запросе можно получить информацию не более чем о 500 предложениях.

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

Примечание.

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

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

Примеры

Запрос:

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

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

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

Ответ:

HTTP/1.1 200 OK
Date: Wed, 19 Dec 2018 10:51:32 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <status>OK</status>
  <result>
    <bids>
      <bid feed-id="31920" offer-id="120" bid="0.22" dont-pull-up-bids="false" status="PUBLISHED" modified="2018-12-11T14:28:00+03:00"/>
      <bid feed-id="31920" offer-id="122" status="ERROR_OFFER_NOT_FOUND"/>
      <bid feed-id="31920" offer-id="121" bid="0.51" dont-pull-up-bids="false" status="INDEXING" modified="2018-12-19T10:33:27+03:00"/>
    </bids>
  </result>
</response>