Настройки ставок

Описание

GET /campaigns/{campaignId}/bids/settings

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

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

<response>
  <settings autobroker-enabled="{boolean}" bids-from="{enum}" offer-id-by="{enum}">
    <book_bids bid="{integer}" cbid="{integer}"/>
    <shop_bids bid="{integer}" cbid="{integer}"/>
  </settings>
</response> 

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

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

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

Тип

Значение

response

Ответ.

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

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

settings settings

Настройки ставок.

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

autobroker-enabled autobrokerEnabled Boolean

Признак использования автоброкера:

  • false — автоброкер выключен.

  • true — автоброкер включен.

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

bids-from bidsFrom Enum

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

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

  • DISABLED — ставки выключены.

  • PRICE_LIST — ставки указаны в прайс-листе.

  • UI_OR_API — ставки указаны в личном кабинете или передаются с помощью партнерского API.

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

offer-id-by offerIdBy Enum

Тип идентификации товаров.

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

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

book_bids bookBids

Ставки на книги по умолчанию.

shop_bids shopBids

Ставки по умолчанию.

Параметры, вложенные в book_bids / bookBids

bid bid Integer

Размер общей ставки по умолчанию на книги, в условных центах.

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

cbid cbid Integer

Размер ставки по умолчанию на карточках книг, в условных центах.

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

Параметры, вложенные в shop_bids / shopBids

bid bid Integer

Размер общей ставки по умолчанию, в условных центах.

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

cbid cbid Integer

Размер ставки по умолчанию на карточке модели, в условных центах.

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

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

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

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

Описание

Пояснение

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

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

Проверьте корректность идентификатора магазина.

Примеры

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

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

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

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

<response> 
  <settings autobroker-enabled="true" bids-from="UI_OR_API" offer-id-by="OFFER_ID">
    <book_bids bid="10" cbid="20"/>
    <shop_bids bid="10" cbid="20"/>
  <settings/>
</response>