CreateOrUpdateCampaign (Live)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• 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); см. условия подключения стратегии в помощи Директа.

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Минимальное значение представлено в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• 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); см. условия подключения стратегии в помощи Директа.

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

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

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

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

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

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

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Максимальное и минимальное значения представлены в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits.

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

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

Минимальное значение представлено в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Минимальное допустимое значение представлено в таблице ../concepts/multicurrency_const.html#multicurrency_const__limits. Ограничение проверяется в валюте, указанной в параметре Currency (а не в валюте кампании).

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

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