setAuto

Назначает для фраз ставки на поиске в зависимости от желаемого объема трафика или ставки в сетях в зависимости от желаемой частоты показа (доли аудитории).

Формула расчета ставки:

Ставка, соответствующая объему трафика TargetTrafficVolume × (1 + IncreasePercent / 100),

но не более BidCeiling.

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

Метод не возвращает назначенные ставки, получить их можно методом get.

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

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

Ограничения

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

Ставку в сетях можно назначить, только если в кампании выбрана стратегия показа в сетях MAXIMUM_COVERAGE или MANUAL_CPM. В противном случае возвращается ошибка.

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

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

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

Запрос

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

{
  "method": "setAuto",
  "params": { /* params */
    "KeywordBids": [{  /* KeywordBidSetAutoItem */
      "CampaignId": (long),
      "AdGroupId": (long),
      "KeywordId": (long),
      "BiddingRule": { /* BiddingRule */
        "SearchByTrafficVolume": { /* SearchByTrafficVolume */
          "TargetTrafficVolume": (int), /* required */
          "IncreasePercent": (int),
          "BidCeiling": (long)
        },
        "NetworkByCoverage": { /* NetworkByCoverage */
          "TargetCoverage": (int), /* required */
          "IncreasePercent": (int),
          "BidCeiling": (long)
        }
      } /* required */
    }, ... ] /* required */
  } 
}
Параметр Тип Описание Обязательный
Структура params (для JSON) / SetAutoRequest (для SOAP)
KeywordBids array of KeywordBidSetAutoItem Параметры расчета ставок. Да
Структура KeywordBidSetAutoItem
CampaignId long Идентификатор кампании. Указывается, если требуется обновить ставки для всех фраз кампании. Либо CampaignId, либо AdGroupId, либо KeywordId
AdGroupId long Идентификатор группы объявлений. Указывается, если требуется обновить ставки для всех фраз группы.
KeywordId long

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

Ограничение. Идентификатор автотаргетинга не допускается.
BiddingRule BiddingRule

Параметры для формулы расчета ставок.

Да
Структура BiddingRule
SearchByTrafficVolume SearchByTrafficVolume

Параметры для формулы расчета ставок на поиске.

Либо SearchByTrafficVolume, либо NetworkByCoverage
NetworkByCoverage NetworkByCoverage

Параметры для формулы расчета ставок в сетях.

Структура SearchByTrafficVolume
TargetTrafficVolume int

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

К ставке, соответствующей выбранному объему трафика, прибавляется надбавка (см. параметр IncreasePercent).

Да
IncreasePercent int Процент надбавки от 0 до 1000. Если не задан, надбавка не рассчитывается. Нет
BidCeiling long

Ограничение на ставку, умноженное на 1 000 000. Целое число.

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

Нет
Структура NetworkByCoverage
TargetCoverage int

Желаемая частота показа (доля аудитории) в сетях. Указывается в процентах от 1 до 100.

К ставке, соответствующей выбранной частоте показа, прибавляется надбавка (см. параметр IncreasePercent).

Да
IncreasePercent int Процент надбавки от 0 до 1000. Если не задан, надбавка не рассчитывается. Нет
BidCeiling long

Ограничение на ставку, умноженное на 1 000 000. Целое число.

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

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

Ответ

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

{
  "result": { /* result */
    "SetAutoResults": [{  /* 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) / SetAutoResponse (для SOAP)
SetAutoResults array of KeywordBidActionResult Результаты назначения ставок.
Структура KeywordBidActionResult
CampaignId long Идентификатор кампании. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
AdGroupId long Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
KeywordId long Идентификатор ключевой фразы. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов (если был указан в запросе).
Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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

Примеры

Пример запроса

Назначить всем фразам в группе объявлений ставку на поиске для получения объема трафика 75, увеличенную на 10%, но не более 12.

{
  "method": "setAuto",
  "params": {
    "KeywordBids": [{
      "AdGroupId": 636056397,
      "BiddingRule": {
        "SearchByTrafficVolume": {
          "TargetTrafficVolume": 75,
          "IncreasePercent": 10,
          "BidCeiling": 12000000,
        }
      }
    }] 
  }
} 
Пример ответа
{
  "result" : {
    "SetAutoResults" : [
      {
        "AdGroupId" : 636056397
      }
    ]
  }
}