Описание API Продвижение

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

Продвижение

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

Создают автоматическую кампанию.
Максимум 1 запрос в 20 секунд.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
type
integer
Тип автоматической кампании:
8
name
string

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

subjectId
integer

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

Response Schema: application/json
string

ID созданной кампании

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
application/json
"9008917"

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

Создаёт кампанию Аукцион.
Максимум 5 запросов в минуту

Authorizations:
HeaderApiKey
Request Body schema: application/json
campaignName
string

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

nms
Array of integers

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

Responses

Response Schema: application/json
integer

ID кампании

Request samples

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

Response samples

Content type
application/json
1234567

Удаление кампании

Метод позволяет удалять кампании в статусе 4 - готова к запуску.

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

Authorizations:
HeaderApiKey
query Parameters
id
required
integer

ID кампании

Responses

Response samples

Content type
application/json

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

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

Переименование кампании

Метод позволяет переименовать кампанию.
Допускается 5 запросов в секунду.

Authorizations:
HeaderApiKey
Request Body schema: application/json
advertId
required
integer

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

name
required
string

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

Responses

Request samples

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

Response samples

Content type
application/json
Example
"Некорректный идентификатор РК"

Списки кампаний

Метод позволяет получать списки кампаний, сгруппированных по типу и статусу, с информацией о дате последнего изменения кампании.
Допускается 5 запросов в секунду.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects or null

Данные по кампаниям

all
integer

Общее количество кампаний всех статусов и типов

Response samples

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

Информация о кампаниях

Метод позволяет получать информацию о кампаниях по 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 (по идентификатору кампании)
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

Response Schema: application/json
Array
Any of
endTime
string

Дата завершения кампании

createTime
string

Время создания кампании

changeTime
string

Время последнего изменения кампании

startTime
string

Дата последнего запуска кампании

name
string

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

Array of objects

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

dailyBudget
integer

Дневной бюджет, если не установлен, то 0

advertId
integer

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

status
integer
Статус кампании:
-1 - кампания в процессе удаления
4 - готова к запуску
7 - Кампания завершена
8 - отказался
9 - идут показы
11 - Кампания на паузе
Кампания в процессе удаления. Статус означает, что кампания была удалена, и через 3-10 минут она исчезнет из ответа метода.
type
integer
Тип кампании:
4 - кампания в каталоге (устаревший тип)
5 - кампания в карточке товара (устаревший тип)
6 - кампания в поиске (устаревший тип)
7 - кампания в рекомендациях на главной странице (устаревший тип)
paymentType
string

Модель оплаты:

  • cpm — за показы
  • cpo — за заказы
searchPluseState
boolean

Активность фиксированных фраз:

  • false — не активны
  • true — активны

Request samples

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

Response samples

Content type
application/json
Example
[
  • {
    }
]

Изменение ставки у кампании

Изменение ставки у кампании.
Измененная ставка отобразится в информации о кампании в течение трех минут.
Допускается 5 запросов в секунду.

Важно! Если устанавливаемая ставка имеет размер меньше допустимого, то в ответ Вы получите статус-код 422 (Размер ставки не изменён).
Информация об изменении минимального размера ставки публикуется в разделе Новости, на портале продавцов.

Важно! Принцип заполнения параметров type, instrument, param при изменении ставки для кампании с типом 9 (Аукцион):


Для type указывается значение 9 (всегда).


Для instrument указывается значение 6 (устаревший тип кампании).


Для param всегда указывается значение поля id из структуры subject ответа метода "Информация о кампании".

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertId
required
integer

Идентификатор кампании, где меняется ставка

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
application/json
Example
"Некорректное значение параметра param"

Активность кампании

Запуск кампании

Метод позволяет запускать кампании находящиеся в статусах 4 - готова к запуску или 11 - кампания на паузе.
Допускается 5 запросов в секунду.
Для запуска кампании со статусом 11 необходимо наличие у неё пополненного бюджета.

Чтобы запустить кампанию со статусом 4 необходимо выполнить два условия (поочередность действий значения не имеет):
1. После создания кампании в кабинете ВБ. Продвижение необходимо нажать кнопку "Применить изменения".
2. Установить бюджет.
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

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

Responses

Response samples

Content type
application/json
Example
"Некорректный идентификатор РК"

Пауза кампании

Кампании в статусе "9 - идут показы" - можно поставить на паузу, сделав GET на /adv/v0/pause?id=***.
Допускается 5 запросов в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

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

Responses

Response samples

Content type
application/json
Example
"Некорректный идентификатор РК"

Завершение кампании

Метод позволяет завершить кампанию, находящуюся в статусе 9 или 11 или 4.
Допускается 5 запросов в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

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

Responses

Response samples

Content type
application/json
Example
"Некорректный идентификатор РК"

Финансы

Баланс

Метод позволяет получать информацию о счёте, балансе и бонусах продавца.
Допускается 1 запрос в секунду.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
balance
integer

Счёт, рублей

net
integer

Баланс, рублей

bonus
integer

Бонусы, рублей

Response samples

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

Бюджет кампании

Метод позволяет получать информацию о бюджете кампании.
Допускается 4 запроса в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

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

Responses

Response Schema: application/json
cash
integer

Поле не используется. Значение всегда 0.

netting
integer

Поле не используется. Значение всегда 0.

total
integer

Бюджет кампании, ₽

Response samples

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

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

Метод позволяет пополнять бюджет кампании.
Допускается 1 запрос в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

Request Body schema: application/json
required
sum
integer

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

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

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

Responses

Response Schema: application/json
One of
total
integer

Размер обновлённого бюджета

Request samples

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

Response samples

Content type
application/json

Ответ при return=true

{
  • "total": 500
}

Получение истории затрат

Метод позволяет получать историю затрат.
Допускается 1 запрос в секунду.

Authorizations:
HeaderApiKey
query Parameters
from
required
string <date>
Example: from=2023-07-31

Начало интервала

to
required
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response Schema: application/json
Array
updNum
integer

Номер выставленного документа (при наличии)

updTime
string <time-date>

Время списания

updSum
integer

Выставленная сумма

advertId
integer

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

campName
string

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

advertType
integer

Тип кампании

paymentType
string
Источник списания:
Баланс
Бонусы
Счет
advertStatus
integer
Статус кампании:
4 - готова к запуску
7 - завершена
8 - отказался
9 - активна
11 - приостановлена

Response samples

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

Получение истории пополнений счета

Метод позволяет получать историю пополнений счёта.
Допускается 1 запрос в секунду.

Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2023-07-31

Начало интервала

to
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response Schema: application/json
Array
id
integer

Идентификатор платежа

date
string <time-date>

Дата платежа

sum
integer

Сумма платежа

type
integer
Тип источника списания:
0 - Счёт
1 - Баланс
3 - Картой
statusId
integer
Статус:
0 - ошибка
1 - обработано
cardStatus
string
Статус операции(при оплате картой):
success - успех
fail - неуспех
pending - в ожидании ответа
unknown - неизвестно

Response samples

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

Управление параметрами кампаний Аукцион

Управление активностью фиксированных фраз

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

Максимум 1 запрос в 500 миллисекунд.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

fixed
boolean

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

Responses

Response samples

Content type
application/json
"Некорректный запрос"

Установка/удаление фиксированных фраз

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

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

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

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

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

Responses

Response Schema: application/json
Array
string

Request samples

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

Response samples

Content type
application/json
[
  • "Фраза 1",
  • "Фраза 2"
]

Установка/удаление минус-фраз фразового соответствия

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

Максимум 2 запроса в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

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
"Некорректный запрос"

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

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

Максимум 2 запроса в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

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
"Некорректный запрос"

Установка/удаление минус-фраз из поиска

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

Максимум 2 запроса в секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

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
"Некорректный запрос"

Управление параметрами автоматических кампаний

Список номенклатур для автоматической кампании

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

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

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

Responses

Response Schema: application/json
Array
integer

Response samples

Content type
application/json
[
  • 1111111111,
  • 2222222222,
  • 3333333333,
  • 4444444444
]

Изменение списка номенклатур в автоматической кампании

Метод позволяет добавлять и удалять номенклатуры.
Допускается 1 запрос в секунду.
Важно: Добавить можно только те номенклатуры, которые вернутся в ответе метода "Список номенклатур для автоматической кампании".
Удалить единственную номенклатуру из кампании нельзя.
Проверки по параметру delete не предусмотрено.
Если пришел ответ со статус-кодом 200, а изменений не произошло, то проверьте запрос на соответствие документации.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

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

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": "кампания не найдена"
}

Установка/удаление минус-фраз для автоматической кампании

Метод позволяет устанавливать или удалять минус фразы.

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

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

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

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
"Некорректный запрос"

Словари

Для получения информации по карточкам товара используйте методы контента Список номенклатур (НМ) и Список НМ, находящихся в корзине, они доступны по токену c опцией Продвижение.

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

Возвращает предметы, номенклатуры из которых можно добавить в кампании. Максимум 1 запрос в 12 секунд.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
id
integer

ID предмета

name
string

Предмет

count
integer

Количество Артикулов Wildberries (nmId) с таким предметом.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Номенклатуры для кампаний

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

Максимум 5 запросов в минуту

Authorizations:
HeaderApiKey
Request Body schema: application/json

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

Array
integer

Responses

Response Schema: application/json
Array
title
string

Название товара

nm
integer

Артикул Wildberries (nmId)

subjectId
integer

ID предмета

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Статистика

Статистика кампаний

Возвращает статистику кампаний.
Максимум 1 запрос в минуту.
Данные вернутся для кампаний в статусе 7, 9 и 11.
Важно. В запросе можно передавать либо параметр dates либо параметр interval, но не оба.
Можно отправить запрос только с ID кампании. При этом вернутся данные за последние сутки, но не за весь период существования кампании.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
One of
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
id
integer

ID кампании

dates
Array of strings <date> [ items <date > ]

Даты, за которые необходимо выдать информацию.

Responses

Response Schema: application/json
One of
Array
dates
Array of strings <date> [ items <date > ]

Даты, за которые необходимо выдать информацию.

views
integer

Количество просмотров.
За все дни, по всем артикулам WB и платформам.

clicks
integer

Количество кликов.
За все дни, по всем артикулам WB и платформам.

ctr
number

Показатель кликабельности.
Отношение числа кликов к количеству показов. Выражается в процентах.
За все дни, по всем артикулам WB и платформам.

cpc
number

Средняя стоимость клика, ₽.
За все дни, по всем артикулам WB и платформам.

sum
number

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

atbs
integer

Количество добавлений товаров в корзину.
За все дни, по всем артикулам WB и платформам.

orders
integer

Количество заказов.
За все дни, по всем артикулам WB и платформам.

cr
integer

CR(conversion rate) — это отношение количества заказов к общему количеству посещений кампании.
За все дни, по всем артикулам WB и платформам.

shks
integer

Количество заказанных товаров, шт.
За все дни, по всем артикулам WB и платформам.

sum_price
number

Заказов на сумму, ₽
За все дни, по всем артикулам WB и платформам.

Array of objects (Days)

Статистка по дням

Array of objects (BoosterStats)

Статистика по средней позиции товара на страницах поисковой выдачи и каталога (для автоматических кампаний).

advertId
integer

ID кампании

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

Ответ при запросе с полем date

[
  • {
    }
]

Статистика автоматической кампании по кластерам фраз

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

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

Максимум — 4 запроса секунду.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

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

Responses

Response Schema: application/json
excluded
Array of strings

Исключения (минус-фразы) для товаров из кампании. Это фразы, которые вы задали с помощью метода Установка/удаление минус-фраз или в личном кабинете, в настройках кампании

Array of objects

Кластеры ключевых фраз

Response samples

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

Статистика поисковой кампании по ключевым фразам

Метод позволяет получать статистику поисковой кампании по ключевым фразам.
Допускается максимум 4 запроса в секунду.
Информация обновляется примерно каждые полчаса.

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

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

Responses

Response Schema: application/json
object

Блок информации по ключевым фразам

Array of objects

Массив информации по статистике.
Первый элемент массива с keyword: "Всего по кампании" содержит суммарную информацию по всем ключевым фразам.
Каждый следующий элемент массива содержит информацию по отдельной ключевой фразе.
Отображается 60 ключевых фраз с наибольшим количеством просмотров.

Response samples

Content type
application/json
{
  • "words": {
    },
  • "stat": [
    ]
}

Статистика по ключевым фразам для Автоматических кампаний и Аукциона

Возвращает статистику по ключевым фразам за каждый день, когда кампания была активна.
Можно получить данные максимум за 7 дней.
Информация обновляется раз в час.
Максимум 4 запроса секунду

Authorizations:
HeaderApiKey
query Parameters
advert_id
required
integer
Example: advert_id=123456789

ID кампании

from
required
string <date>
Example: from=2024-08-10

Начало периода

to
required
string <date>
Example: to=2024-08-12

Конец периода

Responses

Response Schema: application/json
required
Array of objects (V0KeywordsStatistics)

Response samples

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

Медиа

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

Получение медиакампаний

Метод позволяет получить количество медиакампаний продавца

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
all
integer

Общее количество медиакампаний всех статусов и типов

object

Response samples

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

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

Метод позволяет получить список медиакампаний продавца

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 - по идентификатору медиакампании
direction
string
Example: direction=desc
Порядок сортировки:
desc - от большего к меньшему
asc - от меньшего к большему

Responses

Response Schema: application/json
Array
advertId
integer

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

name
string

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

brand
string

Название бренда

type
integer
Тип медиакампании:
1 - размещение по дням
2 - размещение по просмотрам
status
integer
Статус медиакампании:
1 - черновик
2 - модерация
3 - отклонено (с возможностью вернуть на модерацию)
4 - одобрено
5 - запланировано
6 - на показах
7 - завершено
8 - отказался
9 - приостановлена продавцом
10 - пауза по дневному лимиту
11 - пауза по расходу бюджета
createTime
string <date-time>

Время создания медиакампании

endTime
string <date-time>

Время завершения медиакампании (при наличии)

Response samples

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

Информация о медиакампании

Метод позволяет получить информацию об одной медиакампании

Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=23569

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

Responses

Response Schema: application/json
advertId
integer

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

name
string

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

brand
string

Название бренда

type
integer
Тип медиакампании:
1 - размещение по дням
2 - размещение по просмотрам
status
integer
Статус медиакампании:
1 - черновик
2 - модерация
3 - отклонено (с возможностью вернуть на модерацию)
4 - одобрено
5 - запланировано
6 - на показах
7 - завершено
8 - отказался
9 - приостановлена продавцом
10 - пауза по дневному лимиту
11 - пауза по расходу бюджета
createTime
string <date-time>

Время создания медиакампании

object
Array of objects

Информация о баннере.
Наличие в ответе тех или иных полей зависит от конфигурации медиакампании.

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": [
    ]
}

Активность медиакампании

Завершение медиакампании

Метод завершает медиакампанию - переводит её в статус 7.
Допускается максимум 10 запросов в минуту.

Статусы, в которых для медиакампании доступно завершение:
1 - черновик
3 - отклонено (с возможностью вернуть на модерацию)
4 - одобрено
5 - запланировано
6 - на показах
8 - отказался
9 - приостановлена продавцом
10 - пауза по дневному лимиту
11 - пауза по расходу бюджета
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
"Перевод в новый статус невозможен"

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

Метод позволяет приостанавливать медиакампании.
Переводит приостанавливаемую медиакампанию в статус 9.
Допускается максимум 10 запросов в минуту.
Важно: приостановить медиакампанию можно не больше 10 раз в сутки. Сутки отсчитываются с полуночи по Московскому времени.

Статусы, в которых для медиакампании доступна приостановка:
4 — одобрено
5 — запланировано
6 — на показах
10 — пауза по дневному лимиту
11 — пауза по расходу бюджета
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"
}

Запуск медиакампании

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

Статусы, в которых для медиакампании доступен запуск:
9 - приостановлена продавцом
11 - пауза по расходу бюджета
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
Example
"Кампания не найдена"

Статистика медиакампании

Статистика медиакампаний

Метод позволяет получать статистику медиакампаний.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
One of
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
id
integer

ID кампании

dates
Array of strings <date> [ items <date > ]

Даты, за которые необходимо выдать информацию.

Responses

Response Schema: application/json
Array
One of
object

Запрошенный временной диапазон.

Array of objects (StatsBlok1)

Блок статистики

Request samples

Content type
application/json
Example

Запрос с датами

[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example

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

[
  • {
    }
]

Ставки медиакампании

Изменение ставки баннера

Метод позволяет изменять ставку баннера в структуре 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
application/json
Example
"\"Ошибка получения айтемов: {x}\", Детали ошибки"