Создание рекламной кампании
Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId, если создаем на организацию с одной физической точкой (или один филиал сети), chainId — если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно.
Request
POST
https://geoadv-api.yandex.ru/priority/v5/create-campaign
Headers
|
Name |
Description |
|
Client-Login* |
Type: string Логин субклиента на кого создаем рекламную кампанию |
Body
application/json
{
"companyId": 0,
"chainId": 0,
"countryGeoId": 0,
"url": "string",
"mapsOnly": false
}
|
Name |
Description |
|
countryGeoId* |
Type: number Географический идентификатор страны. |
|
chainId |
Type: number ID организации, у которых несколько физических точек (сетевые или франшизы) |
|
companyId |
Type: number Идентификатор организации, у которой только одна физическая точка |
|
mapsOnly |
Type: boolean Создание кампании с рекламой только на Яндекс Картах |
|
url |
Type: string Рекламируемый сайт. Не учитывается при указании chainId или mapsOnly. Если передаётся ссылка на телеграм-канал, то создается телеграмная рекламная кампания, подробнее https://business.yandex.ru/subscription/telegram_advertising |
Responses
200 OK
Информация о созданной кампании
Body
application/json
{
"state": "READY",
"id": 0
}
|
Name |
Description |
|
id |
Type: number ID созданной рекламной кампании |
|
state |
Type: string Статус Enum: |
422 Unprocessable Entity
Ошибка при работе
Body
application/json
{
"code": 0,
"message": "string",
"businessCode": "RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства"
}
|
Name |
Description |
|
businessCode |
Type: string Бизнес-код ошибки в текстовом формате. Enum: |
|
code |
Type: number Код ошибки. |
|
message |
Type: string Сообщение об ошибке. |
500 Internal Server Error
Непредвиденная ошибка
No longer supported, please use an alternative and newer version.