setBids

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

  1. Ограничения
  2. Запрос
  3. Ответ

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

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

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

В случае если не указан параметр, соответствующий стратегии, возвращается ошибка.

В случае если указаны и ставка, и приоритет, значения будут сохранены:

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

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

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

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

Ограничения

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

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

  • условий нацеливания на аудиторию — не более 10 000;
  • групп — не более 1000;
  • кампаний — не более 100.

Запрос

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

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

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

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

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

Приоритет условия нацеливания на аудиторию: LOW, NORMAL или HIGH. Используется только для автоматической стратегии.

Значение по умолчанию — NORMAL.

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

Ответ

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

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

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

Errors array of ExceptionNotification

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