Бюджетный запуск

Deprecated

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

Request

POST

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

Body

application/json
{
    "campaignId": 0,
    "budgetType": "OPTIMAL",
    "duration": 0
}

Name

Description

budgetType

Type: BudgetType

Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct

Enum: OPTIMAL, MAXIMAL, MINIMAL, WEB_OPTIMAL, WEB_MAXIMAL, WEB_MINIMAL, CUSTOM, DEFAULT

campaignId

Type: number

ID рекламной кампании.

duration

Type: number

Продолжительность рекламной кампании.

BudgetType

Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct

Type

Description

BudgetType

Enum: OPTIMAL, MAXIMAL, MINIMAL, WEB_OPTIMAL, WEB_MAXIMAL, WEB_MINIMAL, CUSTOM, DEFAULT

Responses

200 OK

ID полученной задачи

422 Unprocessable Entity

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "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

Сообщение об ошибке.

500 Internal Server Error

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

No longer supported, please use an alternative and newer version.