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

Возвращает бюджеты для рекламной кампании. Для кампаний с mapsOnly будет возвращаться только MINIMAL бюджет.

Request

GET

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

Query parameters

Name

Description

campaignId*

Type: number

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

Responses

200 OK

Возращает бюджеты для рекламной кампании

Body

application/json
{
    "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
    "currency": "rub",
    "fixedUntil": "string",
    "price": {
        "MINIMAL": {
            "30": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "90": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "180": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "360": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "monthPrediction": 0
        },
        "OPTIMAL": {
            "30": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "90": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "180": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "360": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "monthPrediction": 0
        },
        "MAXIMAL": {
            "30": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "90": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "180": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "360": {
                "amount": 0,
                "durationPercentDiscount": 0,
                "amountWithoutPromoDiscount": 0,
                "promoDiscount": 0,
                "promoPlusDays": 0,
                "promoBonus": 0
            },
            "monthPrediction": 0
        }
    }
}

Name

Description

...rest

oneOf CampaignPriceDefault

Цены для рекламной кампании

...rest

oneOf CampaignPriceShortPeriod

Цены для рекламной кампании

CampaignPriceDefault

Цены для рекламной кампании

Name

Description

currency

Type: string

Валюта

Enum: rub, kzt, byn, uah

fixedUntil

Type: string

Дата, до которой цена зафиксирована. Доступна для launchType=DEFAULT

launchType

Type: string

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

Enum: DEFAULT // Запуска по умолчанию с конкретными бюджетами, SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов

price

Type: PriceDefault

Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет

CampaignPriceShortPeriod

Цены для рекламной кампании

Name

Description

currency

Type: string

Валюта

Enum: rub, kzt, byn, uah

launchType

Type: string

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

Enum: DEFAULT // Запуска по умолчанию с конкретными бюджетами, SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов

price

Type: PriceShortPeriod

Информация о ценах для SHORT_PERIOD

PriceDefault

Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет

Name

Description

MINIMAL*

Type: DurationWith30

MAXIMAL

Type: DurationWith30

OPTIMAL

Type: DurationWith30

PriceShortPeriod

Информация о ценах для SHORT_PERIOD

Name

Description

amountStep

Type: number

Шаг выбора бюджета в валюте из currency

durationStep

Type: number

Шаг выбора длительности в днях

maxAmount

Type: number

Максимальный бюджет для запуска в валюте из currency

maxDuration

Type: number

Максимальная длительность рекламной кампании в днях

minAmount

Type: number

Минимальный бюджет для запуска в валюте из currency

minDuration

Type: number

Минимальная длительность рекламной кампании в днях

promo

Type: PriceShortPeriodPromo

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

DurationWith30

Name

Description

180

Type: DurationPrice

30

Type: DurationPrice

360

Type: DurationPrice

90

Type: DurationPrice

monthPrediction

Type: number

Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)

PriceShortPeriodPromo

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

Name

Description

bonus

Type: number

Бонус к бюджету в деньгах

discount

Type: number

Скидка в деньгах

minDuration

Type: number

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

minMonthAmount

Type: number

Минимальный месячный бюджет, с которого начинает действовать промокод

minTotalAmount

Type: number

Минимальный бюджет, с которого начинает действовать промокод

percentBonus

Type: number

Бонус к бюджету в процентах

percentBonusLimit

Type: number

Максимальная сумма процентного бонуса в деньгах

percentDiscount

Type: number

Скидка в процентах

DurationPrice

Name

Description

amount

Type: number

Цена за период с примененным промокодом

amountWithoutPromoDiscount

Type: number

Стоимость без учета промокода

durationPercentDiscount

Type: number

Скидка за длительность в процентах

promoBonus

Type: number

Дополнительный бюджет в деньгах по промокоду

promoDiscount

Type: number

Скидка в деньгах по промокоду

promoPlusDays

Type: number

Количество дополнительных дней рекламы по промокоду

500 Internal Server Error

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

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