set

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

Ставку можно назначить:

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

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

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

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

  • Если выбрана стратегия показа на поиске HIGHEST_POSITION, то можно указать параметр SearchBid.
  • Если выбрана стратегия показа в сетях MAXIMUM_COVERAGE или MANUAL_CPM, то можно указать параметр NetworkBid.

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

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

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

Узнайте больше

Ограничения

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

Количество объектов в одном вызове метода:

  • кампаний — не более campaign-ids-select;
  • групп — не более adgroup-ids-select;
  • ключевых фраз и автотаргетингов — не более ids-select.

Запрос

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

{
  "method": "set",
  "params": { /* params */
    "KeywordBids": [{  /* KeywordBidSetItem */
      "CampaignId": (long),
      "AdGroupId": (long),
      "KeywordId": (long),
      "SearchBid": (long),
      "AutotargetingSearchBidIsAuto" : ("YES"|"NO"),
      "NetworkBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
    }, ... ] /* required */
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / SetRequest (для SOAP)

KeywordBids

array of KeywordBidSetItem

Ставки.

Да

Структура KeywordBidSetItem

CampaignId

long

Идентификатор кампании. Указывается, если требуется назначить единую ставку для всех ключевых фраз и автотаргетингов в кампании.

Либо CampaignId, либо AdGroupId, либо KeywordId

AdGroupId

long

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

KeywordId

long

Идентификатор фразы. Указывается, если требуется назначить ставку для отдельной ключевой фразы или автотаргетинга.

SearchBid

long

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

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

Хотя бы один из параметров SearchBid, NetworkBid, StrategyPriority, AutotargetingSearchBidIsAuto

AutotargetingSearchBidIsAuto

YesNoEnum

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

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

Если указана только ручная ставка (SearchBid):

  • Для операции с указанием CampaignId или AdGroupId значение автоставки не будет стерто после использования метода.
  • Для операции с указанием KeywordId значение автоставки будет выставлено в "NO". Чтобы сохранить эту настройку, укажите ее в явном виде для операции с KeywordId.

NetworkBid

long

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

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

Внимание

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

StrategyPriority

PriorityEnum

Приоритет фразы: LOW, NORMAL или HIGH. Только для автоматической стратегии.

Внимание

Параметр не используется, переданное значение игнорируется.

Внимание

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

Ответ

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

{
  "result": {  /* result */
    "SetResults": [{  /* KeywordBidActionResult */
      "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 KeywordBidActionResult

Результаты назначения ставок.

Структура KeywordBidActionResult

CampaignId

long

Идентификатор кампании. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).

AdGroupId

long

Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).

KeywordId

long

Идентификатор ключевой фразы или автотаргетинга. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).

Warnings

array of ExceptionNotification

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

Errors

array of ExceptionNotification

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

Пример

Запрос

    {
      "method" : "set",
      "params" : {
        "KeywordBids" : [
          {
            "StrategyPriority" : "HIGH",
            "CampaignId" : 4193065
          },
          {
            "SearchBid" : 14000,
            "CampaignId" : 7273721
          }
        ]
      }
    }

Ответ

    {
      "result" : {
        "SetResults" : [
          {
            "CampaignId" : 4193065
          },
          {
            "CampaignId" : 7273721
          }
        ]
      }
    }
Предыдущая
Следующая