add
Создает условия нацеливания для динамических объявлений, назначает ставки или приоритеты для создаваемых условий.
Ставка или приоритет используются в зависимости от того, какая стратегия показа выбрана в кампании:
Если в кампании настроена автоматическая стратегия, то используется параметр StrategyPriority: объявления по условиям нацеливания для динамических объявлений с более высоким приоритетом по возможности получают больший объем трафика, а при недостатке бюджета отключаются в последнюю очередь.
Если в кампании настроена ручная стратегия, то используется параметр Bid.
Параметр ContextBid в настоящее время не используется.
В случае если элемент входного массива содержит параметры, не соответствующие стратегии, то значения этих параметров будут сохранены и будет выдано предупреждение.
Если в кампании настроена автоматическая стратегия, а для условия нацеливания для динамических объявлений задан параметр Bid, то это значение ставки не будет применено: в момент смены стратегии с автоматической на ручную будет задана ставка, подобранная автоматическим алгоритмом.
Если в кампании настроена ручная стратегия, а для условия нацеливания для динамических объявлений задан параметр StrategyPriority, то в дальнейшем в момент смены стратегии на автоматическую заданное значение приоритета будет применено.
Если стратегия предполагает назначение ставки, а ставка не указана, по умолчанию назначается минимальная ставка (зависит от валюты рекламодателя). Если стратегия предполагает назначение приоритета, а приоритет не указан, по умолчанию назначается средний приоритет.
Ставки и цены передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой ставку или цену, умноженную на 1 000 000.
Все ставки и цены указываются в валюте рекламодателя.
Ограничения
Условия нацеливания для динамических объявлений можно добавить только в группу объявлений с типом DYNAMIC_TEXT_AD_GROUP.
Не более 50 условий нацеливания для динамических объявлений в группе объявлений.
Не более 1000 условий нацеливания для динамических объявлений в одном вызове метода.
Запрос
Структура запроса в формате JSON:
{
"method": "add",
"params": { /* params */
"Webpages": [{ /* WebpageAddItem */
"Name": (string), /* required */
"AdGroupId": (long), /* required */
"Conditions": [{ /* WebpageCondition */
"Operand": ( "DOMAIN" | "OFFERS_LIST_URL" | "PAGE_CONTENT" | "PAGE_TITLE" | "URL" ), /* required */
"Operator": ( "EQUALS_ANY" | "NOT_EQUALS_ALL" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
"Arguments": [(string), ... ] /* required */
}, ... ],
"Bid": (long),
"ContextBid": (long),
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
}, ... ] /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
Webpages | array of WebpageAddItem | Условия нацеливания для динамических объявлений, которые требуется добавить. | Да |
Структура WebpageAddItem | |||
Name | string | Название условия нацеливания для динамических объявлений (не более 100 символов). | Да |
AdGroupId | long | Идентификатор группы, в которую добавляется условие нацеливания для динамических объявлений. | Да |
Conditions | array of WebpageCondition | Правила отбора страниц. Не более 10 элементов в массиве. Для страницы генерируется динамическое объявление, если она удовлетворяет одновременно всем правилам отбора. Если параметр не задан, создается условие нацеливания для динамических объявлений с типом PAGES_ALL («Все страницы сайта»). | Нет |
Bid | long | Ставка на поиске, умноженная на 1 000 000. Целое число. Используется только для ручной стратегии. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | Нет |
ContextBid | long | Параметр зарезервирован для будущего использования. | Нет |
StrategyPriority | PriorityEnum | Приоритет условия нацеливания для динамических объявлений: LOW, NORMAL или HIGH. Используется только для автоматической стратегии. | Нет |
Структура WebpageCondition | |||
Operand | WebpageCondition OperandEnum | Операнд — свойство страницы сайта, которое подлежит сравнению с аргументом. Описание операндов см. в разделе Правило отбора. | Да |
Operator | StringCondition OperatorEnum | Каким образом сравнивается операнд с аргументом. Описание операторов см. в разделе Правило отбора. | Да |
Arguments | array of string | Массив строк, с которыми сравнивается операнд. Не более 10 строк в массиве. Если в качестве операнда указан OFFERS_LIST_URL, то длина каждой строки — не более 1024 символов. В остальных случаях длина каждой строки не более 100 символов. | Да |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
Webpages | array of WebpageAddItem | Условия нацеливания для динамических объявлений, которые требуется добавить. | Да |
Структура WebpageAddItem | |||
Name | string | Название условия нацеливания для динамических объявлений (не более 100 символов). | Да |
AdGroupId | long | Идентификатор группы, в которую добавляется условие нацеливания для динамических объявлений. | Да |
Conditions | array of WebpageCondition | Правила отбора страниц. Не более 10 элементов в массиве. Для страницы генерируется динамическое объявление, если она удовлетворяет одновременно всем правилам отбора. Если параметр не задан, создается условие нацеливания для динамических объявлений с типом PAGES_ALL («Все страницы сайта»). | Нет |
Bid | long | Ставка на поиске, умноженная на 1 000 000. Целое число. Используется только для ручной стратегии. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | Нет |
ContextBid | long | Параметр зарезервирован для будущего использования. | Нет |
StrategyPriority | PriorityEnum | Приоритет условия нацеливания для динамических объявлений: LOW, NORMAL или HIGH. Используется только для автоматической стратегии. | Нет |
Структура WebpageCondition | |||
Operand | WebpageCondition OperandEnum | Операнд — свойство страницы сайта, которое подлежит сравнению с аргументом. Описание операндов см. в разделе Правило отбора. | Да |
Operator | StringCondition OperatorEnum | Каким образом сравнивается операнд с аргументом. Описание операторов см. в разделе Правило отбора. | Да |
Arguments | array of string | Массив строк, с которыми сравнивается операнд. Не более 10 строк в массиве. Если в качестве операнда указан OFFERS_LIST_URL, то длина каждой строки — не более 1024 символов. В остальных случаях длина каждой строки не более 100 символов. | Да |
Ответ
Структура ответа в формате 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 | Ошибки, возникшие при выполнении операции. |
Пример
Отбирать для создания объявлений страницы планшетов, представленных в списке планшетов, исключая распроданные и отсутствующие в продаже.
{
"method" : "add",
"params": {
"Webpages":[
{
"AdGroupId":831821811,
"Name":"Планшеты",
"Bid":800000,
"Conditions": [
{
"Operand":"PAGE_CONTENT",
"Operator":"NOT_CONTAINS_ALL",
"Arguments":["Товар временно отсутствует в продаже"]
},
{
"Operand":"PAGE_CONTENT",
"Operator":"NOT_CONTAINS_ALL",
"Arguments": ["Товар распродан"]
},
{
"Operand":"OFFERS_LIST_URL",
"Operator":"EQUALS_ANY",
"Arguments":["http://example.com/tablets/tablets-195"]
}
]
}
]
}
}