Объект содержит сведения о рекламной кампании, параметры показа объявлений, краткую статистику.

Внимание. В API Директа версии 4 и Live 4 поддерживаются только кампании с типом «Текстово-графические объявления». Для работы с кампаниями всех типов используйте сервис Campaigns API версии 5. Подробнее о типах кампаний...

Кампания имеет идентификатор — CampaignID. Он возвращается при создании кампании методом CreateOrUpdateCampaign и используется для получения параметров в методе GetCampaignsParams.

Следующая структура показывает минимальный состав параметров кампании.

params = {
   "CampaignID": (int),
   "Login": (string),
   "Name": (string),
   "FIO": (string),
   "Strategy":{
      "StrategyName": (string)
   },
   "EmailNotification":{
      "Email": (string),
      "SendWarn": (string),
      "WarnPlaceInterval": (int),
      "MoneyWarningValue": (int),
      "SendAccNews": (string)
   },
}

Для кампании предусмотрены и другие параметры, описанные ниже. Полный список параметров приведен в ответе метода GetCampaignsParams. Основные параметры кампании также можно получить с помощью методов GetCampaignsList и GetCampaignsListFilter.

Общие данные

Параметры Name, FIO и Login содержат название кампании и сведения о владельце, параметр StartDate — дату начала кампании.

Параметры ManagerName и AgencyName заполняются автоматически после создания кампании.

Статистика кампании

Параметры Rest и Sum содержат финансовые показатели кампании (их также возвращает метод GetBalance). В параметре SumAvailableForTransfer указана сумма, доступная для перевода (см. Перевод средств).

В параметрах Shows, Clicks содержится краткая статистика кампании. О получении детального отчета см. Подробная статистика.

Статус и состояние

Параметр Status описывает текущее состояние кампании в понятном человеку виде.

Параметр StatusModerate показывает результат проверки модератором. Кампания считается прошедшей проверку, если модератор одобрил хотя бы одно объявление. Только после этого можно зачислять средства на баланс кампании и формировать счета-фактуры (см. Финансовые операции).

Параметр StatusShow содержит статус показа объявлений, который можно переключать. Параметр IsActive отражает фактическое состояние показов и изменяется автоматически. Также о начале показов позволяет судить параметр StatusActivating.

Неактивную кампанию можно перенести в архив. При этом меняется значение параметра StatusArchive. Архивация больших кампаний, у которых много объявлений и фраз, может занимать до нескольких минут. В это время параметр имеет значение «Pending».

Таргетинг

Таргетинг определяет условия, при которых показываются объявления. Настройка условий охватывает кампанию, объявления, фразы и описывается в разделе Таргетинг.

Стратегии управления ставками

Объявления отбираются для показа по принципу аукциона. При настройке объявлений рекламодатели делают ставки. Объявление показывается, если ставка превышает ставки конкурентов и минимальную цену, назначенную Директом.

Ставки можно задавать вручную для фраз, а можно использовать автоматические стратегии управления ставками (см. Стратегии показа).

Дневной бюджет

Установка дневного бюджета возможна только для кампаний с ручными стратегиями показа.

Необязательная структура DayBudget содержит параметры Amount и SpendMode.

Сброс дневного бюджета осуществляется при передаче значения 0 в параметре Amount. Также сброс дневного бюджета осуществляется при изменении стратегии на автоматическую.

Уведомления

Обязательная структура EmailNotification содержит параметры Email, SendWarn, WarnPlaceInterval, MoneyWarningValue, SendAccNews.

Необязательная структура SmsNotification содержит параметры MetricaSms, ModerateResultSms, MoneyInSms, MoneyOutSms, SmsTimeFrom, SmsTimeTo.

Внимание. Если у рекламодателя подключен общий счет, параметры MoneyInSMS, MoneyOutSMS, MoneyWarningValue являются параметрами общего счета, а не кампании. Подробнее см. в разделе Работа с общим счетом.

Прочее

С помощью параметра StatusOpenStat включается функция, которая добавляет метку в формате OpenStat к ссылкам на сайт рекламодателя.