Запуск рекламной кампании

Запускает рекламную кампанию. На кошельке должны быть деньги. Происходит списание денег с кошелька и старт кампании. Нужно вызывать только для кампании в статусе waiting, stopped, finished. В противном случае произойдет продление еще не оконченной кампании

Request

POST

https://geoadv-api.yandex.ru/priority/v5/launch-campaign

Body

application/json

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "campaignId": 0.5,
  "monthAmount": 0.5,
  "duration": 90
}

One of 2 types

Type: LaunchDefaultCampaignV5

Запрос на запуск рекламной кампании

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "campaignId": 0.5,
  "monthAmount": 0.5,
  "duration": 90
}

Type: LaunchShortPeriodCampaignV5

Запрос на запуск рекламной кампании

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "campaignId": 0.5,
  "totalAmount": 0.5,
  "duration": 0.5
}

LaunchDefaultCampaignV5

Запрос на запуск рекламной кампании

Name	Description
campaignId	Type: number ID рекламной кампании
duration	Type: number Продолжительность рекламной кампании для launchType=DEFAULT Enum: `90`, `180`, `360`
launchType	Type: string Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT Enum: `DEFAULT // Запуска по умолчанию с конкретными бюджетами`, `SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов`
monthAmount	Type: number Сумма месячного бюджета рекламной кампании. Должна быть не меньше значения в MINIMAL бюджете за 30 дней. Обязателен при launchType=DEFAULT, иначе игнорируется

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "campaignId": 0.5,
  "monthAmount": 0.5,
  "duration": 90
}

LaunchShortPeriodCampaignV5

Запрос на запуск рекламной кампании

Name	Description
campaignId	Type: number ID рекламной кампании
duration	Type: number Продолжительность рекламной кампании для launchType=SHORT_PERIOD, должна быть в пределах minDuration и maxDuration включительно
launchType	Type: string Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT Enum: `DEFAULT // Запуска по умолчанию с конкретными бюджетами`, `SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов`
totalAmount	Type: number Сумма всего бюджета рекламной кампании. Должна быть в пределах minAmount и maxAmount включительно. Обязателен при launchType=SHORT_PERIOD, иначе игнорируется

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "campaignId": 0.5,
  "totalAmount": 0.5,
  "duration": 0.5
}

Responses

200 OK

Рекламная кампания запущена

422 Unprocessable Entity

Ошибка при работе

Body

application/json

{
  "code": 0.5,
  "message": "example",
  "businessCode": "RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания"
}

Name	Description
businessCode	Type: string Бизнес-код ошибки в текстовом формате. Enum: `RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания`, `NOT_ENOUGH_MONEY // недостаточно средств на кошельке`, `PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах`, `BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах`, `NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты`, `CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку`, `CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление`, `UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты`, `UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается`, `BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны`
code	Type: number Код ошибки.
message	Type: string Сообщение об ошибке. Example: `example`

500 Internal Server Error

Непредвиденная ошибка

Была ли статья полезна?

Запуск рекламной кампании

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