Установка ставок на предложения

Описание

PUT /campaigns/{campaignId}/auction/bids

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

Внимание. Для использования этого запроса необходимо, чтобы в личном кабинете в качестве источника информации о ставках был выбран личный кабинет и API.

Значения ставок передаются в теле PUT-запроса.

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

<set-bids-request>
  <bids>
    <bid feed-id="{int64}" offer-id="{string}" offer-name="{string}" bid="{double}" dont-pull-up-bids="{boolean}"/>
    ...
  </bids>
</set-bids-request>

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

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

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

Тип

Значение

set-bids-request

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

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

bids

Список ставок.

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

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

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

Общая ставка, в условных единицах. Для отделения целой части от дробной используется точка.

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

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

Обязательно указать хотя бы один из параметров bid и dont-pull-up-bids.

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

dont-pull-up-bids dontPullUpBids Boolean

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

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

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

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

Обязательно указать хотя бы один из параметров bid и dont-pull-up-bids.

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

Внимание.

Ставки на Яндекс.Маркете обновляются:

Поэтому, в зависимости от типа идентификации, не имеет смысла изменять значения ставок чаще, чем раз в 3–6 часов либо раз в 30 минут соответственно.

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

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

<response>
  <status>{enum}</status>
  <result>
    <bids-set>
      <bid feed-id="{int64}" offer-id="{string}" offer-name="{string}" bid="{double}" dont-pull-up-bids="{boolean}" error="{enum}"/>
      ...
    </bids-set>
  </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-set bidsSet

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

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

bid

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

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

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

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.

error error Enum

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

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

  • INVALID_BID_VALUE — указано некорректное значение ставки.

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

  • UNKNOWN — неизвестная ошибка.

Для формата 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 offer bids are not allowed: 'offerName'

Среди данных, переданных в теле запроса, встречается одно и то же предложение более одного раза.

Проверьте передаваемые в запросе данные на наличие повторяющихся предложений.

Either offer-id or offer-name should be specified

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

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

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

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

Either one type of bid should be specified

Для каждого предложения, переданного в теле запроса, должен быть указан хотя бы один из параметров bid и dont-pull-up-bids.

Укажите для каждого предложения хотя бы один из параметров bid и dont-pull-up-bids.

Feed should be specified

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

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

Offer name should not be empty

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

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

Too many bids: 'bidsCount'

В запросе указано количество ставок превышающее максимальное количество: 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 предложений.

Для запросов 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 действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество предложений, по которым при помощи этих методов выставлены ставки или получены рекомендации.

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

Примечание.

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

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

Примеры

Запрос для установки ставок по идентификатору предложения:

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

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

-d '<set-bids-request>
  <bids>
    <bid feed-id="30919" offer-id="239982" bid="0.22"/>
    <bid feed-id="30919" offer-id="239983" bid="0.22"/>
    <bid feed-id="30919" offer-id="239984" bid="0.22"/>
  </bids>
</set-bids-request>'

Ответ:

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

<response>
  <status>OK</status>
  <result>
    <bids-set>
      <bid feed-id="30919" offer-id="239982" bid="0.22"/>
      <bid feed-id="30919" offer-id="239983" bid="0.22"/>
      <bid feed-id="30919" offer-id="239984" error="OFFER_NOT_FOUND"/>
    </bids-set>
  </result>
</response>