GetBannerPhrases
Возвращает информацию о фразах.
Метод отключен. Используйте API версии 5.
Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.
Для метода существует версия GetBannerPhrases (Live).
Ограничения
Получение фраз из архивных кампаний недоступно.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetBannerPhrases",
"param": [
(long)
...
]
}
Параметр param содержит массив идентификаторов объявлений BannerID (не более 1000).
Результирующие данные
Метод возвращает массив объектов BannerPhraseInfo с информацией о фразах. Ниже показана структура результирующих данных в формате JSON.
{
"data": [
{ /* BannerPhraseInfo */
"BannerID": (long),
"CampaignID": (int),
"PhraseID": (long),
"Phrase": (string),
"IsRubric": (string),
"Price": (float),
"ContextPrice": (float),
"AutoBroker": (string),
"UserParams": {
/* PhraseUserParams */
"Param1": (string),
"Param2": (string)
}
"StatusPhraseModerate": (string),
"AutoBudgetPriority": (string),
"Clicks": (int),
"Shows": (int),
"Min": (float),
"Max": (float),
"PremiumMin": (float),
"PremiumMax": (float),
"LowCTRWarning": (string),
"LowCTR": (string),
"ContextLowCTR": (string),
"Coverage": [
{ /* CoverageInfo */
"Probability": (float),
"Price": (float)
}
...
],
"ContextCoverage": [
{ /* CoverageInfo */
"Probability": (float),
"Price": (float)
}
...
],
"Prices": [
(float)
...
],
"CurrentOnSearch": (float),
"MinPrice": (float),
}
...
]
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект BannerPhraseInfo | |
---|---|
CampaignID | Идентификатор кампании. |
BannerID | Идентификатор объявления. |
PhraseID | Идентификатор фразы. |
Phrase | Ключевая фраза. Может содержать минус-слова, которые указывают со знаком минус перед словом, например [молния -гром -дождь]. Общие для нескольких фраз минус-слова предпочтительно задавать в параметре группы объявлений MinusKeywords. Длина ключевой фразы — не более 4096 символов. Оператор «!» перед минус-словом не учитывается в длине фразы (последовательность «-!» считается как один символ). Не более 7 слов во фразе, без учета стоп-слов и минус-слов. Каждое слово и минус-слово — не более 35 символов, без учета минуса перед минус-словом. |
IsRubric | Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No. |
Price | Ставка на поиске Яндекса (у. е.). Предустановленное ограничение — 50 у. е. Требуется, только если для кампании выбрана стратегия с ручным управлением ставками. |
ContextPrice | Ставка в Рекламной сети Яндекса (у. е.). Ставку можно задавать в следующих случаях:
|
AutoBroker | Признак включенного автоброкера. Всегда содержит значение Yes. |
UserParams | Объект PhraseUserParams. Содержит значения подстановочных переменных для формирования ссылки на сайт (см. раздел Ссылки на сайт). |
StatusPhraseModerate | Результат проверки фразы:
|
AutoBudgetPriority | Приоритет фразы при использовании автоматических стратегий. Возможные значения:
|
Clicks | Количество кликов по объявлению, показанному на поиске по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению. |
Shows | Количество показов объявления по данной фразе на поиске. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе. |
Min | Минимальная ставка за вход в блок гарантированных показов. |
Max | Минимальная ставка за 1-ю позицию в блоке гарантированных показов. |
PremiumMin | Минимальная ставка за вход в спецразмещение. |
PremiumMax | Минимальная ставка за 1-ю позицию в спецразмещении. |
LowCTRWarning | Фраза имеет низкий CTR и может быть вскоре отключена — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
LowCTR | Фраза отключена на поиске за низкий CTR — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
ContextLowCTR | Фраза отключена на сайтах Рекламной сети Яндекса за низкий CTR — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
Coverage | Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории на поиске. Ограничение. Параметр утратил актуальность, использовать его для подбора ставок не следует. |
ContextCoverage | Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории в Рекламной сети Яндекса. Параметр полезен для подбора ставок к фразам. |
Prices | Массив ставок за все позиции в спецразмещении и в блоке гарантированных показов. |
CurrentOnSearch | Конечная цена клика c учетом автоброкера. Если по фразе не осуществляется показ объявления на поиске или фраза отключена на поиске за низкий CTR, в параметре возвращается значение NULL. |
MinPrice | Минимальная цена, назначаемая индивидуально для каждого рекламодателя. |
Объект CoverageInfo | |
Probability | Частота показа при ставке из параметра Price. В массиве ContextCoverage указывается в процентах от 0 до 100. Используется для подбора ставок. |
Price | Ставка, для которой параметр Probability содержит частоту показа. |
Объект PhraseUserParams | |
Param1 | Значение подстановочной переменной |
Param2 | Значение подстановочной переменной |
Примечания | |
|
Параметр | Описание |
Объект BannerPhraseInfo | |
---|---|
CampaignID | Идентификатор кампании. |
BannerID | Идентификатор объявления. |
PhraseID | Идентификатор фразы. |
Phrase | Ключевая фраза. Может содержать минус-слова, которые указывают со знаком минус перед словом, например [молния -гром -дождь]. Общие для нескольких фраз минус-слова предпочтительно задавать в параметре группы объявлений MinusKeywords. Длина ключевой фразы — не более 4096 символов. Оператор «!» перед минус-словом не учитывается в длине фразы (последовательность «-!» считается как один символ). Не более 7 слов во фразе, без учета стоп-слов и минус-слов. Каждое слово и минус-слово — не более 35 символов, без учета минуса перед минус-словом. |
IsRubric | Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No. |
Price | Ставка на поиске Яндекса (у. е.). Предустановленное ограничение — 50 у. е. Требуется, только если для кампании выбрана стратегия с ручным управлением ставками. |
ContextPrice | Ставка в Рекламной сети Яндекса (у. е.). Ставку можно задавать в следующих случаях:
|
AutoBroker | Признак включенного автоброкера. Всегда содержит значение Yes. |
UserParams | Объект PhraseUserParams. Содержит значения подстановочных переменных для формирования ссылки на сайт (см. раздел Ссылки на сайт). |
StatusPhraseModerate | Результат проверки фразы:
|
AutoBudgetPriority | Приоритет фразы при использовании автоматических стратегий. Возможные значения:
|
Clicks | Количество кликов по объявлению, показанному на поиске по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению. |
Shows | Количество показов объявления по данной фразе на поиске. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе. |
Min | Минимальная ставка за вход в блок гарантированных показов. |
Max | Минимальная ставка за 1-ю позицию в блоке гарантированных показов. |
PremiumMin | Минимальная ставка за вход в спецразмещение. |
PremiumMax | Минимальная ставка за 1-ю позицию в спецразмещении. |
LowCTRWarning | Фраза имеет низкий CTR и может быть вскоре отключена — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
LowCTR | Фраза отключена на поиске за низкий CTR — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
ContextLowCTR | Фраза отключена на сайтах Рекламной сети Яндекса за низкий CTR — Yes/No. Ограничение. Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR. |
Coverage | Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории на поиске. Ограничение. Параметр утратил актуальность, использовать его для подбора ставок не следует. |
ContextCoverage | Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории в Рекламной сети Яндекса. Параметр полезен для подбора ставок к фразам. |
Prices | Массив ставок за все позиции в спецразмещении и в блоке гарантированных показов. |
CurrentOnSearch | Конечная цена клика c учетом автоброкера. Если по фразе не осуществляется показ объявления на поиске или фраза отключена на поиске за низкий CTR, в параметре возвращается значение NULL. |
MinPrice | Минимальная цена, назначаемая индивидуально для каждого рекламодателя. |
Объект CoverageInfo | |
Probability | Частота показа при ставке из параметра Price. В массиве ContextCoverage указывается в процентах от 0 до 100. Используется для подбора ставок. |
Price | Ставка, для которой параметр Probability содержит частоту показа. |
Объект PhraseUserParams | |
Param1 | Значение подстановочной переменной |
Param2 | Значение подстановочной переменной |
Примечания | |
|