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

Возвращает бюджеты для рекламной кампании. Для кампаний с 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": "example",
  "price": {
    "MINIMAL": {
      "30": {
        "amount": 0.5,
        "durationPercentDiscount": 0.5,
        "amountWithoutPromoDiscount": 0.5,
        "promoDiscount": 0.5,
        "promoPlusDays": 0.5,
        "promoBonus": 0.5
      },
      "90": null,
      "180": null,
      "360": null,
      "monthPrediction": 0.5
    },
    "OPTIMAL": null,
    "MAXIMAL": null
  }
}

One of 2 types

Type: CampaignPriceDefault

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

Example

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

Type: CampaignPriceShortPeriod

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

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "currency": "rub",
  "price": {
    "minDuration": 0.5,
    "maxDuration": 0.5,
    "durationStep": 0.5,
    "minAmount": 0.5,
    "maxAmount": 0.5,
    "amountStep": 0.5,
    "promo": {
      "discount": 0.5,
      "bonus": 0.5,
      "minTotalAmount": 0.5,
      "minMonthAmount": 0.5,
      "minDuration": 0.5,
      "percentDiscount": 0.5,
      "percentBonus": 0.5,
      "percentBonusLimit": 0.5
    }
  }
}

DurationPrice

Name	Description
amount	Type: number Цена за период с примененным промокодом
amountWithoutPromoDiscount	Type: number Стоимость без учета промокода
durationPercentDiscount	Type: number Скидка за длительность в процентах
promoBonus	Type: number Дополнительный бюджет в деньгах по промокоду
promoDiscount	Type: number Скидка в деньгах по промокоду
promoPlusDays	Type: number Количество дополнительных дней рекламы по промокоду

Example

{
  "amount": 0.5,
  "durationPercentDiscount": 0.5,
  "amountWithoutPromoDiscount": 0.5,
  "promoDiscount": 0.5,
  "promoPlusDays": 0.5,
  "promoBonus": 0.5
}

DurationWith30

Name	Description
180	Type: DurationPrice Example `{ "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }`
30	Type: DurationPrice Example `{ "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }`
360	Type: DurationPrice Example `{ "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }`
90	Type: DurationPrice Example `{ "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }`
monthPrediction	Type: number Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)

Example

{
  "30": {
    "amount": 0.5,
    "durationPercentDiscount": 0.5,
    "amountWithoutPromoDiscount": 0.5,
    "promoDiscount": 0.5,
    "promoPlusDays": 0.5,
    "promoBonus": 0.5
  },
  "90": null,
  "180": null,
  "360": null,
  "monthPrediction": 0.5
}

PriceDefault

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

Name	Description
MINIMAL	Type: DurationWith30 Example `{ "30": { "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }, "90": null, "180": null, "360": null, "monthPrediction": 0.5 }`
MAXIMAL	Type: DurationWith30 Example `{ "30": { "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }, "90": null, "180": null, "360": null, "monthPrediction": 0.5 }`
OPTIMAL	Type: DurationWith30 Example `{ "30": { "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }, "90": null, "180": null, "360": null, "monthPrediction": 0.5 }`

Example

{
  "MINIMAL": {
    "30": {
      "amount": 0.5,
      "durationPercentDiscount": 0.5,
      "amountWithoutPromoDiscount": 0.5,
      "promoDiscount": 0.5,
      "promoPlusDays": 0.5,
      "promoBonus": 0.5
    },
    "90": null,
    "180": null,
    "360": null,
    "monthPrediction": 0.5
  },
  "OPTIMAL": null,
  "MAXIMAL": null
}

CampaignPriceDefault

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

Name	Description
currency	Type: string Валюта Enum: `rub`, `kzt`, `byn`, `uah`
fixedUntil	Type: string Дата, до которой цена зафиксирована. Доступна для launchType=DEFAULT Example: `example`
launchType	Type: string Тип запуска рекламной кампании Enum: `DEFAULT // Запуска по умолчанию с конкретными бюджетами`, `SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов`
price	Type: PriceDefault Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет Example `{ "MINIMAL": { "30": { "amount": 0.5, "durationPercentDiscount": 0.5, "amountWithoutPromoDiscount": 0.5, "promoDiscount": 0.5, "promoPlusDays": 0.5, "promoBonus": 0.5 }, "90": null, "180": null, "360": null, "monthPrediction": 0.5 }, "OPTIMAL": null, "MAXIMAL": null }`

Example

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

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 Скидка в процентах

Example

{
  "discount": 0.5,
  "bonus": 0.5,
  "minTotalAmount": 0.5,
  "minMonthAmount": 0.5,
  "minDuration": 0.5,
  "percentDiscount": 0.5,
  "percentBonus": 0.5,
  "percentBonusLimit": 0.5
}

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 Информация о промокоде, если он применён и активен Example `{ "discount": 0.5, "bonus": 0.5, "minTotalAmount": 0.5, "minMonthAmount": 0.5, "minDuration": 0.5, "percentDiscount": 0.5, "percentBonus": 0.5, "percentBonusLimit": 0.5 }`

Example

{
  "minDuration": 0.5,
  "maxDuration": 0.5,
  "durationStep": 0.5,
  "minAmount": 0.5,
  "maxAmount": 0.5,
  "amountStep": 0.5,
  "promo": {
    "discount": 0.5,
    "bonus": 0.5,
    "minTotalAmount": 0.5,
    "minMonthAmount": 0.5,
    "minDuration": 0.5,
    "percentDiscount": 0.5,
    "percentBonus": 0.5,
    "percentBonusLimit": 0.5
  }
}

CampaignPriceShortPeriod

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

Name	Description
currency	Type: string Валюта Enum: `rub`, `kzt`, `byn`, `uah`
launchType	Type: string Тип запуска рекламной кампании Enum: `DEFAULT // Запуска по умолчанию с конкретными бюджетами`, `SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов`
price	Type: PriceShortPeriod Информация о ценах для SHORT_PERIOD Example `{ "minDuration": 0.5, "maxDuration": 0.5, "durationStep": 0.5, "minAmount": 0.5, "maxAmount": 0.5, "amountStep": 0.5, "promo": { "discount": 0.5, "bonus": 0.5, "minTotalAmount": 0.5, "minMonthAmount": 0.5, "minDuration": 0.5, "percentDiscount": 0.5, "percentBonus": 0.5, "percentBonusLimit": 0.5 } }`

Example

{
  "launchType": "DEFAULT // Запуска по умолчанию с конкретными бюджетами",
  "currency": "rub",
  "price": {
    "minDuration": 0.5,
    "maxDuration": 0.5,
    "durationStep": 0.5,
    "minAmount": 0.5,
    "maxAmount": 0.5,
    "amountStep": 0.5,
    "promo": {
      "discount": 0.5,
      "bonus": 0.5,
      "minTotalAmount": 0.5,
      "minMonthAmount": 0.5,
      "minDuration": 0.5,
      "percentDiscount": 0.5,
      "percentBonus": 0.5,
      "percentBonusLimit": 0.5
    }
  }
}

500 Internal Server Error

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

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

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

Создание рекламной кампании