API docs by Redocly

Маркетинг и продвижение (promotion)

Управление кампаниями, настройки ставок, учёт финансовых данных и настройки автоматических и медиа кампаний.

Синхронизация данных из базы данных происходит раз в 3 минуты. Изменение статуса происходит раз в 1 минуту. Изменение ставки происходит раз в 30 секунд. Внутри интервалов сохраняются последние изменения

Маркетинг и продвижение

Управление кампаниями, настройки ставок, учёт финансовых данных и настройки автоматических и медиа кампаний.

Синхронизация данных из базы данных происходит раз в 3 минуты. Изменение статуса происходит раз в 1 минуту. Изменение ставки происходит раз в 30 секунд. Внутри интервалов сохраняются последние изменения

Календарь акций

Для доступа к методам используйте токен для категории Цены и скидки
С помощью этих методов можно получать информацию об акциях и принимать в них участие.

Список акций{{ /api/v1/calendar/promotions }}

Описание метода

Возвращает список акций с датами и временем проведения

Максимум 10 запросов за 6 секунд для всех методов категории Календарь акций на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
startDateTime
required
string <RFC3339>
Example: startDateTime=2023-09-01T00:00:00Z

Начало периода, формат YYYY-MM-DDTHH:MM:SSZ

endDateTime
required
string <RFC3339>
Example: endDateTime=2024-08-01T23:59:59Z

Конец периода, формат YYYY-MM-DDTHH:MM:SSZ

allPromo
required
boolean
Default: false

Показать акции:

  • false — доступные для участия
  • true — все акции
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых акций

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Детальная информация по акциям{{ /api/v1/calendar/promotions/details }}

Описание метода

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

Максимум 10 запросов за 6 секунд для всех методов категории Календарь акций на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
promotionIDs
required
string [ 1 .. 100 ] items unique
Example: promotionIDs=1&promotionIDs=3&promotionIDs=64

ID акций, по которым нужно вернуть информацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Список товаров для участия в акции{{ /api/v1/calendar/promotions/nomenclatures }}

Описание метода

Возвращает список товаров, подходящих для участия в акции.

Неприменимо для автоакций

Максимум 10 запросов за 6 секунд для всех методов категории Календарь акций на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
promotionID
required
integer
Example: promotionID=1

ID акции

inAction
required
boolean
Default: false
Example: inAction=true

Участвует в акции:

  • true — да
  • false — нет
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых товаров

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Добавить товар в акцию{{ /api/v1/calendar/promotions/upload }}

Описание метода

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

Неприменимо для автоакций

Максимум 10 запросов за 6 секунд для всех методов категории Календарь акций на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Кампании

Для доступа к методам используйте токен для категории Продвижение

Списки кампаний{{ /adv/v1/promotion/count }}

Описание метода

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

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ],
  • "all": 3
}

Информация о кампаниях{{ /adv/v1/promotion/adverts }}

Описание метода

Возвращает получать информацию о кампаниях по query-параметрам либо по списку ID кампаний

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
status
integer
Enum: -1 4 7 8 9 11
Статус кампании:
-1 - кампания в процессе удаления
4 - готова к запуску
7 - кампания завершена
8 - отказался
9 - идут показы
11 - кампания на паузе
Кампания в процессе удаления. Статус означает, что кампания была удалена, и через 3-10 минут она исчезнет из ответа метода.
type
integer
Enum: 4 5 6 7 8 9
Тип кампании:
4 - кампания в каталоге (устаревший тип)
5 - кампания в карточке товара (устаревший тип)
6 - кампания в поиске (устаревший тип)
7 - кампания в рекомендациях на главной странице (устаревший тип)
8 - автоматическая кампания
9 - Аукцион
order
string
Enum: "create" "change" "id"
Порядок:
create (по времени создания кампании)
change (по времени последнего изменения кампании)
id (по ID кампании)
direction
string
Enum: "desc" "asc"
Направление:
desc (от большего к меньшему)
asc (от меньшего к большему)

Например: /adv/v1/promotion/adverts?type=6&order=change&direction=asc
Request Body schema: application/json
required
Array
integer

Список ID кампаний. Максимум 50.

Получить id кампаний можно методом Списки кампаний.

Responses

Request samples

Content type
application/json
[
  • 1234567,
  • 63453471
]

Response samples

Content type
application/json
Example
[
  • {
    }
]

Создание кампаний

Для доступа к методам используйте токен для категории Продвижение

Создать автоматическую кампанию{{ /adv/v1/save-ad }}

Описание метода

Создаёт автоматическую кампанию

Максимум 1 запрос в 20 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
type
integer
Тип автоматической кампании:
8
name
string

Название кампании (max. 128 символов)

subjectId
integer

ID предмета, для которого создается кампания.
Существующие у продавца ID можно получить методом из раздела "Контент / Просмотр" - "Список НМ", поле ответа - subjectID.

sum
integer

Сумма пополнения

btype
integer
Tип списания.
0 - Счёт
1 - Баланс
3 - Бонусы
on_pause
boolean
После создания кампания:
true - будет на паузе.
Запуск кампании будет доступен через 3 минуты после создания кампании.
false - будет сразу запущена
nms
Array of integers

Массив артикулов WB.
Максимум 100 артикулов.

cpm
integer

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

Responses

Request samples

Content type
application/json
{
  • "type": 8,
  • "name": "Парашюты",
  • "subjectId": 270,
  • "sum": 500,
  • "btype": 1,
  • "on_pause": true,
  • "nms": [
    ],
  • "cpm": 10
}

Response samples

Content type
text/plain
9008917

Создать кампанию Аукцион{{ /adv/v2/seacat/save-ad }}

Описание метода

Создаёт кампанию Аукцион

Максимум 5 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
campaignName
string

Название кампании

nms
Array of integers

Номенклатуры для кампании. Доступные номенклатуры можно получить с помощью метода Номенклатуры для кампаний. Максимум 50 товаров (nm)

Responses

Request samples

Content type
application/json
{
  • "name": "Телефоны",
  • "nms": [
    ]
}

Response samples

Content type
text/plain
Нет доступных категорий для рк. Создайте новую кампанию для попадания в текущие категории

Предметы для кампаний{{ /adv/v1/supplier/subjects }}

Описание метода

Возвращает предметы и номенклатуры, которые можно добавить в кампании

Максимум 1 запрос в 12 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Номенклатуры для кампаний{{ /adv/v2/supplier/nms }}

Описание метода

Возвращает номенклатуры, которые можно добавить в кампании

Максимум 5 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json

ID предметов, для которых нужно получить номенклатуры

Array
integer

Responses

Request samples

Content type
application/json
[
  • 123,
  • 456,
  • 765,
  • 321
]

Response samples

Content type
application/json
[
  • {
    }
]

Управление кампаниями

Для доступа к методам используйте токен для категории Продвижение

Изменение ставки у кампании{{ /adv/v0/cpm }}

Описание метода

Меняет ставку у кампании.
Изменённая ставка появится в информации о кампании в течение трёх минут.

Если размер ставки будет меньше допустимого, в ответе вы получите статус-код 422 — размер ставки не изменён.

При изменении ставки для кампании с типом 9 — Аукцион:

  1. Значение type всегда будет 9
  2. Значение instrument всегда будет 6 (устаревший тип кампании).
  3. Значение param всегда берётся из поля id структуры subject в информации о кампании.
Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertId
required
integer

ID кампании, где меняется ставка

type
required
integer
Enum: 5 6 7 8 9
кампании, где меняется ставка:
4 - кампания в каталоге (устаревший тип)
5 - кампания в карточке товара (устаревший тип)
6 - кампания в поиске (устаревший тип)
7 - кампания в рекомендациях на главной странице (устаревший тип)
8 - автоматическая кампания
9 - кампания Аукцион
cpm
required
integer

Новое значение ставки

param
required
integer

Параметр, для которого будет внесено изменение. Является значением subjectId (для кампании в поиске и рекомендациях (устаревшие типы кампаний)), setId (для кампании в карточке товара (устаревший тип кампании)) или menuId (для кампании в каталоге (устаревший тип кампании)).
Для автоматической кампании указывать этот параметр не требуется.

instrument
integer

тип кампании для изменения ставки в 4 - каталог (устаревший тип), 6 - поиск (устаревший тип)

Responses

Request samples

Content type
application/json
{
  • "advertId": 789,
  • "type": 5,
  • "cpm": 456,
  • "param": 23,
  • "instrument": 4
}

Response samples

Content type
text/plain
Example
Некорректное значение параметра param

Удаление кампании{{ /adv/v0/delete }}

Описание метода

Удаляет кампании в статусе 4 — готова к запуску.

После удаления кампания некоторое время будет находиться в статусе -1.

Полное удаление кампании занимает от 3 до 10 минут

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer

ID кампании

Responses

Response samples

Content type
application/json

Некорректный ID кампании

{
  • "error": "Некорректный ID кампании"
}

Переименование кампании{{ /adv/v0/rename }}

Описание метода

Меняет название кампании

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
advertId
required
integer

ID кампании, у которой меняется название

name
required
string

Новое название (максимум 100 символов)

Responses

Request samples

Content type
application/json
{
  • "advertId": 2233344,
  • "name": "newnmame"
}

Response samples

Content type
text/plain
Example
Некорректный ID РК

Запуск кампании{{ /adv/v0/start }}

Описание метода

Запускает кампании в статусах 4 — одобрено или 11 — пауза по расходу бюджета.

Чтобы запустить кампанию со статусом 4, необходимо выполнить два условия:

  1. После создания кампании в кабинете WB. Продвижение нажать кнопку Применить изменения.
  2. Установить бюджет.

Чтобы запустить кампанию со статусом 11, необходимо пополнить её бюджет

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
text/plain
Example
Некорректный ID РК

Пауза кампании{{ /adv/v0/pause }}

Описание метода

Ставит кампании в статусе 9 — идут показы — на паузу

Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
text/plain
Example
Некорректный ID РК

Завершение кампании{{ /adv/v0/stop }}

Описание метода

Завершает кампании статусах:

  • 4 — одобрено
  • 9 — приостановлена продавцом
  • 11 — пауза по расходу бюджета
Максимум 5 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
text/plain
Example
Некорректный ID РК

Финансы

Для доступа к методам используйте токен для категории Продвижение

Баланс{{ /adv/v1/balance }}

Описание метода

Возвращает информацию о счёте, балансе и бонусах продавца

Максимум 1 запрос в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "balance": 11083,
  • "net": 0,
  • "bonus": 15187
}

Бюджет кампании{{ /adv/v1/budget }}

Описание метода

Возвращает информацию о бюджете кампании

Максимум 4 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
{
  • "cash": 0,
  • "netting": 0,
  • "total": 500
}

Пополнение бюджета кампании{{ /adv/v1/budget/deposit }}

Описание метода

Пополняет бюджет кампании

Максимум 1 запрос в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
sum
integer

Сумма пополнения (min. 500 ₽)

type
integer
Тип источника пополнения:
0 - Счёт
1 - Баланс
3 - Бонусы
return
boolean

Флаг возврата ответа (true - в ответе вернется обновлённый размер бюджета кампании, false или не указать параметр вообще - не вернётся.)

Responses

Request samples

Content type
application/json
{
  • "sum": 500,
  • "type": 1,
  • "return": true
}

Response samples

Content type
application/json

Ответ при return=true

{
  • "total": 500
}

Параметры кампаний

Для доступа к методам используйте токен для категории Продвижение

Управление активностью фиксированных фраз{{ /adv/v1/search/set-plus }}

Описание метода

Меняет активность фиксированных фраз. Только для кампаний типа Аукцион

Максимум 1 запрос в 500 миллисекунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

fixed
boolean

Новое состояние (false - сделать неактивными, true - сделать активными)

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление фиксированных фраз{{ /adv/v1/search/set-plus }}

Описание метода

Устанавливает и удаляет фиксированные фразы. Только для кампаний типа Аукцион.

Отправка пустого массива удаляет все фиксированные фразы и отключает активность фиксированных фраз в кампании

Максимум 1 запрос в 500 миллисекунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
pluse
Array of strings

Список фиксированных фраз (max. 100)

Responses

Request samples

Content type
application/json
{
  • "pluse": [
    ]
}

Response samples

Content type
text/plain
[
  "Фраза 1",
  "Фраза 2"
]

Установка/удаление минус-фраз фразового соответствия{{ /adv/v1/search/set-phrase }}

Описание метода

Устанавливает и удаляет минус-фразы фразового соответствия. Только для кампаний типа Аукцион.

Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы фразового соответствия из кампании

Максимум 2 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
phrase
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

Content type
application/json
{
  • "phrase": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз точного соответствия{{ /adv/v1/search/set-strong }}

Описание метода

Устанавливает и удаляет минус-фразы точного соответствия. Только для кампаний типа Аукцион.

Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы точного соответствия из кампании

Максимум 2 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
strong
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

Content type
application/json
{
  • "strong": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз из поиска{{ /adv/v1/search/set-excluded }}

Описание метода

Устанавливает и удаляет минус-фразы из поиска. Только для кампаний типа Аукцион.

Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы из поиска из кампании

Максимум 2 запроса в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

Content type
application/json
{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз для автоматической кампании{{ /adv/v1/auto/set-excluded }}

Описание метода

Устанавливает или удаляет минус-фразы.

Отправка пустого массива удаляет все минус-фразы из кампании

Максимум 1 запрос в 6 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Список фраз (макс. 1000 шт.)

Responses

Request samples

Content type
application/json
Example

Установка минус-фраз

{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Список номенклатур для автоматической кампании{{ /adv/v1/auto/getnmtoadd }}

Описание метода

Возвращает список номенклатур, доступных для добавления в кампанию

Максимум 1 запрос в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
text/plain
[
  1111111111,
  2222222222,
  3333333333,
  4444444444
]

Изменение списка номенклатур в автоматической кампании{{ /adv/v1/auto/updatenm }}

Описание метода

Добавляет и удаляет номенклатуры в автоматической кампании.

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

Проверки по параметру delete не предусмотрено.

Если пришел ответ со статус-кодом 200, а изменений не произошло, проверьте запрос на соответствие документации

Максимум 60 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Request Body schema: application/json
required
add
Array of integers

Номенклатуры, которые необходимо добавить.

delete
Array of integers

Номенклатуры, которые необходимо удалить.

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "кампания не найдена"
}

Медиа

Для доступа к методам используйте токен для категории Продвижение

Количество медиакампаний{{ /adv/v1/count }}

Описание метода

Возвращает количество медиакампаний продавца

Максимум 10 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "all": 6,
  • "adverts": [
    ]
}

Список медиакампаний{{ /adv/v1/adverts }}

Описание метода

Возвращает список медиакампаний продавца

Максимум 10 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
status
integer
Example: status=1
Статус медиакампании:
1 - черновик
2 - модерация
3 - отклонено (с возможностью вернуть на модерацию)
4 - одобрено
5 - запланировано
6 - на показах
7 - завершено
8 - отказался
9 - приостановлена продавцом
10 - пауза по дневному лимиту
11 - пауза по расходу бюджета
type
integer
Example: type=1
Тип медиакампании:
1 - размещение по дням
2 - размещение по просмотрам
limit
integer
Example: limit=1

Количество кампаний в ответе

offset
integer
Example: offset=1

Смещение относительно первой медиакампании

order
string
Example: order=id
Порядок вывода ответа:
create - по времени создания медиакампании
id - по ID медиакампании
direction
string
Example: direction=desc
Порядок сортировки:
desc - от большего к меньшему
asc - от меньшего к большему

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Информация о медиакампании{{ /adv/v1/advert }}

Описание метода

Возвращает информацию об одной медиакампании

Максимум 10 запросов в секунду на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=23569

ID медиакампании

Responses

Response samples

Content type
application/json
{
  • "advertId": 23569,
  • "name": "Реклама денег принеси",
  • "brand": "Plank",
  • "type": 2,
  • "status": 11,
  • "createTime": "2023-07-19T11:13:41.195138+03:00",
  • "extended": {
    },
  • "items": [
    ]
}

Изменение ставки баннера{{ /adv/v1/item/cpm/change }}

Описание метода

Меняет ставку баннера в структуре items.

Изменить кампанию можно только в одном из статусов:

  • 4 — одобрено
  • 5 — запланировано
  • 6 — на показах
  • 9 — приостановлена продавцом
  • 10 — пауза по дневному лимиту
  • 11 — пауза по расходу бюджета
Максимум 10 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID медиакампании

item_id
required
integer

ID баннера

cpm
required
string

Новая ставка

Responses

Request samples

Content type
application/json
{
  • "advert_id": 80474,
  • "item_id": 41573,
  • "cpm": 300
}

Response samples

Content type
text/plain
Example
"Ошибка получения айтемов: {x}", Детали ошибки

Запуск медиакампании{{ /adv/v1/advert/start }}

Описание метода

Запускает приостановленные медиакампании.

После запуска кампания в течение 2-5 минут будет находиться в статусе 4 — одобрено. Затем статус будет изменён на актуальный, в зависимости от конфигурации медиакампании.

Статусы, в которых для медиакампании доступен запуск:

  • 9 — приостановлена продавцом
  • 11 — пауза по расходу бюджета
Максимум 10 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID медиакампании

reason
string

Описание причины запуска

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Причина запуска"
}

Response samples

Content type
text/plain
Example
Кампания не найдена

Приостановка медиакампании{{ /adv/v1/advert/pause }}

Описание метода

Приостанавливает медиакампании и переводит в статус 9 — приостановлена продавцом. Статусы, в которых для медиакампании доступна приостановка:

  • 4 — одобрено
  • 5 — запланировано
  • 6 — на показах
  • 10 — пауза по дневному лимиту
  • 11 — пауза по расходу бюджета
Приостановить медиакампанию можно не больше 10 раз в сутки. Сутки отсчитываются с полуночи по московскому времени.
Максимум 10 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID медиакампании

reason
string

Описание причины приостановки

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Описание причины приостановки"
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Завершение медиакампании{{ /adv/v1/advert/stop }}

Описание метода

Завершает медиакампанию и переводит её в статус 7 — завершено.

Статусы, в которых медиакампании можно завершить:

  • 1 — черновик
  • 3 — отклонено с возможностью вернуть на модерацию
  • 4 — одобрено
  • 5 — запланировано
  • 6 — на показах
  • 8 — отказался
  • 9 — приостановлена продавцом
  • 10 — пауза по дневному лимиту
  • 11 — пауза по расходу бюджета
Максимум 10 запросов в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID медиакампании

reason
string

Описание причины завершения

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Описание причины завершения"
}

Response samples

Content type
text/plain
Перевод в новый статус невозможен