SetAutoPrice

Задает или рассчитывает по алгоритму ставки для фраз.

Внимание.

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

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

Для метода существует версия SetAutoPrice (Live).

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

Изменения ставок вступают в силу спустя некоторое время, см. правила показа.

Ограничения

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

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

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

Метод может задавать ставки двумя способами с названиями SinglePrice и Wizard. Первый способ задается одинаковые ставки для всех фраз, второй — для каждой фразы рассчитывается своя ставка.

Входные данные для способа SinglePrice

Для всех фраз задается одна и та же указанная ставка. Этот способ подходит для кампаний с малым количеством объявлений, фразы которых оцениваются примерно одинаково. Иначе одинаковая ставка может оказаться завышенной для одних фраз или заниженной для других.

{
   "method": "SetAutoPrice",
   "param": {
      /* AutoPriceInfo */
      "CampaignID": (int),
      "Mode": "SinglePrice",
      "SinglePrice": (float)
   }
}

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

Параметр Описание Требуется
Объект AutoPriceInfo
CampaignID Идентификатор кампании. Да
Mode Значение «SinglePrice». Да
SinglePrice

Ставка, задаваемая для всех фраз во всех объявлениях.

Примечание. Если для кампании выбрана стратегия с раздельным управлением ставками на поиске и в Рекламной сети Яндекса, новые ставки действуют и на поиске, и в Рекламной сети.
Да
Параметр Описание Требуется
Объект AutoPriceInfo
CampaignID Идентификатор кампании. Да
Mode Значение «SinglePrice». Да
SinglePrice

Ставка, задаваемая для всех фраз во всех объявлениях.

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

Входные данные для способа Wizard

Ставки рассчитываются для каждой фразы так, чтобы объявление показывалось на определенной позиции, а ставки не были излишне завышены. Расчет отталкивается от минимальной цены за клик для выбранной позиции. К минимальной цене делается надбавка, процент которой задает пользователь. Результат становится ставкой.

Примечание.

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

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

{
   "method": "SetAutoPrice",
   "param": {
      /* AutoPriceInfo */
      "CampaignID": (int),
      "Mode": "Wizard",
      "PhrasesType": (string),
      "UpdatePhrases": (string),
      "UpdateCategories": (string),
      "MaxPrice": (float),
      "PriceBase": (string),
      "ProcBase": (string),
      "Proc": (int),
      "Scope": (int)
   }
}

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

Параметр Описание Требуется
Объект AutoPriceInfo
CampaignID Идентификатор кампании. Да
Mode Значение «Wizard». Да
PhrasesType

Отбирает фразы для расчета ставок. Возможные значения:

  • Search — фразы, активные на поиске;
  • Network — фразы, отключенные на поиске за низкий CTR;
  • Both — все фразы.

Если параметр не указан, подразумевается Search.

Для активных фраз ставки рассчитываются с помощью параметров PriceBase, ProcBase, Proc, для отключенных — с помощью параметра Scope и Proc. В обоих случаях максимальная ставка ограничена параметром MaxPrice.

Нет
UpdatePhrases Рассчитывать ставки для фраз. Параметр не используется, переданное значение игнорируется. Нет
UpdateCategories Рассчитывать ставки для фраз. Параметр не используется, переданное значение игнорируется. Нет
MaxPrice Максимальная ставка (не более 50 у. е.). Если не задана, используется предустановленное ограничение — 50 у. е. Нет
PriceBase

Позиция, на которой необходимо разместить объявление. Возможные значения:

  • min — нижний блок;
  • max — первое место в нижнем блоке;
  • pmin — спецразмещение;
  • pmax — первое место в спецразмещении.

Стоимость выбранной позиции берется за основу для расчета ставок. К стоимости позиции прибавляется надбавка (см. параметры Proc и ProcBase).

При значении pmax берется нулевая надбавка, и конечная ставка равна стоимости первого места в спецразмещении.

При PhrasesType со значением Search или Both

ProcBase

База для расчета надбавки:

  • value — стоимость позиции, выбранной в ProcBase.

  • diff — разница в стоимости двух позиций: выбранной в ProcBase и следующей по стоимости (например, при выборе позиции min для расчета надбавки берется разница max-min).

    При выборе позиции pmax следующая позиция отсутствует и надбавка равна нулю. Это же верно при выборе позиции max, если стоимость следующей позиции pmin меньше (редкая, но возможная ситуация).

При PhrasesType со значением Search или Both и если задан Proc

Proc

Процент надбавки от 0 до 1000. Если не задан, подразумевается 0.

Для активных фраз надбавка делается к базе, указанной в ProcBase, а результат прибавляется к минимальной цене, указанной в PriceBase.

Для отключенных фраз увеличивается ставка, рассчитанная в соответствии с параметром Scope.

Нет
Scope

Необходимый охват аудитории Рекламной сети Яндекса в процентах от 1 до 100. Используется при расчете ставок для фраз, отключенных на поиске за низкий CTR. Полученные ставки действуют только в Рекламной сети Яндекса.

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

Внимание. Расчет ставок по параметру Scope носит вероятностный характер и не гарантирует фактическое соответствие размера аудитории требуемому охвату. Расчет делается на основе статистических данных о том, при каких ставках достигается тот или иной охват аудитории.
При PhrasesType со значением Network или Both
Параметр Описание Требуется
Объект AutoPriceInfo
CampaignID Идентификатор кампании. Да
Mode Значение «Wizard». Да
PhrasesType

Отбирает фразы для расчета ставок. Возможные значения:

  • Search — фразы, активные на поиске;
  • Network — фразы, отключенные на поиске за низкий CTR;
  • Both — все фразы.

Если параметр не указан, подразумевается Search.

Для активных фраз ставки рассчитываются с помощью параметров PriceBase, ProcBase, Proc, для отключенных — с помощью параметра Scope и Proc. В обоих случаях максимальная ставка ограничена параметром MaxPrice.

Нет
UpdatePhrases Рассчитывать ставки для фраз. Параметр не используется, переданное значение игнорируется. Нет
UpdateCategories Рассчитывать ставки для фраз. Параметр не используется, переданное значение игнорируется. Нет
MaxPrice Максимальная ставка (не более 50 у. е.). Если не задана, используется предустановленное ограничение — 50 у. е. Нет
PriceBase

Позиция, на которой необходимо разместить объявление. Возможные значения:

  • min — нижний блок;
  • max — первое место в нижнем блоке;
  • pmin — спецразмещение;
  • pmax — первое место в спецразмещении.

Стоимость выбранной позиции берется за основу для расчета ставок. К стоимости позиции прибавляется надбавка (см. параметры Proc и ProcBase).

При значении pmax берется нулевая надбавка, и конечная ставка равна стоимости первого места в спецразмещении.

При PhrasesType со значением Search или Both

ProcBase

База для расчета надбавки:

  • value — стоимость позиции, выбранной в ProcBase.

  • diff — разница в стоимости двух позиций: выбранной в ProcBase и следующей по стоимости (например, при выборе позиции min для расчета надбавки берется разница max-min).

    При выборе позиции pmax следующая позиция отсутствует и надбавка равна нулю. Это же верно при выборе позиции max, если стоимость следующей позиции pmin меньше (редкая, но возможная ситуация).

При PhrasesType со значением Search или Both и если задан Proc

Proc

Процент надбавки от 0 до 1000. Если не задан, подразумевается 0.

Для активных фраз надбавка делается к базе, указанной в ProcBase, а результат прибавляется к минимальной цене, указанной в PriceBase.

Для отключенных фраз увеличивается ставка, рассчитанная в соответствии с параметром Scope.

Нет
Scope

Необходимый охват аудитории Рекламной сети Яндекса в процентах от 1 до 100. Используется при расчете ставок для фраз, отключенных на поиске за низкий CTR. Полученные ставки действуют только в Рекламной сети Яндекса.

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

Внимание. Расчет ставок по параметру Scope носит вероятностный характер и не гарантирует фактическое соответствие размера аудитории требуемому охвату. Расчет делается на основе статистических данных о том, при каких ставках достигается тот или иной охват аудитории.
При PhrasesType со значением Network или Both

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

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

{
   "data": [
      {  /* PhrasePriceInfo */
         "PhraseID": (long),
         "BannerID": (long),
         "CampaignID": (int),
         "Price": (float),
         "ContextPrice": (float)
         "AutoBroker": (string)
      }
      ...
   ]
}

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

Параметр Описание
Объект PhrasePriceInfo
PhraseID Идентификатор фразы.
BannerID Идентификатор объявления.
CampaignID Идентификатор кампании.
Price Новая ставка. Рассчитывается для активных фраз.
ContextPrice Новая ставка для Рекламной сети Яндекса. Рассчитывается для фраз, отключенных на поиске за низкий CTR.
AutoBroker

Признак включенного автоброкера. Всегда содержит значение Yes.

Параметр Описание
Объект PhrasePriceInfo
PhraseID Идентификатор фразы.
BannerID Идентификатор объявления.
CampaignID Идентификатор кампании.
Price Новая ставка. Рассчитывается для активных фраз.
ContextPrice Новая ставка для Рекламной сети Яндекса. Рассчитывается для фраз, отключенных на поиске за низкий CTR.
AutoBroker

Признак включенного автоброкера. Всегда содержит значение Yes.

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

Python

Устанавливает одинаковую цену для всех фраз всех объявлений кампании.

{
   'CampaignID': 1327944,
   'Mode':'SinglePrice',
   'SinglePrice': 4.35,
}

PHP

Рассчитывает и устанавливает цены для активных фраз.

array(
   'CampaignID' => 1327944,
   'Mode' => 'Wizard',
   'PriceBase' => 'min',
   'ProcBase' => 'value',
   'Proc' => 14,
   'MaxPrice' => 9.5,
   'PhrasesType' => 'Search'
)

Perl

Рассчитывает и устанавливает цены для фраз, отключенных на поиске за низкий CTR.

{
   'CampaignID' => 1327944,
   'Mode' => 'Wizard',
   'MaxPrice' => 9.5,
   'Scope' => 80,
   'PhrasesType' => 'Network'
}