set

Назначает фиксированные ставки и приоритеты для ключевых фраз и автотаргетингов.

  1. Ограничения
  2. Запрос
  3. Ответ
  4. Примеры
Внимание.

В Рекламной сети Яндекса будет отключено ручное управление ставками. Подробнее.

  • 22 апреля 2024 года будет закрыто создание новых кампаний на ручной стратегии: в методах add и update у кампаний TextCampaign и MobileAppCampaign в параметре Network.BiddingStrategyType перестанет поддерживаться стратегия MAXIMUM_COVERAGE. Также для таких кампаний будет нельзя использовать метод resume. Попытка использования будет возвращать ошибку валидации.
  • 20 мая 2024 года будет закрыто редактирование ставок в активных кампаниях: в методе set перестанет поддерживаться параметр Bids.ContextBid (KeywordBids.NetworkBid). Попытка использования будет возвращать ошибку валидации.
  • Июнь 2024 года — будут остановлены активные кампании: попытка использования метода resume для кампаний со стратегией MAXIMUM_COVERAGE в параметре Network.BiddingStrategyType будет возвращать ошибку валидации, если не сменить стратегию на доступную. Впоследствии стратегия у таких остановленных и архивных кампаний будет изменена на WB_MAXIMUM_CLICKS (сами кампании запущены или разархивированы не будут).

Ставку или приоритет можно назначить:

  • для отдельной ключевой фразы или автотаргетинга;

  • для всех ключевых фраз и автотаргетинга в группе объявлений;

  • для всех ключевых фраз и автотаргетингов в кампании.

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

  • Если выбрана стратегия показа на поиске HIGHEST_POSITION, то можно указать параметр SearchBid.
  • Если выбрана стратегия показа в сетях MAXIMUM_COVERAGE или MANUAL_CPM, то можно указать параметр NetworkBid.
  • Если выбрана автоматическая стратегия, то можно указать параметр StrategyPriority: фразы с более высоким приоритетом по возможности получают больший объем трафика, а при недостатке бюджета отключаются в последнюю очередь.

В случае если элемент входного массива содержит параметры, не соответствующие стратегии, то значения этих параметров изменены не будут.

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

  • Ставки и цены передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой ставку или цену, умноженную на 1 000 000.

  • Все ставки и цены указываются в валюте рекламодателя.

Ограничения

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

Количество объектов в одном вызове метода:
  • кампаний — не более 10;
  • групп — не более 1000;
  • ключевых фраз и автотаргетингов — не более 10 000.

Запрос

Структура запроса в формате JSON:

{
  "method": "set",
  "params": { /* params */
    "Bids": [{  /* BidSetItem */
      "CampaignId": (long),
      "AdGroupId": (long),
      "KeywordId": (long),
      "Bid": (long),
      "AutotargetingSearchBidIsAuto" : ("YES"|"NO"),
      "ContextBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / SetRequest (для SOAP)
Bids array of BidSetItem Ставки и/или приоритеты. Да
Структура BidSetItem
CampaignId long Идентификатор кампании. Указывается, если требуется назначить единую ставку/приоритет для всех ключевых фраз и автотаргетингов в кампании. Либо CampaignId, либо AdGroupId, либо KeywordId
AdGroupId long Идентификатор группы объявлений. Указывается, если требуется назначить единую ставку/приоритет для всех ключевых фраз и автотаргетингов в группе.
KeywordId long Идентификатор фразы. Указывается, если требуется назначить ставку/приоритет для отдельной ключевой фразы или автотаргетинга.
Bid long

Ставка на поиске, умноженная на 1 000 000. Целое число. Только для ручной стратегии.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

 Хотя бы один из параметров Bid, ContextBid, StrategyPriority, AutotargetingSearchBidIsAuto
AutotargetingSearchBidIsAuto YesNoEnum

Признак включения опции автоматической ставки.

Можно одновременно указать ручную ставку (Bid) и включить автоставку (AutotargetingSearchBidIsAuto). В этом случае будет работать автоставка, а ручная будет использоваться в случае отключения автоматической.

Если указана ручная ставка Bid: значение автоматической ставки (AutotargetingSearchBidIsAuto) будет выставлено NO, если в явном виде не прислано иное значение автоставки.

Если не указана ручная ставка Bid: значение автоматической ставки (AutotargetingSearchBidIsAuto) будет выставлено YES, если в явном виде не прислано иное значение автоставки.
ContextBid long

Ставка в сетях, умноженная на 1 000 000. Целое число. Только для ручной стратегии с независимым управлением ставками в сетях.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

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

Приоритет фразы: LOW, NORMAL или HIGH. Только для автоматической стратегии.
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / SetRequest (для SOAP)
Bids array of BidSetItem Ставки и/или приоритеты. Да
Структура BidSetItem
CampaignId long Идентификатор кампании. Указывается, если требуется назначить единую ставку/приоритет для всех ключевых фраз и автотаргетингов в кампании. Либо CampaignId, либо AdGroupId, либо KeywordId
AdGroupId long Идентификатор группы объявлений. Указывается, если требуется назначить единую ставку/приоритет для всех ключевых фраз и автотаргетингов в группе.
KeywordId long Идентификатор фразы. Указывается, если требуется назначить ставку/приоритет для отдельной ключевой фразы или автотаргетинга.
Bid long

Ставка на поиске, умноженная на 1 000 000. Целое число. Только для ручной стратегии.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

 Хотя бы один из параметров Bid, ContextBid, StrategyPriority, AutotargetingSearchBidIsAuto
AutotargetingSearchBidIsAuto YesNoEnum

Признак включения опции автоматической ставки.

Можно одновременно указать ручную ставку (Bid) и включить автоставку (AutotargetingSearchBidIsAuto). В этом случае будет работать автоставка, а ручная будет использоваться в случае отключения автоматической.

Если указана ручная ставка Bid: значение автоматической ставки (AutotargetingSearchBidIsAuto) будет выставлено NO, если в явном виде не прислано иное значение автоставки.

Если не указана ручная ставка Bid: значение автоматической ставки (AutotargetingSearchBidIsAuto) будет выставлено YES, если в явном виде не прислано иное значение автоставки.
ContextBid long

Ставка в сетях, умноженная на 1 000 000. Целое число. Только для ручной стратегии с независимым управлением ставками в сетях.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

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

Приоритет фразы: LOW, NORMAL или HIGH. Только для автоматической стратегии.
Внимание. Параметры CampaignId, AdGroupId и KeywordId являются взаимоисключающими. В одном запросе можно указывать только один из этих параметров.

Ответ

Структура ответа в формате JSON:

{
  "result": {  /* result */
    "SetResults": [{  /* BidActionResult */
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "CampaignId": (long),
      "AdGroupId": (long),
      "KeywordId": (long)
    }, ... ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / SetResponse (для SOAP)
SetResults array of BidActionResult Результаты назначения ставок и/или приоритетов.
Структура BidActionResult
CampaignId long Идентификатор кампании. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
AdGroupId long Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
KeywordId long Идентификатор ключевой фразы или автотаргетинга. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.
Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.
Параметр Тип Описание
Структура result (для JSON) / SetResponse (для SOAP)
SetResults array of BidActionResult Результаты назначения ставок и/или приоритетов.
Структура BidActionResult
CampaignId long Идентификатор кампании. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
AdGroupId long Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
KeywordId long Идентификатор ключевой фразы или автотаргетинга. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.
Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Примеры

Пример запроса
{
  "method" : "set",
  "params" : {
    "Bids" : [
      {
        "StrategyPriority" : "HIGH",
        "CampaignId" : 4193065
      },
      {
        "Bid" : 14000,
        "CampaignId" : 7273721
      }
    ]
  }
}
Пример ответа
{
  "result" : {
    "SetResults" : [
      {
        "CampaignId" : 4193065
      },
      {
        "CampaignId" : 7273721
      }
    ]
  }
}