Скрытие предложений и настройки скрытия

Описание

POST /campaigns/{campaignId}/hidden-offers

Метод позволяет:

  1. Скрыть предложения магазина на Маркете на указанное время. В теле запроса можно передать от одного до 500 предложений.

  2. Установить приоритет скрытия через API над скрытием в личном кабинете.

    Для этого передайте в теле запроса параметр priority="true".

    Возобновить показ в этом случае можно только с помощью запроса DELETE /campaigns/{campaignId}/hidden-offers.

  3. Для скрытий, установленных с приоритетом, можно изменить время скрытия и комментарии.

    Чтобы внести изменения, передайте в теле запроса идентификатор уже скрытого предложения, идентификатор его прайс-листа и новые значения параметров comment и / или ttlInHours. При этом предыдущие значения этих параметров будут удалены.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/hidden-offers.json

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

Параметр

Тип

Значение

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

campaignId

Int64

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

Чтобы узнать идентификатор, откройте сводку бизнеса «Рекламное продвижение», наведите указатель на название магазина и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-12345678», то идентификатор кампании — 12345678.

Параметр

Тип

Значение

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

campaignId

Int64

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

Чтобы узнать идентификатор, откройте сводку бизнеса «Рекламное продвижение», наведите указатель на название магазина и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-12345678», то идентификатор кампании — 12345678.

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

{
  "hiddenOffers":
  [
    {
      "feedId": {int64},
      "offerId": "{string}",
      "priority": "{boolean}",
      "ttlInHours": {int32},
      "comment": "{string}"
    },
    ...
  ]
}

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

Параметр

Тип

Значение

hiddenOffers

Список предложений, которые нужно скрыть.

В теле запроса можно передать от одного до 500 предложений.

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

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

feedId Int64

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

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

offerId

String

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

Максимальная длина — 50 символов.

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

priority

Boolean

Приоритет скрытия предложений через API над скрытием в личном кабинете.

Параметр принимает только значение true.

comment String

Комментарий магазина.

Максимальная длина комментария — 100 символов.

Используется только совместно с параметром priority="true". Если скрытие было без приоритета, комментарий не вернется в ответе.

ttlInHours Int32

Количество часов до возобновления показа предложения.

Минимальное значение: 1.

Максимальное значение: 720.

Значение по умолчанию: 48.

Используется только совместно с параметром priority="true".

Параметр

Тип

Значение

hiddenOffers

Список предложений, которые нужно скрыть.

В теле запроса можно передать от одного до 500 предложений.

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

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

feedId Int64

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

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

offerId

String

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

Максимальная длина — 50 символов.

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

priority

Boolean

Приоритет скрытия предложений через API над скрытием в личном кабинете.

Параметр принимает только значение true.

comment String

Комментарий магазина.

Максимальная длина комментария — 100 символов.

Используется только совместно с параметром priority="true". Если скрытие было без приоритета, комментарий не вернется в ответе.

ttlInHours Int32

Количество часов до возобновления показа предложения.

Минимальное значение: 1.

Максимальное значение: 720.

Значение по умолчанию: 48.

Используется только совместно с параметром priority="true".

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

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

{
  "errors":
  [
    {
      "code": "{enum}",
      "message": "{string}"
    },
    ...
  ],
  "status": "{enum}"
}

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

Параметр

Тип

Значение

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

errors

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

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

status Enum

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

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

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

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

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

code Enum

Код ошибки.

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

  • DUPLICATE_OFFER — в теле запроса передано два или более предложения с одинаковыми значениями параметров offer-id / offerId.

  • INVALID_COMMENT — в теле запроса в параметре comment передано больше 100 символов.

  • INVALID_FEED_ID — в теле запроса в параметре feed-id / feedId передан идентификатор прайс-листа, который не существует или не относится к магазину campaignId.

  • INVALID_OFFER_ID — в теле запроса в параметре offer-id / offerId передан пустой идентификатор предложения или его длина превышает 50 символов.

  • INVALID_TTL — в теле запроса в параметре ttl-in-hours / ttlInHours передано больше 720 часов.

  • LIMIT_EXCEEDED — превышен индивидуальный лимит скрытий предложений.

  • REQUEST_LIMIT_EXCEEDED — в теле запроса в параметре hidden-offers / hiddenOffers передано больше 500 предложений.

message String

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

Параметр

Тип

Значение

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

errors

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

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

status Enum

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

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

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

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

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

code Enum

Код ошибки.

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

  • DUPLICATE_OFFER — в теле запроса передано два или более предложения с одинаковыми значениями параметров offer-id / offerId.

  • INVALID_COMMENT — в теле запроса в параметре comment передано больше 100 символов.

  • INVALID_FEED_ID — в теле запроса в параметре feed-id / feedId передан идентификатор прайс-листа, который не существует или не относится к магазину campaignId.

  • INVALID_OFFER_ID — в теле запроса в параметре offer-id / offerId передан пустой идентификатор предложения или его длина превышает 50 символов.

  • INVALID_TTL — в теле запроса в параметре ttl-in-hours / ttlInHours передано больше 720 часов.

  • LIMIT_EXCEEDED — превышен индивидуальный лимит скрытий предложений.

  • REQUEST_LIMIT_EXCEEDED — в теле запроса в параметре hidden-offers / hiddenOffers передано больше 500 предложений.

message String

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

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

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

Ограничения

В одном запросе можно скрыть или изменить параметры скрытия не более чем 500 предложений.

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

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

Среднее количество предложений Доступное количество предложений в минуту
До 200 000 1000
От 200 000 до 2 000 000  Рассчитывается по формуле:
количество предложений, усредненное по дням за неделю (не включая сегодня) / 200
Больше 2 000 000  10 000
Среднее количество предложений Доступное количество предложений в минуту
До 200 000 1000
От 200 000 до 2 000 000  Рассчитывается по формуле:
количество предложений, усредненное по дням за неделю (не включая сегодня) / 200
Больше 2 000 000  10 000

Примеры

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

curl -i -H 'Content-Type: application/xml' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/12345/hidden-offers.json'

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

-d '{
  "hiddenOffers":
  [
    {
      "feedId": 67891,
      "offerId": "101Ab12313C",
      "priority": "true",
      "ttlInHours": 1,
      "comment": "До поставки новой партии товара"
    }
  ]
}'

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

HTTP/1.1 200 OK
Date: Sat, 12 Aug 2017 00:42:42 GMT
Content-Type: application/json;charset=utf-8
...

{
  "status": "OK"
}