CreateOrUpdateCampaign (Live)

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

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Ограничения

Не более 100 вызовов в сутки для редактирования одной кампании. Не более 100 вызовов в сутки для создания кампаний.

Изменять настройки дневного бюджета можно не более трех раз в сутки.

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

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

Добавлен параметр AdditionalMetrikaCounters.

Добавлен параметр ContextStrategy, устанавливающий стратегию показов в Рекламной сети Яндекса. Параметры ContextLimit, ContextLimitSum, ContextPricePercent перенесены под параметр ContextStrategy.

В настройки временного таргетинга добавлен параметр BidCoefs, с помощью которого можно увеличивать или уменьшать цены за клик в определенные часы. Также добавлен параметр WorkingHolidays.

Для Рекламной сети Яндекса доступны автоматические стратегии управления ставками (параметр StrategyName в объекте CampaignContextStrategy).

Добавлен входной параметр Currency (см. также раздел Реальные валюты вместо у. е.).

Добавлен входной параметр ClickTrackingEnabled.

Добавлен входной параметр DayBudget.

Добавлен входной параметр AverageCPA для стратегии AverageCPAOptimization.

Добавлен входной параметр MobileBidAdjustment.

Добавлен входной параметр EnableRelatedKeywords.

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

Добавлен входной параметр ExtendedAdTitleEnabled.

Добавлен входной параметр MaintainNetworkCPC.

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

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

{
   "method": "CreateOrUpdateCampaign",
   "param": {
      /* CampaignInfo */
      "Login": (string),
      "CampaignID": (int),
      "Name": (string),
      "FIO": (string),
      "StartDate": (date),
      "Currency": (string),
      "Strategy": {
         /* CampaignStrategy */
         "StrategyName": (string),
         "MaxPrice": (float),
         "AveragePrice": (float),
         "WeeklySumLimit": (float),
         "AverageCPA": (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),
      "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),
      "MinusKeywords": [
         (string)
         ...
      ],
      "AddRelevantPhrases": (string),
      "RelevantPhrasesBudgetLimit": (int),
      "DayBudget": {
         /* DayBudgetInfo */
         "Amount": (float),
         "SpendMode": (string)
      },
      "MobileBidAdjustment": (int),
      "EnableRelatedKeywords": (string),
      "ExtendedAdTitleEnabled": (string),
      "MaintainNetworkCPC": (string)
   }
}

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

Параметр Описание Требуется
Объект CampaignInfo
Login

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

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

Да
CampaignID

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

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

Да
Name

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

Да
FIO

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

Да
Strategy

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

Да
ContextStrategy

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

Нет
AdditionalMetrikaCounters

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

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

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

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

Да
SmsNotification

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

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

Нет
StartDate

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

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

Нет
Currency

Валюта, в которой указаны денежные параметры стратегий.

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

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

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

Нет
StatusBehavior

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

Нет
TimeTarget

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

Нет
StatusContextStop

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

Ограничение.

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

Нет
ContextLimit

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

Нет
ContextLimitSum

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

Нет
ContextPricePercent

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

Нет
AutoOptimization

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

Нет
StatusMetricaControl

Останавливать показы при недоступности сайта рекламодателя — Yes/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

Нет
StatusOpenStat

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

Нет
ConsiderTimeTarget

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

Нет
MinusKeywords

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

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

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

Нет
AddRelevantPhrases

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

Нет
RelevantPhrasesBudgetLimit

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

Нет
DayBudget

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

Доступно ли управление дневным бюджетом, зависит от значения параметра DayBudgetEnabled, возвращаемого методами GetCampaignsParams (Live), GetCampaignParams (Live), GetCampaignsList (Live), GetCampaignsListFilter (Live). Если настройка недоступна, то при попытке передать параметр DayBudget возникает ошибка с кодом 71.

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

Нет
MobileBidAdjustment

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

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

Нет
EnableRelatedKeywords Включить Авторасширение фраз — Yes/No. Предустановленное значение — Yes. Нет
ExtendedAdTitleEnabled Включить подстановку части текста объявления в заголовок — Yes/No. Предустановленное значение — Yes. Нет
MaintainNetworkCPC Удерживать среднюю цену клика на тематических площадках ниже средней цены на поиске — Yes/No. Предустановленное значение — Yes. Нет
Объект CampaignStrategy
StrategyName

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

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

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

  • HighestPosition — стратегия «Наивысшая доступная позиция»;
  • LowestCost — стратегия «Показ в блоке по минимальной цене»;
  • LowestCostPremium — стратегия «Показ в блоке по минимальной цене», но объявления показываются только в спецразмещении;
  • LowestCostGuarantee — стратегия «Показ под результатами поиска» (в нижнем блоке по наименьшей цене);
  • RightBlockHighest — стратегия «Показ под результатами поиска» (в нижнем блоке на наивысшей позиции, доступной при указанной ставке).

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

  • WeeklyBudget — стратегия «Недельный бюджет: максимум кликов» (обязательный параметр WeeklySumLimit, дополнительный MaxPrice);
  • CPAOptimizer — стратегия «Недельный бюджет: максимальная конверсия» (обязательные параметры WeeklySumLimit и GoalID, дополнительный MaxPrice); см. условия подключения стратегии в помощи Директа;
  • AverageClickPrice — стратегия «Средняя цена клика» (обязательный параметр AveragePrice, дополнительный WeeklySumLimit);
  • WeeklyPacketOfClicks — стратегия «Недельный пакет кликов» (обязательный параметр ClicksPerWeek, дополнительные MaxPrice или AveragePrice);
  • AverageCPAOptimization — стратегия «Средняя цена конверсии» (обязательные параметры AverageCPA и GoalID, дополнительные WeeklySumLimit и MaxPrice); см. условия подключения стратегии в помощи Директа;
  • ROIOptimization — стратегия «Средняя рентабельность инвестиций» (обязательные параметры ReserveReturn, ROICoef, GoalID, дополнительные Profitability, WeeklySumLimit и MaxPrice); см. условия подключения стратегии в помощи Директа.
Да
MaxPrice

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

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

Если значение перед сохранением конвертируется из у. е. в валюту кампании, то оно округляется вниз с точностью до шага торгов в этой валюте (см. раздел Реальные валюты вместо у. е.).

Нет
AveragePrice

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

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

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

Для стратегии AverageClickPrice
AverageCPA

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

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

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

Для стратегии AverageCPAOptimization
WeeklySumLimit

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

Минимальное значение представлено в таблице Валютные параметры и ограничения. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

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

Для стратегии WeeklyBudget и CPAOptimizer
ClicksPerWeek Количество кликов в неделю для стратегии WeeklyPacketOfClicks. Для стратегии WeeklyPacketOfClicks
GoalID

Идентификатор цели Яндекс.Метрики для стратегии CPAOptimizer, AverageCPAOptimization или ROIOptimization (подходят только несоставные цели).

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

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

Для стратегии CPAOptimizer, AverageCPAOptimization и ROIOptimization
ReserveReturn

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

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

Для стратегии ROIOptimization
ROICoef Желаемая средняя рентабельность инвестиций за неделю для стратегии ROIOptimization. Переданное значение округляется до двух знаков после запятой. Для стратегии ROIOptimization
Profitability

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

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

Нет
Объект CampaignContextStrategy
StrategyName

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

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

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

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

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

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

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

Важно.

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

  • WeeklyBudget — стратегия «Недельный бюджет: максимум кликов» (обязательный параметр WeeklySumLimit, дополнительный MaxPrice);
  • CPAOptimizer — стратегия «Недельный бюджет: максимальная конверсия» (обязательные параметры WeeklySumLimit и GoalID, дополнительный MaxPrice); см. условия подключения стратегии в помощи Директа;
  • AverageClickPrice — стратегия «Средняя цена клика» (обязательный параметр AveragePrice, дополнительный WeeklySumLimit);
  • WeeklyPacketOfClicks — стратегия «Недельный пакет кликов» (обязательный параметр ClicksPerWeek, дополнительные MaxPrice или AveragePrice);
  • AverageCPAOptimization — стратегия «Средняя цена конверсии» (обязательные параметры AverageCPA и GoalID, дополнительные WeeklySumLimit и MaxPrice); см. условия подключения стратегии в помощи Директа;
  • ROIOptimization — стратегия «Средняя рентабельность инвестиций» (обязательные параметры 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.

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

Если значение перед сохранением конвертируется из у. е. в валюту кампании, то оно округляется вниз с точностью до шага торгов в этой валюте (см. раздел Реальные валюты вместо у. е.).

Нет
AveragePrice

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

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

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

Для стратегии AverageClickPrice
AverageCPA

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

Максимальное и минимальное значения представлены в таблице Валютные параметры и ограничения.

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

Для стратегии AverageCPAOptimization
WeeklySumLimit

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

Минимальное значение представлено в таблице Валютные параметры и ограничения. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

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

Для стратегии WeeklyBudget и CPAOptimizer
ClicksPerWeek Количество кликов в неделю для стратегии WeeklyPacketOfClicks. Для стратегии WeeklyPacketOfClicks
GoalID

Идентификатор цели Яндекс.Метрики для стратегии CPAOptimizer, AverageCPAOptimization или ROIOptimization (подходят только несоставные цели).

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

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

Для стратегии CPAOptimizer, AverageCPAOptimization и ROIOptimization
ReserveReturn

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

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

Для стратегии ROIOptimization
ROICoef Желаемая средняя рентабельность инвестиций за неделю для стратегии ROIOptimization. Переданное значение округляется до двух знаков после запятой. Для стратегии 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
Email Адрес электронной почты для отправки уведомлений о событиях, связанных с кампанией. Да
WarnPlaceInterval

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

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

Да
MoneyWarningValue

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

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

Да
SendAccNews

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

Нет
SendWarn

Отправлять уведомления по электронной почте — 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).

Минимальное допустимое значение представлено в таблице Валютные параметры и ограничения. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

Значение 0 — сброс дневного бюджета.

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

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

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

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

{
   "data": 3193279
}

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

Python

{
   "Login":"agrom",
   "CampaignID":3193279,
   "Name":"Promotion of home appliances",
   "FIO":"Alex Gromov",
   "Strategy":{
      "StrategyName":"RightBlockHighest"
   },
   "ContextStrategy": {
      "StrategyName":"Default",
      "ContextLimit":"Limited",
      "ContextLimitSum":30,
      "ContextPricePercent":90
   },
   "TimeTarget":{
      "TimeZone":"Europe/Moscow",
      "DaysHours":[
         {
            "Hours":[1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],
            "Days":[1,2,3,4,5]
         },
         {
            "Hours":[10,11,12,13,14,15,16,17,18,19,20],
            "Days":[6,7],
            "BidCoefs":[40,40,40,50,150,160,200,60,60,20,10]
         }
      ],
      "ShowOnHolidays":"Yes",
      "WorkingHolidays": "No"
   },
   "StatusBehavior":"Yes",
   "StatusContextStop":"No",

   "AutoOptimization":"Yes",
   "StatusMetricaControl":"Yes",
   "DisabledDomains": "domain1.ru,domain2.ru",
   "DisabledIps": "64.234.23.21",
   "StatusOpenStat":"No",
   "ConsiderTimeTarget":"Yes",
   "AddRelevantPhrases":"No",
   "RelevantPhrasesBudgetLimit":100,
   "MinusKeywords":[],
   "SmsNotification":{
      "SmsTimeFrom":"09:00",
      "MoneyInSms":"Yes",
      "SmsTimeTo":"21:00",
      "MoneyOutSms":"Yes",
      "ModerateResultSms":"Yes",
      "MetricaSms":"Yes"
   },
   "EmailNotification":{
      "MoneyWarningValue":20,
      "SendAccNews":"Yes",
      "WarnPlaceInterval":60,
      "SendWarn":"Yes",
      "Email":"agrom@yandex.ru"
   }
}

PHP

array(
   "Login" => "agrom",
   "CampaignID" => 3193279,
   "Name" => "Promotion of home appliances",
   "FIO" => "Alex Gromov",
   "Strategy" => array(
      "StrategyName" => "RightBlockHighest"
   ),
   "ContextStrategy" => array(
      "StrategyName" => "Default",
      "ContextLimit" => "Limited",
      "ContextLimitSum" => 30,
      "ContextPricePercent" => 90
   ),
   "TimeTarget" => array(
      "TimeZone" => "Europe/Moscow",
      "DaysHours" => array(
         array(
            "Hours" => array(1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23),
            "Days" => array(1,2,3,4,5)
         ),
         array(
            "Hours" => array(10,11,12,13,14,15,16,17,18,19,20),
            "Days" => array(6,7),
            "BidCoefs" => array(40,40,40,50,150,160,200,60,60,20,10)
         )
      ),
      "ShowOnHolidays" => "Yes",
      "WorkingHolidays" => "No"
   ),
   "StatusBehavior" => "Yes",
   "StatusContextStop" => "No",
   "AutoOptimization" => "Yes",
   "StatusMetricaControl" => "Yes",
   "DisabledDomains" => "domain1.ru,domain2.ru",
   "DisabledIps" => "64.234.23.21",
   "StatusOpenStat" => "No",
   "ConsiderTimeTarget" => "Yes",
   "AddRelevantPhrases" => "No",
   "RelevantPhrasesBudgetLimit" => 100,
   "MinusKeywords" => array(),
   "SmsNotification" => array(
      "SmsTimeFrom" => "09:00",
      "MoneyInSms" => "Yes",
      "SmsTimeTo" => "21:00",
      "MoneyOutSms" => "Yes",
      "ModerateResultSms" => "Yes",
      "MetricaSms" => "Yes"
   ),
   "EmailNotification" => array(
      "MoneyWarningValue" => 20,
      "SendAccNews" => "Yes",
      "WarnPlaceInterval" => 60,
      "SendWarn" => "Yes",
      "Email" => "agrom@yandex.ru"
   )
)

Perl

{
   'Login' => 'agrom',
   'CampaignID' => 3193279,
   'Name' => 'Promotion of home appliances',
   'FIO' => 'Alex Gromov',
   'Strategy' => {
      'StrategyName' => 'RightBlockHighest'
   },
   'ContextStrategy' => {
      'StrategyName' => 'Default',
      'ContextLimit' => 'Limited',
      'ContextLimitSum' => 30,
      'ContextPricePercent' => 90
   },
   'TimeTarget' => {
      'TimeZone' => 'Europe/Moscow',
      'DaysHours' => [
         {
            'Hours' => [1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],
            'Days' => [1,2,3,4,5]
         },
         {
            'Hours' => [10,11,12,13,14,15,16,17,18,19,20],
            'Days' => [6,7],
            'BidCoefs' => [40,40,40,50,150,160,200,60,60,20,10]
         }
      ],
      'ShowOnHolidays' => 'Yes',
      'WorkingHolidays' => 'No'
   },
   'StatusBehavior' => 'Yes',
   'StatusContextStop' => 'No',
   'AutoOptimization' => 'Yes',
   'StatusMetricaControl' => 'Yes',
   'DisabledDomains' => 'domain1.ru,domain2.ru',
   'DisabledIps' => '64.234.23.21',
   'StatusOpenStat' => 'No',
   'ConsiderTimeTarget' => 'Yes',
   'AddRelevantPhrases' => 'No',
   'RelevantPhrasesBudgetLimit' => 100,
   'MinusKeywords' => [],
   'SmsNotification' => {
      'SmsTimeFrom' => '09:00',
      'MoneyInSms' => 'Yes',
      'SmsTimeTo' => '21:00',
      'MoneyOutSms' => 'Yes',
      'ModerateResultSms' => 'Yes',
      'MetricaSms' => 'Yes'
   },
   'EmailNotification' => {
      'MoneyWarningValue' => 20,
      'SendAccNews' => 'Yes',
      'WarnPlaceInterval' => 60,
      'SendWarn' => 'Yes',
      'Email' => 'agrom@yandex.ru'
   }
}