Синхронизация данных из бд происходит раз в 3 минуты.
Изменение статуса происходит раз в 1 минуту. Внутри этого интервала будет сохранено последнее действие по изменению статуса.
Изменение ставки происходит раз в 30 секунд. Внутри этого интервала будет сохранено последнее действие по изменению ставки.
Создают автоматическую кампанию.
Максимум 1 запрос в 20 секунд.
| type | integer
|
| name | string Название кампании (max. 128 символов) |
| subjectId | integer ID предмета, для которого создается кампания. |
| sum | integer Сумма пополнения |
| btype | integer
|
| on_pause | boolean
|
| nms | Array of integers Массив артикулов WB. |
| cpm | integer Ставка. |
ID созданной кампании
{- "type": 8,
- "name": "Парашюты",
- "subjectId": 270,
- "sum": 500,
- "btype": 1,
- "on_pause": true,
- "nms": [
- 9178363,
- 9178364
], - "cpm": 10
}"9008917"Создаёт кампанию Поиск + Каталог.
Максимум 5 запросов в минуту
| campaignName | string Название кампании |
| nms required | Array of integers Номенклатуры для кампании. Доступные номенклатуры можно получить с помощью метода Номенклатуры для кампаний. Максимум 50 товаров ( |
ID кампании
{- "name": "Телефоны",
- "nms": [
- 146168367,
- 200425104
]
}1234567Метод позволяет удалять кампании в статусе 4 - готова к запуску.
Допускается 5 запросов в секунду.
После удаления кампания некоторое время будет находиться в -1 статусе.
Полное удаление кампании занимает от 3 до 10 минут.
| id required | integer ID кампании |
Некорректный идентификатор кампании
{- "error": "Некорректный идентификатор кампании"
}Метод позволяет получать списки кампаний, сгруппированных по типу и статусу, с информацией о дате последнего изменения кампании.
Допускается 5 запросов в секунду.
Array of objects Данные по кампаниям |
{- "adverts": [
- {
- "type": 4,
- "status": 8,
- "count": 3,
- "advert_list": [
- {
- "advertId": 6485174,
- "changeTime": "2023-05-10T12:12:52.676254+03:00"
}, - {
- "advertId": 6500443,
- "changeTime": "2023-05-10T17:08:46.370656+03:00"
}, - {
- "advertId": 7936341,
- "changeTime": "2023-07-12T15:51:08.367478+03:00"
}
]
}
]
}Метод позволяет получать информацию о кампаниях по query параметрам, либо по списку id кампаний.
Допускается 5 запросов в секунду.
| status | integer Enum: -1 4 7 9 11
|
| type | integer Enum: 4 5 6 7
|
| order | string Enum: "create" "change" "id"
Например: /adv/v1/promotion/adverts?type=6&order=change&direction=asc
|
| direction | string Enum: "desc" "asc"
Например: /adv/v1/promotion/adverts?type=6&order=change&direction=asc
|
Список ID кампаний. Максимум 50.
Получить id кампаний можно методом Списки кампаний.
| advertId | integer Идентификатор кампании |
| type | integer
|
| status | integer
|
| dailyBudget | integer Дневной бюджет, если не установлен, то 0 |
| createTime | string Время создания кампании |
| changeTime | string Время последнего изменения кампании |
| startTime | string Дата последнего запуска кампании |
| endTime | string Дата завершения кампании |
| name | string Название кампании |
Array of objects Параметры кампании | |
| searchPluseState | boolean Активность фиксированных фраз (Для кампаний в поиске) |
[- 1234567,
- 63453471
][- {
- "advertId": 12345,
- "name": "Носки_Шерстяные",
- "type": 6,
- "status": 9,
- "dailyBudget": 0,
- "createTime": "2023-05-31 16:57:42.654141+03:00",
- "changeTime": "2023-06-21 22:10:43.074183+03:00",
- "startTime": "2023-07-21 21:17:42.872376+03:00",
- "endTime": "2100-01-01 00:00:00+03:00",
- "params": [
- {
- "intervals": [
- {
- "begin": 3,
- "end": 5
}
], - "price": 400,
- "subjectId": 201,
- "subjectName": "Носки",
- "nms": [
- {
- "nm": 11111111,
- "active": true
}
], - "active": false
}
], - "searchPluseState": false
}
]Получение списка ставок для типа размещения.
Допускается 5 запросов в секунду.
Данные в ответе отсортированы по величине ставки от большей к меньшей.
| type required | integer Enum: 4 5 6 7 9 Кампания:
|
| param required | integer Example: param=1234 Параметр запроса, по которому будет получен список ставок активных кампаний.
|
| Cmp | integer Размер ставки |
| Count | integer Количество ставок |
[- {
- "Cmp": 290,
- "Count": 1
}
]Изменение ставки у кампании.
Измененная ставка отобразится в информации о кампании в течение трех минут.
Допускается 5 запросов в секунду.
Важно! Если устанавливаемая ставка имеет размер меньше допустимого, то в ответ Вы получите статус-код 422 (Размер ставки не изменён).
Информация об изменении минимального размера ставки публикуется в разделе Новости, на портале продавцов.
Важно! Принцип заполнения параметров type, instrument, param при изменении ставки для кампании с типом 9 (поиск + каталог):
Для type указывается значение 9 (всегда).
Для instrument указывается значение 4 или 6 в зависимости от того, в каталоге или поиске необходимо изменить ставку.
Для param всегда указывается значение поля id из структуры subject ответа метода "Информация о кампании", вне зависимости от того, в каталоге или поиске изменяется ставка.
Важно! Если в кампании Поиск + Каталог доступен только Поиск, то установить ставку в Каталог (instrument = 4) не получится. В ответ Вы получите статус-код 422
| advertId required | integer Идентификатор кампании, где меняется ставка |
| type required | integer Enum: 5 6 7 8 9
|
| cpm required | integer Новое значение ставки |
| param required | integer Параметр, для которого будет внесено изменение. Является значением |
| instrument | integer тип кампании для изменения ставки в Поиск + Каталог (4 - каталог, 6 - поиск) |
{- "advertId": 789,
- "type": 5,
- "cpm": 456,
- "param": 23,
- "instrument": 4
}"Некорректное значение параметра param"Метод позволяет получить список ставок по типу размещения кампании.
Допускается 5 запросов в секунду.
С помощью этого метода изменить ставку невозможно.
| type required | integer Enum: 4 5 6 7 9 Кампании:
|
| param | Array of integers Массив параметров запроса, по которым будет получен список ставок активных кампаний: должен быть значением |
| param | integer Значение параметра (param) запроса |
Array of objects Информация о ставке(-ах) |
{- "param": [
- 699,
- 344,
- 385
]
}[- {
- "param": 344,
- "cpm": [
- {
- "Cpm": 235,
- "Count": 1
}
]
}, - {
- "param": 385,
- "cpm": [
- {
- "Cpm": 187,
- "Count": 1
}, - {
- "Cpm": 185,
- "Count": 2
}, - {
- "Cpm": 179,
- "Count": 2
}
]
}
]Метод позволяет запускать кампании находящиеся в статусах 4 - готова к запуску или 11 - кампания на паузе.
Допускается 5 запросов в секунду.
Для запуска кампании со статусом 11 необходимо наличие у неё пополненного бюджета.
| id required | integer Example: id=1234 Идентификатор кампании |
"Некорректный идентификатор РК"кампании в статусе "9 - идут показы" - можно запаузить, сделав GET на /adv/v0/pause?id=***.
Допускается 5 запросов в секунду.
| id required | integer Example: id=1234 Идентификатор кампании |
"Некорректный идентификатор РК"Метод позволяет завершить кампанию, находящуюся в статусе 9 или 11 или 4.
Допускается 5 запросов в секунду.
| id required | integer Example: id=1234 Идентификатор кампании |
"Некорректный идентификатор РК"Метод позволяет получать информацию о счёте, балансе и бонусах продавца.
Допускается 1 запрос в секунду.
| balance | integer Счёт, рублей |
| net | integer Баланс, рублей |
| bonus | integer Бонусы, рублей |
{- "balance": 11083,
- "net": 0,
- "bonus": 15187
}Метод позволяет получать информацию о бюджете кампании.
Допускается 4 запроса в секунду.
| id required | integer Example: id=1 Идентификатор кампании |
| cash | integer Поле не используется. Значение всегда 0. |
| netting | integer Поле не используется. Значение всегда 0. |
| total | integer Бюджет кампании, ₽ |
{- "cash": 0,
- "netting": 0,
- "total": 500
}Метод позволяет пополнять бюджет кампании.
Допускается 1 запрос в секунду.
| id required | integer Example: id=1234567 Идентификатор кампании |
| sum | integer Сумма пополнения (min. 500 ₽) |
| type | integer
|
| return | boolean Флаг возврата ответа ( |
| total | integer Размер обновлённого бюджета |
{- "sum": 500,
- "type": 1,
- "return": true
}Ответ при return=true
{- "total": 500
}Метод позволяет получать массив с датами начала месяца, когда у продавца были расходы.
Допускается 1 запрос в секунду.
[- "2023-07-01T00:00:00Z",
- "2023-06-01T00:00:00Z",
- "2023-05-01T00:00:00Z",
- "2023-04-01T00:00:00Z",
- "2023-03-01T00:00:00Z"
]Метод позволяет получать историю затрат.
Допускается 1 запрос в секунду.
| from required | string <date> Example: from=2023-07-31 Начало интервала |
| to required | string <date> Example: to=2023-08-02 Конец интервала. |
| updNum | integer Номер выставленного документа (при наличии) |
| updTime | string <time-date> Время списания |
| updSum | integer Выставленная сумма |
| advertId | integer Идентификатор кампании |
| campName | string Название кампании |
| advertType | integer Тип кампании |
| paymentType | string
|
| advertStatus | integer
|
[- {
- "updNum": 0,
- "updTime": "2023-07-31T12:12:54.060536+03:00",
- "updSum": 24,
- "advertId": 3355881,
- "campName": "лук лучок",
- "advertType": 6,
- "paymentType": "Баланс",
- "advertStatus": 9
}, - {
- "updNum": 0,
- "updTime": null,
- "updSum": 107,
- "advertId": 3366882,
- "campName": "золотая луковица",
- "advertType": 8,
- "paymentType": "Счет",
- "advertStatus": 11
}
]Метод позволяет получать историю пополнений счёта.
Допускается 1 запрос в секунду.
| from | string <date> Example: from=2023-07-31 Начало интервала |
| to | string <date> Example: to=2023-08-02 Конец интервала. |
| id | integer Идентификатор платежа |
| date | string <time-date> Дата платежа |
| sum | integer Сумма платежа |
| type | integer
|
| statusId | integer
|
| cardStatus | string
|
[- {
- "id": 1036666,
- "date": "2022-02-04T09:06:47.985843Z",
- "sum": 600,
- "type": 0,
- "statusId": 1,
- "cardStatus": ""
}, - {
- "id": 55261296,
- "date": "2023-04-13T10:07:42",
- "sum": 1500,
- "type": 3,
- "statusId": 1,
- "cardStatus": "succeeded"
}
]Метод позволяет переименовать кампанию.
Допускается 5 запросов в секунду.
| advertId required | integer Идентификатор кампании, у которой меняется название |
| name required | string Новое название (максимум 100 символов) |
{- "advertId": 2233344,
- "name": "newnmame"
}"Некорректный идентификатор РК"Метод позволяет получать список предметов продавца и количество артикулов WB по каждому предмету.
Допускается 1 запрос в 12 секунд.
| id | integer Идентификатор предмета |
| name | string Название предмета |
| nmsCount | integer Количество артикулов WB с этим предметом |
[- {
- "id": 342,
- "name": "Обложки",
- "nmsCount": 1
}, - {
- "id": 106,
- "name": "Тапочки",
- "nmsCount": 2
}, - {
- "id": 219,
- "name": "Футболки-поло",
- "nmsCount": 2
}
]Метод возвращает список товаров, которые есть в наличии. Эти товары можно добавить в кампанию.
Допускается 1 запрос в 12 секунд.
Чтобы получить все товары, которые есть в наличии, необходимо отправить запрос без параметра subject.
| subject | integer ID предмета |
| nm | integer Артикул WB. |
| name | any Наименование товара. |
object Данные предмета. | |
| brand | string Бренд. |
object Данные пола. |
[- {
- "nm": 1234567,
- "name": "Обложка на студенческий",
- "subject": {
- "id": 342,
- "name": "Обложки"
}, - "brand": "Бренд",
- "kind": {
- "id": 2,
- "name": "Для женщин"
}
}
]Изменяет активность предметной группы. Только для кампаний:
9) и Кампания на паузе (11).
Максимум 5 запросов в секунду.| id required | integer Example: id=1234 Идентификатор кампании |
| subjectId required | integer Example: subjectId=1234 Идентификатор предметной группы, для которой меняется активность |
| status required | string Example: status=true Новое состояние ( |
"Некорректное значение параметра active"Изменяет активность фиксированных фраз. Только для кампаний в поиске и поиск + каталог.
Максимум 1 запрос в 500 миллисекунд.
| id required | integer Example: id=1234567 Идентификатор кампании |
| fixed | boolean Новое состояние ( |
"Некорректный запрос"Устанавливает и удаляет фиксированные фразы. Только для кампаний в поиске и поиск + каталог.
Отправка пустого массива удаляет все фиксированные фразы и отключает активность фиксированных фраз в кампании. Максимум 1 запрос в 500 миллисекунд.
| id required | integer Example: id=1234567 Идентификатор кампании |
| pluse | Array of strings Список фиксированных фраз (max. 100) |
{- "pluse": [
- "Фраза 1",
- "Фраза 2"
]
}[- "Фраза 1",
- "Фраза 2"
]Устанавливает и удаляет минус-фразы фразового соответствия. Только для кампаний в поиске и поиск + каталог.
Максимально допустимое количество минус-фраз в кампании - 1000 шт.
Отправка пустого массива удаляет все минус-фразы фразового соответствия из кампании.
Максимум 2 запроса в секунду.
| id required | integer Example: id=1234567 Идентификатор кампании |
| phrase | Array of strings Минус-фразы (макс. 1000 шт.) |
{- "phrase": [
- "сло",
- "гу"
]
}"Некорректный запрос"Устанавливает и удаляет минус-фразы точного соответствия. Только для кампаний в поиске и поиск + каталог.
Максимально допустимое количество минус-фраз в кампании - 1000 шт.
Отправка пустого массива удаляет все минус-фразы точного соответствия из кампании.
Максимум 2 запроса в секунду.
| id required | integer Example: id=1234567 Идентификатор кампании |
| strong | Array of strings Минус-фразы (макс. 1000 шт.) |
{- "strong": [
- "стоять",
- "лопата"
]
}"Некорректный запрос"Устанавливает и удаляет минус-фразы из поиска. Только для кампаний в поиске и поиск + каталог.
Максимально допустимое количество минус-фраз в кампании - 1000 шт.
Отправка пустого массива удаляет все минус-фразы из поиска из кампании.
Максимум 2 запроса в секунду.
| id required | integer Example: id=1234567 Идентификатор кампании |
| excluded | Array of strings Минус-фразы (макс. 1000 шт.) |
{- "excluded": [
- "что-то синее",
- "картошечка"
]
}"Некорректный запрос"Метод позволяет получать список номенклатур, доступных для добавления в кампанию.
Допускается 1 запрос в секунду.
| id required | integer Example: id=1 Идентификатор кампании |
[- 1111111111,
- 2222222222,
- 3333333333,
- 4444444444
]Метод позволяет добавлять и удалять номенклатуры.
Допускается 1 запрос в секунду.
Важно: Добавить можно только те номенклатуры, которые вернутся в ответе метода "Список номенклатур для автоматической кампании".
Удалить единственную номенклатуру из кампании нельзя.
Проверки по параметру delete не предусмотрено.
Если пришел ответ со статус-кодом 200, а изменений не произошло, то проверьте запрос на соответствие документации.
| id required | integer Example: id=1 Идентификатор кампании |
| add | Array of integers Номенклатуры, которые необходимо добавить. |
| delete | Array of integers Номенклатуры, которые необходимо удалить. |
{- "add": [
- 11111111,
- 44444444
], - "delete": [
- 55555555
]
}{- "error": "кампания не найдена"
}Метод позволяет изменять активность зон показов.
Допускается 1 запрос в секунду.
Вы можете осуществлять показы товаров во всех зонах либо выборочно.
| id required | integer Example: id=1 Идентификатор кампании |
| recom | boolean Рекомендации на главной ( |
| booster | boolean Поиск/Каталог ( |
| carousel | boolean Карточка товара ( |
{- "recom": true,
- "booster": true,
- "carousel": true
}"не удалось получить активность инструментов продвижения"Метод позволяет устанавливать или удалять минус фразы.
Допускается 1 запрос в 6 секунд.
Отправка пустого массива удаляет все минус-фразы из кампании.
| id required | integer Example: id=1234567 Идентификатор кампании |
| excluded | Array of strings Список фраз (макс. 1000 шт.) |
Установка минус-фраз
{- "excluded": [
- "первая фраза",
- "вторая фраза"
]
}"Некорректный запрос"Метод позволяет получить список значений параметра subjectId.
Допускается 5 запросов в секунду.
| id | integer Идентификатор предметной группы, для которой создана кампания (для кампаний в поиске и рекомендациях). |
| id | integer Значение для параметра |
| name | string Название предметной группы, для которой создана кампания |
[- {
- "id": 699,
- "name": "Гелевые полоски"
}, - {
- "id": 12345,
- "name": "Гелевые кружочки"
}
]Метод позволяет получить список значений параметра setId.
Допускается 5 запросов в секунду.
| id | integer Идентификатор сочетания предмета и пола (для кампаний в карточке товара). |
| id | integer Значение для параметра |
| name | string Сочетание предмета и пола |
[- {
- "id": 477,
- "name": "Подушки для малышей"
}, - {
- "id": 744,
- "name": "Хлопушки для малышей"
}
]Возвращает предметы, номенклатуры из которых можно добавить в кампании. Максимум 1 запрос в 12 секунд.
| id | integer ID предмета |
| name | string Предмет |
| count | integer Количество Артикулов Wildberries ( |
[- {
- "name": "3D очки",
- "id": 2560,
- "count": 1899
}
]Возвращает номенклатуры, которые можно добавить в кампании.
Максимум 5 запросов в минуту
ID предметов, для которых нужно получить номенклатуры
| title | string Название товара |
| nm | integer Артикул Wildberries ( |
| subjectId | integer ID предмета |
[- 123,
- 456,
- 765,
- 321
][- {
- "title": "Плед",
- "nm": 146168367,
- "subjectId": 765
}
]Возвращает статистику кампаний.
Максимум 1 запрос в минуту.
Данные вернутся для кампаний в статусе 7, 9 и 11.
Важно. В запросе можно передавать либо параметр dates либо параметр interval, но не оба.
Можно отправить запрос только с ID кампании. При этом вернутся данные за последние сутки, но не за весь период существования кампании.
| id | integer ID кампании |
| dates | Array of strings <date> [ items <date > ] Даты, за которые необходимо выдать информацию. |
| dates | Array of strings <date> [ items <date > ] Даты, за которые необходимо выдать информацию. |
| views | integer Количество просмотров. |
| clicks | integer Количество кликов. |
| ctr | number Показатель кликабельности. |
| cpc | number Средняя стоимость клика, ₽. |
| sum | number Затраты, ₽. |
| atbs | integer Количество добавлений товаров в корзину. |
| orders | integer Количество заказов. |
| cr | integer CR(conversion rate) — это отношение количества заказов к общему количеству посещений кампании. |
| shks | integer Количество заказанных товаров, шт. |
| sum_price | number Заказов на сумму, ₽ |
Array of objects (Days) Статистка по дням | |
Array of objects (BoosterStats) Статистика по средней позиции товара на страницах поисковой выдачи и каталога (для автоматических кампаний). | |
| advertId | integer ID кампании |
Запрос с датами
[- {
- "id": 8960367,
- "dates": [
- "2023-10-07",
- "2023-10-06"
]
}, - {
- "id": 9876543,
- "dates": [
- "2023-10-07",
- "2023-12-06"
]
}
]Ответ при запросе с полем date
[- {
- "views": 1052,
- "clicks": 2,
- "ctr": 0.19,
- "cpc": 0.09,
- "sum": 177.7,
- "atbs": 0,
- "orders": 0,
- "cr": 0,
- "shks": 0,
- "sum_price": 0,
- "dates": [
- "2023-10-07",
- "2023-10-06"
], - "days": [
- {
- "date": "2023-10-06T03:00:00+03:00",
- "views": 414,
- "clicks": 1,
- "ctr": 0.24,
- "cpc": 70,
- "sum": 70,
- "atbs": 0,
- "orders": 0,
- "cr": 0,
- "shks": 0,
- "sum_price": 0,
- "apps": [
- {
- "views": 228,
- "clicks": 0,
- "ctr": 0,
- "cpc": 0,
- "sum": 38.71,
- "atbs": 0,
- "orders": 0,
- "cr": 0,
- "shks": 0,
- "sum_price": 0,
- "nm": [
- {
- "views": 25,
- "clicks": 0,
- "ctr": 0,
- "cpc": 0,
- "sum": 4,
- "atbs": 0,
- "orders": 0,
- "cr": 0,
- "shks": 0,
- "sum_price": 0,
- "name": "Тапочки",
- "nmId": 111111111111
}
], - "appType": 1
}
]
}
], - "boosterStats": [
- {
- "date": "2023-10-07T00:00:00Z",
- "nm": 170095908,
- "avg_position": 348
}
], - "advertId": 10524818
}
]Метод позволяет получать краткую статистику по автоматической кампании.
Допускается 1 запрос в 6 секунд.
| id required | integer Example: id=1 Идентификатор кампании |
| views | integer Количество просмотров |
| clicks | number Количество кликов |
| ctr | number CTR (Click-Through Rate) — показатель кликабельности. |
| cpc | number CPC(от англ. cost per click — цена за клик) — это цена клика по продвигаемому товару. |
| spend | integer Затраты, ₽. |
{- "views": 68,
- "clicks": 3,
- "ctr": 4.41,
- "cpc": 1.18,
- "spend": 3
}Возвращает кластеры ключевых фраз (наборы похожих), по которым показывались товары в кампании, и количество показов по ним. В ответ метода попадают только те фразы, по которым товары показывались хотя бы один раз.
Информация обновляется раз в 15 минут.
Максимум — 4 запроса секунду.
| id required | integer Example: id=1234 Идентификатор кампании |
| excluded | Array of strings Исключения (минус-фразы) для товаров из кампании. Это фразы, которые вы задали с помощью метода Установка/удаление минус-фраз или в личном кабинете, в настройках кампании |
Array of objects Кластеры ключевых фраз |
{- "excluded": [
- "Samsung",
- "Xiaomi"
], - "clusters": [
- {
- "cluster": "Телефон",
- "count": 100,
- "keywords": [
- "Телефон",
- "Мобильный телефон"
]
}
]
}Возвращает статистику по ключевым фразам за каждый день, когда кампания была активна.
Информация обновляется раз в 15 минут.
Максимум — 4 запроса секунду.
| id required | integer Example: id=1234 Идентификатор кампании |
| date | string Дата, когда пользователи просматривали товары из кампании |
Array of objects Статистика по ключевым фразам |
{- "date": "2024-01-23T03:00:00+03:00",
- "stat": [
- {
- "keyword": "Смартфон",
- "views": 100,
- "clicks": 500,
- "ctr": 0.5,
- "sum": 1000
}
]
}Метод позволяет получать статистику поисковой кампании по ключевым фразам.
Допускается максимум 4 запроса в секунду.
Информация обновляется примерно каждые полчаса.
| id required | integer Example: id=1 Идентификатор кампании |
object Блок информации по ключевым фразам | |
Array of objects Массив информации по статистике. |
{- "words": {
- "phrase": [ ],
- "strong": [ ],
- "excluded": [ ],
- "pluse": [
- "детское постельное белье для мальчика 1.5"
], - "keywords": [
- {
- "keyword": "постельное белье 1.5",
- "count": 772
}
], - "fixed": true
}, - "stat": [
- {
- "advertId": 7703570,
- "keyword": "Всего по кампании",
- "advertName": "",
- "campaignName": "Бельё",
- "begin": "2023-07-03T15:15:38.287441+03:00",
- "end": "2023-07-03T15:15:38.287441+03:00",
- "views": 1846,
- "clicks": 73,
- "frq": 1.03,
- "ctr": 3.95,
- "cpc": 7.88,
- "duration": 769159,
- "sum": 575.6
}, - {
- "advertId": 7703570,
- "keyword": "постельное белье 1.5 детское",
- "advertName": "",
- "campaignName": "Бельё",
- "begin": "2023-07-03T15:15:38.287441+03:00",
- "end": "2023-07-03T15:15:38.287441+03:00",
- "views": 1846,
- "clicks": 73,
- "frq": 1.03,
- "ctr": 3.95,
- "cpc": 7.88,
- "duration": 769159,
- "sum": 575.6
}
]
}Метод позволяет получать статистику по кампаниям Поиск + Каталог.
Допускается 2 запроса в секунду.
| id required | integer Example: id=1 Идентификатор кампании |
| totalViews | integer Суммарное количество просмотров |
| totalClicks | integer Суммарное количество кликов |
| totalOrders | integer Суммарное количество заказов |
| totalSum | integer Суммарные затраты, ₽. |
Array of objects Блок статистики |
{- "totalViews": 1117,
- "totalClicks": 27,
- "totalOrders": 0,
- "totalSum": 460,
- "dates": [
- {
- "date": "2023-07-10",
- "search": {
- "views": 1117,
- "clicks": 27,
- "orders": 0,
- "sum": 460
}, - "catalog": {
- "views": 6,
- "clicks": 0,
- "orders": 0,
- "sum": 0
}
}
]
}Метод позволяет получить количество медиакампаний продавца
| all | integer Общее количество медиакампаний всех статусов и типов |
object |
{- "all": 6,
- "adverts": [
- {
- "type": 2,
- "status": 7,
- "count": 2
}, - {
- "type": 2,
- "status": 8,
- "count": 4
}
]
}Метод позволяет получить список медиакампаний продавца
| status | integer Example: status=1
|
| type | integer Example: type=1
|
| limit | integer Example: limit=1 Количество кампаний в ответе |
| offset | integer Example: offset=1 Смещение относительно первой медиакампании |
| order | string Example: order=id
|
| direction | string Example: direction=desc
|
| advertId | integer Идентификатор медиакампании |
| name | string Название медиакампании |
| brand | string Название бренда |
| type | integer
|
| status | integer
|
| createTime | string <date-time> Время создания медиакампании |
| endTime | string <date-time> Время завершения медиакампании (при наличии) |
[- {
- "advertId": 123456,
- "name": "тост",
- "brand": "goosb",
- "type": 2,
- "status": 8,
- "createTime": "2023-03-25T20:35:57.116943+03:00"
}, - {
- "advertId": 54321,
- "name": "тест",
- "brand": "bobr",
- "type": 1,
- "status": 7,
- "createTime": "2023-07-24T16:48:20.935599+03:00",
- "endTime": "2023-07-25T20:35:50.104978Z"
}
]Метод позволяет получить информацию об одной медиакампании
| id required | integer Example: id=23569 Идентификатор медиакампании |
| advertId | integer Идентификатор медиакампании |
| name | string Название медиакампании |
| brand | string Название бренда |
| type | integer
|
| status | integer
|
| createTime | string <date-time> Время создания медиакампании |
object | |
Array of objects Информация о баннере.
|
{- "advertId": 23569,
- "name": "Реклама денег принеси",
- "brand": "Plank",
- "type": 2,
- "status": 11,
- "createTime": "2023-07-19T11:13:41.195138+03:00",
- "extended": {
- "reason": "Для возобновления показов пополните бюджет медиакампании",
- "expenses": 10000,
- "from": "2023-07-19T12:05:35.847348Z",
- "to": "2123-07-20T08:14:13.079176+03:00",
- "updated_at": "2023-07-21T13:25:31.129766+03:00",
- "price": 0,
- "budget": 0,
- "operation": 1,
- "contract_id": 0
}, - "items": [
- {
- "id": 68080,
- "name": "Унисон",
- "status": 7,
- "place": 2,
- "budget": 650000,
- "daily_limit": 500,
- "category_name": "Главная",
- "cpm": 351,
- "advert_type": 1,
- "created_at": "2023-11-01T15:40:46.86165+03:00",
- "updated_at": "2023-11-08T23:44:33.248229+03:00",
- "date_from": "2023-11-01T16:05:22.286002Z",
- "date_to": "2023-11-09T17:27:32.745869+03:00",
- "nms": [
- 123456,
- 11111111
], - "bottomText1": "string",
- "bottomText2": "string",
- "message": "string",
- "additionalSettings": 1,
- "receiversCount": 1,
- "subject_id": 6945,
- "subject_name": "Бельё",
- "action_name": "Распродажа! Создай себе домашний уют!",
- "show_hours": [
- {
- "From": 7,
- "To": 8
}
], - "Erid": "string"
}
]
}Метод завершает медиакампанию - переводит её в статус 7.
Допускается максимум 10 запросов в минуту.
1 - черновик3 - отклонено (с возможностью вернуть на модерацию)4 - одобрено5 - запланировано6 - на показах8 - отказался9 - приостановлена продавцом10 - пауза по дневному лимиту11 - пауза по расходу бюджета| advert_id required | integer ID медиакампании |
| reason | string Описание причины завершения |
{- "advert_id": 123456,
- "reason": "Описание причины завершения"
}"Кампания не найдена"Метод позволяет приостанавливать медиакампании.
Переводит приостанавливаемую медиакампанию в статус 9.
Допускается максимум 10 запросов в минуту.
Важно: приостановить медиакампанию можно не больше 10 раз в сутки. Сутки отсчитываются с полуночи по Московскому времени.
4 — одобрено5 — запланировано6 — на показах10 — пауза по дневному лимиту11 — пауза по расходу бюджета| advert_id required | integer ID медиакампании |
| reason | string Описание причины приостановки |
{- "advert_id": 123456,
- "reason": "Описание причины приостановки"
}Метод позволяет запускать приостановленные медиакампании.
После запуска кампания в течение 2-5 минут будет находиться в статусе 4, после чего статус будет изменён на актуальный, в зависимости от конфигурации медиакампании.
Допускается максимум 10 запросов в минуту.
9 - приостановлена продавцом11 - пауза по расходу бюджета| advert_id required | integer ID медиакампании |
| reason | string Описание причины запуска |
{- "advert_id": 123456,
- "reason": "Причина запуска"
}"Кампания не найдена"Метод позволяет получать статистику медиакампаний.
| id | integer ID кампании |
| dates | Array of strings <date> [ items <date > ] Даты, за которые необходимо выдать информацию. |
object Запрошенный временной диапазон. | |
Array of objects (StatsBlok1) Блок статистики |
Запрос с датами
[- {
- "id": 8960367,
- "dates": [
- "2023-10-07",
- "2023-10-06"
]
}, - {
- "id": 9876543,
- "dates": [
- "2023-10-07",
- "2023-12-06"
]
}
]Ответ при запросе с интервалами
[- {
- "interval": {
- "begin": "2023-10-21",
- "end": "2023-10-25"
}, - "stats": [
- {
- "item_id": 62237,
- "item_name": "Gloria Jeans",
- "category_name": "Детям",
- "advert_type": 1,
- "place": 2,
- "views": 11849,
- "clicks": 209,
- "cr": 0.48,
- "ctr": 1.76,
- "date_from": "2023-10-21T00:00:00+03:00",
- "date_to": "2023-10-27T23:59:59+03:00",
- "subject_name": "Одежда",
- "atbs": 4,
- "orders": 1,
- "price": 175000,
- "cpc": 837.32,
- "status": 6,
- "daily_stats": [
- {
- "date": "2023-10-21T00:00:00+03:00",
- "app_type_stats": [
- {
- "app_type": 1,
- "stats": [
- {
- "views": 2017,
- "clicks": 27,
- "atbs": 1,
- "ctr": 1.34
}
]
}
]
}
], - "expenses": 175000,
- "cr1": 1.91,
- "cr2": 25
}
]
}
]Метод позволяет изменять ставку баннера в структуре items.
Изменение возможно только для кампаний в одном из статусов: 4, 5, 6, 9, 10, 11.
Допускается максимум 10 запросов в минуту.
| advert_id required | integer ID медиакампании |
| item_id required | integer ID баннера |
| cpm required | string Новая ставка |
{- "advert_id": 80474,
- "item_id": 41573,
- "cpm": 300
}"\"Ошибка получения айтемов: {x}\", Детали ошибки"