GetBannerPhrases (Live)

Возвращает информацию о фразах.

Новое в версии Live 4

Добавлен результирующий параметр StatusPaused.

Добавлены результирующие параметры ContextClicks и ContextShows.

Добавлен результирующий параметр AdGroupID.

Ограничения

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

Alert

Метод поддерживает только текстово-графические объявления. Для работы с ключевыми фразами объявлений всех типов используйте сервис {#T} API версии 5.

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "GetBannerPhrases",
   "param": [
      (long)
      ...
   ]
}

Параметр param содержит массив идентификаторов объявлений BannerID (не более 1000).

Результирующие данные

Метод возвращает массив объектов BannerPhraseInfo с информацией о фразах. Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* BannerPhraseInfo */
         "BannerID": (long),
         "CampaignID": (int),
         "AdGroupID": (long),
         "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),
         "ContextClicks": (int),
         "ContextShows": (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),
         "StatusPaused": (string)
      }
      ...
   ]
}

Ниже приведено описание параметров.

Параметр	Описание
Объект BannerPhraseInfo
`BannerID`	Идентификатор объявления.
`CampaignID`	Идентификатор кампании.
`AdGroupID`	Идентификатор группы объявлений.
`PhraseID`	Идентификатор фразы.
`Phrase`	Ключевая фраза. Может содержать минус-слова, которые указывают со знаком минус перед словом, например [молния -гром -дождь]. Общие для нескольких фраз минус-слова предпочтительно задавать в параметре группы объявлений `MinusKeywords`. Длина ключевой фразы — не более 4096 символов. Оператор “!” перед минус-словом не учитывается в длине фразы (последовательность “-!” считается как один символ). Не более 7 слов во фразе, без учета стоп-слов и минус-слов. Каждое слово и минус-слово — не более 35 символов, без учета минуса перед минус-словом.
`IsRubric`	Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No.
`Price`	Ставка на поиске Яндекса (у. е)1. Указывается, только если для кампании выбрана стратегия с ручным управлением ставками.
`ContextPrice`	Ставка в Рекламной сети Яндекса (у. е.)1. Параметр доступен для изменения в следующих случаях: Для Рекламной сети выбрана стратегия MaximumCoverage. Для Рекламной сети выбрана стратегия Default и фраза отключена на поиске за низкий CTR. Для новых фраз данное условие не актуально, поскольку фразы больше не отключаются за низкий CTR.
`AutoBroker`	Признак включенного автоброкера. Всегда содержит значение Yes.
`UserParams`	Объект `PhraseUserParams`. Содержит значения подстановочных переменных для формирования ссылки на сайт (см. раздел {#T}).
`StatusPhraseModerate`	Результат проверки фразы: New — фраза не проверена; Yes — принята; No — отклонена;
`AutoBudgetPriority`	Приоритет фразы при использовании автоматических стратегий. Возможные значения: Low — низкий приоритет; Medium — средний приоритет; High — высокий приоритет.
`Clicks`	Количество кликов по всем объявлениям группы, показанным на поиске по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.
`Shows`	Количество показов всех объявлений группы по данной фразе на поиске. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.
`ContextClicks`	Количество кликов по всем объявлениям группы, показанным в Рекламной сети Яндекса по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.
`ContextShows`	Количество показов всех объявлений группы по данной фразе в Рекламной сети Яндекса. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.
`Min`	Цена (у. е.)2, обеспечивающая для большинства объявлений группы показ в нижнем блоке.
`Max`	Цена (у. е.)2, обеспечивающая для большинства объявлений группы показ на первом месте в нижнем блоке.
`PremiumMin`	Цена (у. е.)2, обеспечивающая для большинства объявлений группы показ в спецразмещении.
`PremiumMax`	Цена (у. е.)2, обеспечивающая для большинства объявлений группы показ на первом месте в спецразмещении.
`LowCTRWarning`	Фраза имеет низкий CTR и может быть вскоре отключена — Yes/No. Alert Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.
`LowCTR`	Фраза отключена на поиске за низкий CTR — Yes/No. Alert Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.
`ContextLowCTR`	Фраза отключена на сайтах Рекламной сети Яндекса за низкий CTR — Yes/No. Alert Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.
`Coverage`	Массив объектов `CoverageInfo`, которые указывают прогнозируемый охват аудитории на поиске. Alert Параметр утратил актуальность, использовать его для подбора ставок не следует.
`ContextCoverage`	Массив объектов `CoverageInfo`, которые указывают прогнозируемый охват аудитории в Рекламной сети Яндекса. Параметр полезен для подбора ставок к фразам.
`Prices`	Массив ставок за все позиции в спецразмещении и в нижнем блоке (у. е.).
`CurrentOnSearch`	Конечная цена клика c учетом автоброкера. Если по фразе не осуществляется показ объявления на поиске или фраза отключена на поиске за низкий CTR, в параметре возвращается значение NULL.
`MinPrice`	Минимальная цена (у. е.)2, назначаемая индивидуально для каждого рекламодателя.
`StatusPaused`	Показы по фразе остановлены — Yes/No. Останавливать и возобновлять показы можно методом Keyword (Live).
Объект CoverageInfo
`Probability`	Частота показа при ставке из параметра `Price`. В массиве `ContextCoverage` указывается в процентах от 0 до 100. Используется для подбора ставок.
`Price`	Ставка (у. е.)2, для которой параметр `Probability` содержит частоту показа.
Объект PhraseUserParams
`Param1`	Значение подстановочной переменной `{param1}`. Не более 255 байт.
`Param2`	Значение подстановочной переменной `{param2}`. Не более 255 байт.
Примечания
Если возвращаемые ставки конвертируются из валюты кампании в у. е., то они округляются по математическим правилам с точностью до второго знака после запятой (для всех валют, в том числе тенге). Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Real currencies instead of Yandex units). В редких случаях цены позиций показа и некоторые другие параметры, связанные с результатами аукциона, могут иметь значение NULL, что говорит об ошибке получения данных на стороне API. Рекомендуется повторить вызов метода через некоторое время.

Was the article helpful?

GetBannerPhrases

GetBannerPhrasesFilter