GetCampaignParams (Live)

Возвращает параметры кампании.

Ограничения

Alert

Метод возвращает только кампании с типом “Текстово-графические объявления”“Text & Image Ads”. Для работы с кампаниями всех типов используйте сервис {#T} API версии 5. Подробнее о типах кампаний...

Новое в версии Live 4

В настройки временного таргетинга показов добавлены параметры BidCoefs и WorkingHolidays.

Добавлен входной параметр Currency и результирующие параметры Currency, CampaignCurrency, BonusDiscount и SourceCampaignID (см. также раздел Real currencies instead of Yandex units).

Добавлен результирующий параметр ClickTrackingEnabled.

Добавлены результирующие параметры DayBudget и DayBudgetEnabled.

Добавлен результирующий параметр AverageCPA для стратегии AverageCPAOptimization.

Добавлен результирующий параметр MobileBidAdjustment.

Добавлен результирующий параметр EnableRelatedKeywords.

Добавлены результирующие параметры ReserveReturn, ROICoef и Profitability для стратегии ROIOptimization.

Добавлен результирующий параметр ExtendedAdTitleEnabled.

Добавлен результирующий параметр MaintainNetworkCPC.

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "GetCampaignParams",
   "param": {
      /* CampaignIDInfo */
      "CampaignID": (int),
      "Currency": (string)
   }
}

Ниже приведено описание параметров.

Параметр

Описание

Требуется

Объект CampaignIDInfo

CampaignID

Идентификатор кампании, параметры которой требуется получить.

Да

Currency

Валюта, в которой должны быть выражены значения денежных параметров в ответе (ставки, бюджеты, статистика).

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании.

Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.). В этом случае, если кампания ведется в реальной валюте, возвращаемые значения конвертируются из валюты кампании в у. е. (см. раздел Real currencies instead of Yandex units).

Если значение отлично от NULL и не совпадает с валютой кампании, возвращается ошибка с кодом 245.

Нет

Результирующие данные

Метод возвращает объект CampaignInfo, содержащий параметры кампании. Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* CampaignInfo */
         "Login": (string),
         "CampaignID": (int),
         "Name": (string),
         "FIO": (string),
         "StartDate": (date),
         "Sum": (float),
         "Rest": (float),
         "BonusDiscount": (float),
         "Shows": (int),
         "Clicks": (int),
         "Currency": (string),
         "CampaignCurrency": (string),
         "SourceCampaignID": (int),
         "Strategy": {
            /* CampaignStrategy */
            "StrategyName": (string),
            "MaxPrice": (float),
            "AveragePrice": (float),
            "AverageCPA": (float),
            "WeeklySumLimit": (float),
            "ClicksPerWeek": (int),
            "GoalID": (int),
            "ReserveReturn": (int),
            "ROICoef": (float),
            "Profitability": (float)
         },
         "ContextStrategy": {
            /* CampaignContextStrategy */
            "StrategyName": (string),
            "ContextLimit": (string),
            "ContextLimitSum": (int),
            "ContextPricePercent": (int),
            "MaxPrice": (float),
            "AveragePrice": (float),
            "AverageCPA": (float),
            "WeeklySumLimit": (float),
            "ClicksPerWeek": (int),
            "GoalID": (int),
            "ReserveReturn": (int),
            "ROICoef": (float),
            "Profitability": (float)
         },
         "AdditionalMetrikaCounters": [
            (int)
            ...
         ],
         "ClickTrackingEnabled": (string),
         "SmsNotification": {
            /* SmsNotificationInfo */
            "MetricaSms": (string),
            "ModerateResultSms": (string),
            "MoneyInSms": (string),
            "MoneyOutSms": (string),
            "SmsTimeFrom": (string),
            "SmsTimeTo": (string)
         },
         "EmailNotification": {
            /* EmailNotificationInfo */
            "Email": (string),
            "WarnPlaceInterval": (int),
            "MoneyWarningValue": (int),
            "SendAccNews": (string),
            "SendWarn": (string)
         },
         "StatusBehavior": (string),
         "Status": (string),
         "TimeTarget": {
            /* TimeTargetInfo */
            "ShowOnHolidays": (string),
            "HolidayShowFrom": (int),
            "HolidayShowTo": (int),
            "DaysHours": [
               {  /* TimeTargetItem */
                  "Hours": [
                     (int)
                     ...
                  ],
                  "Days": [
                     (int)
                     ...
                  ],
                  "BidCoefs": [
                     (int)
                     ...
                  ]
               }
               ...
            ],
            "TimeZone": (string),
            "WorkingHolidays": (string)
         },
         "StatusContextStop": (string),
         "ContextLimit": (string),
         "ContextLimitSum": (int),
         "ContextPricePercent": (int),
         "AutoOptimization": (string),
         "StatusMetricaControl": (string),
         "DisabledDomains": (string),
         "DisabledIps": (string),
         "StatusOpenStat": (string),
         "ConsiderTimeTarget": (string),
         "ManagerName": (string),
         "AgencyName": (string),
         "StatusShow": (string),
         "StatusArchive": (string),
         "StatusActivating": (string),
         "StatusModerate": (string),
         "IsActive": (string),
         "MinusKeywords": [
            (string)
            ...
         ],
         "AddRelevantPhrases": (string),
         "RelevantPhrasesBudgetLimit": (int),
         "SumAvailableForTransfer": (float),
         "DayBudget": {
            /* DayBudgetInfo */
            "Amount": (float),
            "SpendMode": (string)
         },
         "DayBudgetEnabled": (string),
         "MobileBidAdjustment": (int),
         "EnableRelatedKeywords": (string),
         "ExtendedAdTitleEnabled": (string),
         "MaintainNetworkCPC": (string)
      }
      ...
   ]
}

Ниже приведено описание параметров.

Параметр

Описание

Объект CampaignInfo

Login

Логин владельца кампании (логин пользователя Яндекса, в пользу которого ведется рекламная кампания).

При создании кампании прямые рекламодатели указывают собственный логин в Яндексе, рекламные агентства — логин своего клиента. При получении параметров кампании возвращается логин главного представителя рекламодателя.

CampaignID

Идентификатор кампании.

Для создания кампании задают 0, для изменения параметров существующей кампании указывают ее идентификатор.

Name

Название кампании.

FIO

Имя и фамилия владельца кампании.

StartDate

Начало показа объявлений, YYYY-MM-DD. Если не задана, используется дата создания кампании.

Дата может находиться в будущем. В этом случае показ объявлений начинается при наступлении указанной даты, если модератор одобрил объявления и внесены средства на баланс кампании.

ManagerName

Имя персонального менеджера в Яндексе. Заполняется автоматически для кампаний, обслуживаемых персональным менеджером.

AgencyName

Название рекламного агентства. Заполняется автоматически, если создателем кампании является агентство.

Currency

Валюта, в которой выражены денежные значения в ответе (ставки, бюджеты, статистика).

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.).

CampaignCurrency

Валюта, в которой ведется кампания.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, это означает, что кампания ведется в у. е.

SourceCampaignID

Идентификатор исходной кампании в у. е., если текущая кампания была создана автоматически при переходе клиента на работу в валюту (см. раздел Switching to currency). Отсутствует или равен NULL — в противном случае.

Strategy

Определяет стратегию показов на поиске. Содержит объект CampaignStrategy с параметрами стратегии.

ContextStrategy

Определяет стратегию показов в Рекламной сети Яндекса. Содержит объект CampaignContextStrategy с названием и параметрами стратегии.

AdditionalMetrikaCounters

Массив, содержащий идентификаторы счетчиков Яндекс Метрики.

Чтобы удалить идентификаторы счетчиков, передают пустой массив. При отсутствии параметра идентификаторы не меняются.

ClickTrackingEnabled

Автоматически добавлять в ссылку объявления метку yclid с уникальным номером клика — Yes/No. Метка позволяет более точно отслеживать результаты рекламных кампаний в Метрике. Более подробная информация приведена в разделе Разметка ссылок для МетрикиTagging links for Metrica помощи Директа.

SmsNotification

Объект SmsNotificationInfo с параметрами отправки SMS-уведомлений.

Чтобы получать уведомления, необходимо подписаться на них (см. раздел справки Подпишитесь на SMS-уведомленияSubscribe to SMS notifications). Телефонный номер для отправки берется из персональных данных пользователя (см. раздел справки Номера телефоновMobile numbers).

EmailNotification

Объект EmailNotificationInfo с параметрами отправки уведомлений по электронной почте.

TimeTarget

Объект TimeTargetInfo с параметрами временного таргетинга.

AutoOptimization

Включить автоматическое уточнениеавтоматическое уточнение фраз — Yes/No. Предустановленное значение — No.

DisabledDomains

Список мест показа, где не нужно показывать объявления:

  • доменные имена сайтов;
  • идентификаторы мобильных приложений (bundle ID для iOS, package name для Android);
  • имена внешних сетей (SSP).

Не более 1000 мест показа. Значения указывают через запятую, например site.ru,ru.example.app.

DisabledIps

Список IP-адресов, которым не нужно показывать объявления. Адреса указывают через запятую, например 127.0.0.1,127.0.0.2

ConsiderTimeTarget

Рассчитывать цены позиций показа без учета ставок в остановленных объявлениях конкурентов (остановлены в соответствии с расписанием), — Yes/No. Предустановленное значение — No (учитываются все объявления).

MinusKeywords

Массив минус-фраз, общих для всех ключевых фраз кампании.

Минус-фразу следует указывать без минуса перед первым словом.

Не более 7 слов в минус-фразе. Длина каждого слова — не более 35 символов. Суммарная длина минус-фраз в массиве — 20000 символов. Оператор “!” или “+” перед словом не учитывается в суммарной длине.

AddRelevantPhrases

Добавлять дополнительные релевантные фразыдополнительные релевантные фразы к объявлениям — Yes/No.

RelevantPhrasesBudgetLimit

Максимальный процент бюджета, расходуемый на клики по дополнительным релевантным фразамдополнительным релевантным фразам. Значение кратно десяти: 10, 20, ..., 100. Предустановленное значение — 100.

StatusBehavior

Включить поведенческий таргетингповеденческий таргетинг — Yes/No. Предустановленное значение — Yes.

StatusMetricaControl

Останавливать показы при недоступности сайта рекламодателя — Yes/No. Недоступность выявляется по результатам мониторинга, проводимого Директом.

StatusContextStop

Не использовать в Рекламной сети Яндекса фразы, отключенные на поиске за низкий CTR, — Yes/No. Предустановленное значение — No (при отключении на поиске фраза продолжает использоваться в Рекламной сети Яндекса).

Alert

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

StatusOpenStat

При переходе на сайт рекламодателя добавлять к URL метку в формате OpenStat — Yes/No. Предустановленное значение — No.

SumAvailableForTransfer

Сумма, доступная для перевода с помощью метода TransferMoney. Может быть меньше баланса кампании. Возвращается только в случае, если общий счет у рекламодателя не подключен.

Значение выражено в валюте, указанной в параметре Currency.

Если возвращаемое значение конвертируется из валюты кампании в у. е., то оно округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Real currencies instead of Yandex units).

Если значение выражено в реальной валюте, оно не включает НДС.

ContextPricePercent

Параметр продублирован здесь для совместимости со стабильной версией 4 и будет удален в будущем. Актуальный параметр перенесен в объект CampaignContextStrategy.

ContextLimit

Параметр продублирован здесь для совместимости со стабильной версией 4 и будет удален в будущем. Актуальный параметр перенесен в объект CampaignContextStrategy.

ContextLimitSum

Параметр продублирован здесь для совместимости со стабильной версией 4 и будет удален в будущем. Актуальный параметр перенесен в объект CampaignContextStrategy.

DayBudget

Объект DayBudgetInfo с параметрами дневного бюджета кампании.

DayBudgetEnabled

Доступно ли управление дневным бюджетом кампании — Yes/No.

MobileBidAdjustment

Коэффициент настройки цен на мобильных устройствах.

Используется для кампаний и указывается в процентах от ставки на десктопе. Диапазон значений от 50 до 1300. Значение по умолчанию — 100. При данном значении ставка на мобильных устройствах равна ставке на десктопе. Подробнее о коэффициенте можно узнать в разделе Корректировки ставокBid adjustments помощи Директа.

EnableRelatedKeywords

Авторасширение фразАвторасширение фраз включено — Yes/No.

ExtendedAdTitleEnabled

Подстановка части текста объявления в заголовок включена — Yes/No.

MaintainNetworkCPC

Удерживать среднюю цену клика на тематических площадках ниже средней цены на поиске — Yes/No.

Состояние кампании

IsActive

Кампания активна, объявления показываются — Yes/No.

Под активностью понимается состояние кампании, при котором показ объявлений включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивность кампании означает, что показ объявлений заблокирован и не может быть включен автоматически.

Status

Статус кампании, например: “Идут показы”, “Ожидает оплаты”, “На модерации”, “Остановлена”, “Идут показы. Идет активизация”, “Кампания заархивирована” и другие.

StatusShow

Показ объявлений кампании включен — Yes/No. Включение и выключение выполняется методами StopCampaign и ResumeCampaign.

Разрешение показа на уровне кампании не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявления проверены модератором, разрешен показ на уровне объявлений (метод ResumeBanners). Фактическому показу соответствует значение Yes в параметре IsActive.

StatusArchive

Состояние архивации кампании:

  • Yes — кампания помещена в архив;
  • No — кампания не в архиве;
  • Pending — происходит перенос кампании в архив либо возврат из архива;
  • CurrencyConverted — кампания автоматически заархивирована при переходе клиента на работу в валюте и не может быть разархивирована (см. раздел Real currencies instead of Yandex units).

Перенос в архив выполняют с помощью метода ArchiveCampaign. Для возврата из архива служит метод UnArchiveCampaign.

StatusActivating

Состояние активизации кампании:

  • Yes — активизирована;
  • Pending — ожидается активизация.

StatusModerate

Результат проверки модератором:

  • Yes — модератор одобрил хотя бы одно объявление;
  • No — модератор отклонил все объявления;
  • New — объявления не отправлялись на проверку (статус кампании “Черновик”);
  • Pending — проводится проверка.

Для отправки на проверку служит метод ModerateBanners.

Статистика

Sum

Если у рекламодателя подключен общий счет — сумма израсходованных средств за все время существования кампании.

Если общий счет не подключен — сумма средств, зачисленных на баланс кампании за время ее существования.

Значение выражено в валюте, указанной в параметре Currency.

Если возвращаемое значение конвертируется из валюты кампании в у. е., то оно округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Real currencies instead of Yandex units).

Если значение выражено в реальной валюте, оно не включает НДС.

Rest

Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен).

Note

Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании.

Значение выражено в валюте, указанной в параметре Currency.

Если возвращаемое значение конвертируется из валюты кампании в у. е., то оно округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Real currencies instead of Yandex units).

Если значение выражено в реальной валюте, оно не включает НДС.

BonusDiscount

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

Shows

Количество показов за время существования кампании.

Clicks

Количество кликов за время существования кампании.

Объект CampaignStrategy

StrategyName

Стратегия на поиске. Ниже перечислены возможные значения.

  • ShowsDisabled — выключить показ объявлений на поиске. Это необходимо для использования автоматической стратегии в Рекламной сети Яндекса. Показ на поиске невозможно выключить, если для Рекламной сети применяется стратегия Default.

Стратегии с ручным управлением ставками на поиске:

  • HighestPosition — стратегия “Наивысшая доступная позиция”“Highest available position”;
  • LowestCost — стратегия “Показ в блоке по минимальной цене”“Cheapest position in ad block”;
  • LowestCostPremium — стратегия “Показ в блоке по минимальной цене”“Cheapest position in ad block”, но объявления показываются только в спецразмещении;
  • LowestCostGuarantee — стратегия “Показ под результатами поиска”“Impressions below search results” (в нижнем блоке по наименьшей цене);
  • RightBlockHighest — стратегия “Показ под результатами поиска”“Impressions below search results” (в нижнем блоке на наивысшей позиции, доступной при указанной ставке).

Автоматические стратегии на поиске:

  • WeeklyBudget — стратегия “Недельный бюджет: максимум кликов”“Weekly budget: maximum clicks” (обязательный параметр WeeklySumLimit, дополнительный MaxPrice);
  • CPAOptimizer — стратегия “Недельный бюджет: максимальная конверсия”“Weekly budget: maximum conversion rate” (обязательные параметры WeeklySumLimit и GoalID, дополнительный MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа;
  • AverageClickPrice — стратегия “Средняя цена клика”“Average CPC” (обязательный параметр AveragePrice, дополнительный WeeklySumLimit);
  • WeeklyPacketOfClicks — стратегия “Недельный пакет кликов”“Weekly click package” (обязательный параметр ClicksPerWeek, дополнительные MaxPrice или AveragePrice);
  • AverageCPAOptimization — стратегия “Средняя цена конверсии”“Average CPA” (обязательные параметры AverageCPA и GoalID, дополнительные WeeklySumLimit и MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа;
  • ROIOptimization — стратегия “Средняя рентабельность инвестиций”“Average ROI” (обязательные параметры ReserveReturn, ROICoef, GoalID, дополнительные Profitability, WeeklySumLimit и MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа.

MaxPrice

Максимальная ставка (в валюте, указанной в параметре Currency) для стратегий WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization и ROIOptimization.

Если возвращаемое значение конвертируется из валюты кампании в у. е., то оно округляется вниз с точностью до шага торгов (0,01 у. е., см. также раздел Real currencies instead of Yandex units).

AveragePrice

Средняя ставка (в валюте, указанной в параметре Currency) для стратегии AverageClickPrice. Также может задаваться для стратегии WeeklyPacketOfClicks.

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

AverageCPA

Средняя цена конверсии (в валюте, указанной в параметре Currency) для стратегии AverageCPAOptimization.

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

WeeklySumLimit

Максимальный недельный бюджет (в валюте, указанной в параметре Currency) для стратегии WeeklyBudget и CPAOptimizer. Также может задаваться для стратегий AverageClickPrice, AverageCPAOptimization и ROIOptimization.

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

ClicksPerWeek

Количество кликов в неделю для стратегии WeeklyPacketOfClicks.

GoalID

Идентификатор целицели Яндекс Метрики для стратегии CPAOptimizer, AverageCPAOptimization и ROIOptimization.

Значение 0 — все цели, настроенные на сайте (кроме составных).

Список подходящих целей получают с помощью метода GetStatGoals.

ReserveReturn

Максимальный процент сэкономленных средств для стратегии ROIOptimization, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра ROICoef.

Значение от 0 до 100, кратное десяти: 0, 10, 20... 100.

ROICoef

Желаемая средняя рентабельность инвестиций за неделю для стратегии ROIOptimization.

Profitability

Процент выручки, являющийся себестоимостью товаров или услуг, для стратегии ROIOptimization.

Значение от 0 до 100, округляется до двух знаков после запятой.

Объект CampaignContextStrategy

StrategyName

Стратегия в Рекламной сети Яндекса. Ниже перечислены возможные значения.

  • ShowsDisabled — выключить показ объявлений в Рекламной сети Яндекса. Это возможно, только если показ не выключен на поиске.

Стратегии с ручным управлением ставками в Рекламной сети Яндекса:

  • Default — стратегия “Процент от цены на поиске”. Процент задают в параметре ContextPricePercent. Дополнительные параметры — ContextLimit и ContextLimitSum. Данная стратегия применяется для кампаний, которым стратегия не назначена явно.

  • MaximumCoverage — стратегия “Максимальный доступный охват”“Maximum audience coverage”. Ставки задают с помощью одного из методов: CreateOrUpdateBanners, SetAutoPrice (Live), UpdatePrices.

    Warning

    Стратегия MaximumCoverage не доступна, если на поиске выбрана любая автоматическая стратегия.

Автоматические стратегии в Рекламной сети Яндекса:

Warning

Автоматические стратегии в Рекламной сети доступны, только если на поиске выключен показ объявлений (стратегия ShowsDisabled).

  • WeeklyBudget — стратегия “Недельный бюджет: максимум кликов”“Weekly budget: maximum clicks” (обязательный параметр WeeklySumLimit, дополнительный MaxPrice);
  • CPAOptimizer — стратегия “Недельный бюджет: максимальная конверсия”“Weekly budget: maximum conversion rate” (обязательные параметры WeeklySumLimit и GoalID, дополнительный MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа;
  • AverageClickPrice — стратегия “Средняя цена клика”“Average CPC” (обязательный параметр AveragePrice, дополнительный WeeklySumLimit);
  • WeeklyPacketOfClicks — стратегия “Недельный пакет кликов”“Weekly click package” (обязательный параметр ClicksPerWeek, дополнительные MaxPrice или AveragePrice);
  • AverageCPAOptimization — стратегия “Средняя цена конверсии”“Average CPA” (обязательные параметры AverageCPA и GoalID, дополнительные WeeklySumLimit и MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа;
  • ROIOptimization — стратегия “Средняя рентабельность инвестиций”“Average ROI” (обязательные параметры ReserveReturn, ROICoef, GoalID, дополнительные Profitability, WeeklySumLimit и MaxPrice); см. условия подключения стратегииусловия подключения стратегии в помощи Директа.

ContextLimit

Ограничение бюджета на показ объявлений в Рекламной сети Яндекса:

  • Default — бюджет не ограничен (предустановленное значение);
  • Limited — бюджет ограничен значением параметра ContextLimitSum.

Чтобы не тратить средства на показ в Рекламной сети Яндекса, показ отключают с помощью стратегии ShowsDisabled (параметр StrategyName).

ContextLimitSum

Максимальный процент бюджета, расходуемый для показа в Рекламной сети Яндекса на тематических площадках. Значение кратно десяти: 10, 20, ..., 100. При не заданном значении (null) бюджет не ограничен (равнозначно Default в параметре ContextLimit).

ContextPricePercent

Параметр для вычисления цены за клик в Рекламной сети Яндекса на тематических площадках. Используется для стратегии Default. Задается в процентах от цены за клик на поиске. Значение кратно десяти: 10, 20, ..., 100.

Значение 100 делает цену за клик в Рекламной сети равной цене на поиске.

MaxPrice

Максимальная ставка (в валюте, указанной в параметре Currency) для стратегий WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization и ROIOptimization.

Если возвращаемое значение конвертируется из валюты кампании в у. е., то оно округляется вниз с точностью до шага торгов (0,01 у. е., см. также раздел Real currencies instead of Yandex units).

AveragePrice

Средняя ставка (в валюте, указанной в параметре Currency) для стратегии AverageClickPrice. Также может задаваться для стратегии WeeklyPacketOfClicks.

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

AverageCPA

Средняя цена конверсии (в валюте, указанной в параметре Currency) для стратегии AverageCPAOptimization.

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

WeeklySumLimit

Максимальный недельный бюджет (в валюте, указанной в параметре Currency) для стратегии WeeklyBudget и CPAOptimizer. Также может задаваться для стратегий AverageClickPrice, AverageCPAOptimization и ROIOptimization.

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

ClicksPerWeek

Количество кликов в неделю для стратегии WeeklyPacketOfClicks.

GoalID

Идентификатор целицели Яндекс Метрики для стратегии CPAOptimizer, AverageCPAOptimization и ROIOptimization.

Значение 0 — все цели, настроенные на сайте (кроме составных).

Список подходящих целей получают с помощью метода GetStatGoals.

ReserveReturn

Максимальный процент сэкономленных средств для стратегии ROIOptimization, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра ROICoef.

Значение от 0 до 100, кратное десяти: 0, 10, 20... 100.

ROICoef

Желаемая средняя рентабельность инвестиций за неделю для стратегии ROIOptimization.

Profitability

Процент выручки, являющийся себестоимостью товаров или услуг, для стратегии ROIOptimization.

Значение от 0 до 100, округляется до двух знаков после запятой.

Объект SmsNotificationInfo

MetricaSms

Сообщать результаты мониторинга сайтов по данным Яндекс Метрики — Yes/No.

ModerateResultSms

Сообщать результаты модерации объявлений — Yes/No.

MoneyInSms

Сообщать о зачислении средств на баланс кампании — Yes/No. Предустановленное значение — No.

Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета.

MoneyOutSms

Сообщать об исчерпании средств на балансе кампании — Yes/No. Предустановленное значение — No.

Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета.

SmsTimeFrom

Время, начиная с которого разрешено отправлять SMS о событиях, связанных с кампанией. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”.

SmsTimeTo

Время, до которого разрешено отправлять SMS о событиях, связанных с кампанией. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”.

Объект EmailNotificationInfo

SendWarn

Отправлять уведомления по электронной почте — Yes/No. Предустановленное значение — No.

Email

Адрес электронной почты для отправки уведомлений о событиях, связанных с кампанией.

WarnPlaceInterval

Периодичность проверки позиции объявления — 15, 30 или 60 минут.

Уведомление отправляется, если объявление переместилось на более низкую позицию, чем та, которую обеспечивала ставка на момент установки.

MoneyWarningValue

Минимальный баланс, при уменьшении до которого отправляется уведомление. Задается в процентах от суммы последнего платежа. Предустановленное значение — 20.

Если у клиента подключен общий счет, возвращается значение соответствующего параметра общего счета.

SendAccNews

Сообщать о событиях, связанных с кампанией, — Yes/No. Задается для кампаний, обслуживаемых персональным менеджером в Яндексе. Предустановленное значение — No.

Объект TimeTargetInfo

ShowOnHolidays

Показывать объявления в праздничные нерабочие дни — Yes/No (к этим дням не относятся обычные субботы и воскресенья). Предустановленное значение — Yes.

HolidayShowFrom

Час, начиная с которого объявления показываются в праздничные нерабочие дни. Если параметр отсутствует, показы идут по расписанию из параметра DaysHours.

HolidayShowTo

Час, до которого объявления показываются в праздничные нерабочие дни. Если параметр отсутствует, показы идут по расписанию из параметра DaysHours.

DaysHours

Массив объектов TimeTargetItem, определяющих расписание показов (временной таргетинг).

TimeZone

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

WorkingHolidays

Менять расписание показов при переносе рабочего дня на субботу или воскресенье — Yes/No.

Например, если рабочий день перенесен с понедельника на субботу, при значении Yes в рабочую субботу пойдут показы по расписанию понедельника, а в нерабочий понедельник, — по расписанию субботы.

Объект TimeTargetItem

Hours

Массив целых чисел от 0 до 23. Число 0 соответствует интервалу времени с 00:00 по 00:59 включительно, число 1 — с 01:00 по 01:59 включительно и так далее.

Предустановленное значение — массив чисел от 0 до 23 соответствует полным суткам.

Days

Массив целых чисел от 1 до 7. Число 1 соответствует понедельнику, число 7 — воскресенью. В указанные дни объявления показываются в соответствии со значением параметра Hours.

Предустановленное значение — массив чисел от 1 до 7 соответствует полной неделе.

BidCoefs

Массив коэффициентов, которые увеличивают или уменьшают цены за клик в определенные часы. Применяется для стратегий с ручным управлением ставками. Коэффициенты указывают в процентах, значение должно быть кратно десяти: 0, 10, 20... 200.

Необходимо задавать столько коэффициентов, сколько часов указано в массиве Hours. Каждый коэффициент соотносится с определенным часом в порядке следования в массиве.

Если параметр отсутствует, ранее заданные коэффициенты не изменяются.

Объект DayBudgetInfo

Amount

Дневной бюджет кампании (в валюте, указанной в параметре Currency).

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

SpendMode

Распределять дневной бюджет равномерно на весь день — Default/Stretched. При значении Default дневной бюджет может исчерпаться, а показы завершиться ранее окончания дня.

Примеры входных данных

Python

{
   'CampaignID': 1327944
}

PHP

array(
   'CampaignID' =1327944
)

Perl

{
   'CampaignID' =1327944
}
Previous
GetCampaignParams
Next
GetCampaignsList