add

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

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

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

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

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

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

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

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

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

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

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

Ограничения

Не более 1000 условий нацеливания на аудиторию в одном вызове метода.

Прочие ограничения приведены в разделе Ограничения.

Запрос

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

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

Идентификатор условия ретаргетинга и подбора аудитории.

Область применения условия ретаргетинга должна соответствовать типу группы объявлений, см. Область применения.

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

Либо RetargetingListId, либо InterestId
InterestId long

Идентификатор интереса к категории мобильных приложений.

Справочник интересов можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Interests. Допускаются только интересы, для которых в справочнике в параметре IsTargetable указано значение YES.

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

ContextBid long

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

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

Значение по умолчанию — минимальная ставка.

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

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

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

Нет
Параметр Тип Описание Обязательный
Структура params (для JSON) / AddRequest (для SOAP)
AudienceTargets array of AudienceTargetAddItem Условия нацеливания на аудиторию, которые требуется добавить. Да
Структура AudienceTargetAddItem
AdGroupId long Идентификатор группы, в которую добавляется условие нацеливания на аудиторию. Да
RetargetingListId long

Идентификатор условия ретаргетинга и подбора аудитории.

Область применения условия ретаргетинга должна соответствовать типу группы объявлений, см. Область применения.

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

Либо RetargetingListId, либо InterestId
InterestId long

Идентификатор интереса к категории мобильных приложений.

Справочник интересов можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Interests. Допускаются только интересы, для которых в справочнике в параметре IsTargetable указано значение YES.

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

ContextBid long

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

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

Значение по умолчанию — минимальная ставка.

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

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

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

Нет

Ответ

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

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления условий нацеливания на аудиторию.
Структура ActionResult
Id long

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

Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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

Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления условий нацеливания на аудиторию.
Структура ActionResult
Id long

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

Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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