setBids
Назначает CPC, CPA и приоритеты для фильтров.
CPC, CPA или приоритет можно назначить для отдельного фильтра, для всех фильтров в группе объявлений или для всех фильтров в кампании.
CPC, CPA или приоритет используются в зависимости от того, какая стратегия показа выбрана в кампании:
- Если в кампании настроена стратегия AVERAGE_ROI, то используется параметр StrategyPriority: фильтры с более высоким приоритетом по возможности получают больший объем трафика на поиске или долю аудитории в сетях, а при недостатке бюджета отключаются в последнюю очередь.
- Если в кампании настроена стратегия AVERAGE_CPA_PER_CAMPAIGN или AVERAGE_CPA_PER_FILTER, то используется параметр AverageCpa.
- Если в кампании настроена стратегия AVERAGE_CPC_PER_CAMPAIGN или AVERAGE_CPC_PER_FILTER, то используется параметр AverageCpc.
Если указана ставка, не соответствующая стратегии, она игнорируется. Если указан приоритет, не соответствующий стратегии, значение сохраняется, но не используется.
Ставки и цены передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой ставку или цену, умноженную на 1 000 000.
Все ставки и цены указываются в валюте рекламодателя.
Ограничения
В одном запросе можно назначить ставки только для однородных объектов — либо только для кампаний, либо только для групп, либо только для фильтров.
Количество объектов в одном вызове метода:
- кампаний — не более 10;
- групп — не более 1000;
- условий нацеливания для объявлений с типом SMART_AD (смарт-баннеры)— не более 10 000.
Запрос
Структура запроса в формате JSON:
{
"method": "setBids",
"params": { /* params */
"Bids": [{ /* SetBidsItem */
"CampaignId": (long),
"AdGroupId": (long),
"Id": (long),
"AverageCpc": (long), /* nillable */
"AverageCpa": (long), /* nillable */
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
}, ... ] /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / SetRequest (для SOAP) | |||
---|---|---|---|
Bids | array of SetBidsItem | Ставки и/или приоритеты. | Да |
Структура SetBidsItem | |||
CampaignId | long | Идентификатор кампании. Указывается, если требуется назначить единый CPC или CPA для всех фильтров в кампании. | Либо CampaignId, либо AdGroupId, либо Id |
AdGroupId | long | Идентификатор группы объявлений. Указывается, если требуется назначить единый CPC, CPA или приоритет для всех фильтров в группе. | |
Id | long | Идентификатор фильтра. Указывается, если требуется назначить CPC, CPA или приоритет для отдельного фильтра. | |
AverageCpc | long, nillable | Средняя цена клика, умноженная на 1 000 000. Целое число. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | Хотя бы один из параметров AverageCpc, AverageCpa и StrategyPriority (могут присутствовать все) |
AverageCpa | long, nillable | Средняя цена конверсии, умноженная на 1 000 000. Целое число. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | |
StrategyPriority | PriorityEnum | Приоритет: LOW, NORMAL или HIGH. Используется только для стратегии AVERAGE_ROI. | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / SetRequest (для SOAP) | |||
---|---|---|---|
Bids | array of SetBidsItem | Ставки и/или приоритеты. | Да |
Структура SetBidsItem | |||
CampaignId | long | Идентификатор кампании. Указывается, если требуется назначить единый CPC или CPA для всех фильтров в кампании. | Либо CampaignId, либо AdGroupId, либо Id |
AdGroupId | long | Идентификатор группы объявлений. Указывается, если требуется назначить единый CPC, CPA или приоритет для всех фильтров в группе. | |
Id | long | Идентификатор фильтра. Указывается, если требуется назначить CPC, CPA или приоритет для отдельного фильтра. | |
AverageCpc | long, nillable | Средняя цена клика, умноженная на 1 000 000. Целое число. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | Хотя бы один из параметров AverageCpc, AverageCpa и StrategyPriority (могут присутствовать все) |
AverageCpa | long, nillable | Средняя цена конверсии, умноженная на 1 000 000. Целое число. Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies. | |
StrategyPriority | PriorityEnum | Приоритет: LOW, NORMAL или HIGH. Используется только для стратегии AVERAGE_ROI. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"SetBidsResults": [{ /* SetBidsActionResult */
"CampaignId": (long),
"AdGroupId": (long),
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ]
}, ... ]
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / SetResponse (для SOAP) | ||
---|---|---|
SetBidsResults | array of SetBidActionResult | Результаты назначения CPC, CPA или приоритетов. |
Структура SetBidActionResult | ||
CampaignId | long | Идентификатор кампании. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
AdGroupId | long | Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
Id | long | Идентификатор фильтра. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |
Параметр | Тип | Описание |
Структура result (для JSON) / SetResponse (для SOAP) | ||
---|---|---|
SetBidsResults | array of SetBidActionResult | Результаты назначения CPC, CPA или приоритетов. |
Структура SetBidActionResult | ||
CampaignId | long | Идентификатор кампании. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
AdGroupId | long | Идентификатор группы объявлений. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
Id | long | Идентификатор фильтра. Возвращается в случае отсутствия ошибок (если был указан в запросе). |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |