Документация
API версии 4 и Live 4
Методы
Отключенные методы

GetBanners (Live)

Возвращает параметры групп объявлений, объявлений и фраз.
Внимание! 

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Метод возвращает параметры групп, объявлений и фраз. Параметры фраз возвращаются в сокращенном или в полном виде (см. параметр GetPhrases
[no-highlight[

Возвращать параметры фраз в массиве Phrases:

  • No — не возвращать параметры фраз;
  • Yes — возвращать сокращенный состав параметров;
  • WithPrices — возвращать полный состав параметров, включая цены и статистику.

Если параметр GetPhrases отсутствует, подразумевается значение Yes.

Требуется

Нет

]no-highlight]
).

Ограничения

Внимание! Метод возвращает только текстово-графические объявления. Для работы с объявлениями всех типов используйте сервис Ads API версии 5. Подробнее о типах объявлений...

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

Добавлены входные параметры Limit
[no-highlight[

Количество объявлений, параметры которых выводятся в ответе (число больше нуля). Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных.

Параметры Limit и Offset учитываются только при выборке по идентификаторам кампаний (CampaignIDS) и не учитываются при выборке по идентификаторам объявлений (BannerIDS).

Требуется

Нет

]no-highlight]
и Offset
[no-highlight[

Порядковый номер объявления в выборке из базы данных (число больше нуля). В ответе выводятся объявления начиная с указанного номера. Количество объявлений, возвращаемых за раз, указывают в параметре Limit.

Требуется

Нет

]no-highlight]
. Служат для постраничной выборки объявлений из базы данных.
Добавлены входные параметры Tags
[no-highlight[

Отбирать объявления по указанным меткам.

Данный параметр является взаимоисключающим с параметром TagIDS.

Требуется

Нет

]no-highlight]
и TagIDS
[no-highlight[

Отбирать объявления по меткам с указанными идентификаторами.

Данный параметр является взаимоисключающим с параметром Tags.

Требуется

Нет

]no-highlight]
для отбора объявлений по меткам и по идентификаторам меток.
Добавлен входной параметр FieldsNames
[no-highlight[

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

Примечание. 

Ограничивать состав возвращаемых параметров желательно, если запрашиваются данные большого количества объявлений. Такие запросы сильно нагружают API и могут обрабатываться медленно, вплоть до отказа в выполнении.

Требуется

Нет

]no-highlight]
, позволяющий ограничить состав возвращаемых данных.
Добавлены результирующие параметры фразы StatusPaused
[no-highlight[

Показы по фразе остановлены — Yes/No. Останавливать и возобновлять показы можно методом Keyword (Live).

]no-highlight]
, ContextClicks
[no-highlight[

Количество кликов по всем объявлениям группы, показанным в Рекламной сети Яндекса по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.

]no-highlight]
, ContextShows
[no-highlight[

Количество показов всех объявлений группы по данной фразе в Рекламной сети Яндекса. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.

]no-highlight]
.
Добавлен результирующий параметр объявления AgeLabel
[no-highlight[

Возрастная категория.

Для объявлений, относящихся к группе baby_food (соответствующее значение возвращается в массиве AdWarnings), — возраст ребенка в месяцах: ‘0months‘, ‘1months‘, ‘2months‘, ..., ‘12months‘.

Для прочих объявлений — возраст, на которую ориентирована информационная продукция. Возможные значения: ‘0+‘, ‘6+‘, ‘12+‘, ‘16+‘, ‘18+‘.

Если у объявления отсутствует возрастная категория, параметр не возвращается в ответах и игнорируется при попытке задать его.

Ограничение. 

Через API можно изменить только значение возрастной категории, если она есть у объявления. Чтобы изменить наличие/отсутствие возрастной категории, пожалуйста, обратитесь в службу поддержки Директа.

]no-highlight]
.
Добавлен входной параметр StatusAdImageModerate
[no-highlight[

Отбирать объявления по статусу модерации изображения:

  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.

Требуется

Нет

]no-highlight]
, а также результирующие параметры AdImageHash
[no-highlight[

Хэш изображения, привязанного к объявлению.

]no-highlight]
и StatusAdImageModerate
[no-highlight[

Результат модерации изображения, привязанного к объявлению:

  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.

]no-highlight]
.
Добавлен входной параметр Currency
[no-highlight[

Валюта, в которой должны быть выражены ставки в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании.

Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.). В этом случае, если кампания ведется в реальной валюте, возвращаемые значения конвертируются из валюты кампании в у. е. (см. раздел Реальные валюты вместо у. е.).

Если значение отлично от NULL и не совпадает с валютой кампании (одной из кампаний), возвращается ошибка с кодом 245.

Требуется

Нет

]no-highlight]
и результирующий параметр Currency
[no-highlight[

Валюта, в которой выражены ставки.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.).

]no-highlight]
(см. также раздел Реальные валюты вместо у. е.).
Добавлены результирующие параметры AdGroupID
[no-highlight[

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

]no-highlight]
и AdGroupName
[no-highlight[

Название группы объявлений.

]no-highlight]
.
Добавлен результирующий параметр AdGroupMobileBidAdjustment
[no-highlight[

Коэффициент настройки цен на мобильных устройствах.

Используется для групп объявлений и указывается в процентах от ставки на десктопе. Диапазон значений от 50 до 1300. Подробнее о коэффициенте можно узнать в разделе Корректировки ставок помощи Директа.

Примечание. Если коэффициент для группы не указан, то в расчетах для установки ставки цен на мобильных устройствах используется коэффициент для кампании (параметр MobileBidAdjustment) при его наличии.
]no-highlight]
.
Добавлен результирующий параметр Type
[no-highlight[

Тип объявления: Desktop или Mobile.

]no-highlight]
.
Добавлен входной параметр AuctionBids
[no-highlight[

Возвращать ли результаты торгов (массив AuctionBids) — Yes/No. Если не задано, подразумевается No.

Требуется

Нет

]no-highlight]
и результирующий массив AuctionBids
[no-highlight[

Массив объектов PhraseAuctionBids, содержащий результаты торгов по фразе: ставку за каждую позицию в спецразмещении и в нижнем блоке, а также списываемую цену для каждой позиции.

]no-highlight]
.

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

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

{
   "method": "GetBanners",
   "param": {
      /* GetBannersInfo */
      "CampaignIDS
[no-highlight[

Массив идентификаторов кампаний (не более 10 идентификаторов).

Метод возвращает параметры объявлений, принадлежащих указанным кампаниям.

Требуется

Один из параметров: CampaignIDS или BannerIDS

]no-highlight]
": [ (int) ... ], "BannerIDS
[no-highlight[

Массив, содержащий идентификаторы объявлений. Допускается указывать не более 2000 идентификаторов.

Данный параметр имеет приоритет над CampaignIDS: если указаны оба параметра, объявления отбираются по идентификаторам из массива BannerIDS.

Требуется

Один из параметров: CampaignIDS или BannerIDS

]no-highlight]
": [ (long) ... ], "FieldsNames
[no-highlight[

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

Примечание. 

Ограничивать состав возвращаемых параметров желательно, если запрашиваются данные большого количества объявлений. Такие запросы сильно нагружают API и могут обрабатываться медленно, вплоть до отказа в выполнении.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "GetPhrases
[no-highlight[

Возвращать параметры фраз в массиве Phrases:

  • No — не возвращать параметры фраз;
  • Yes — возвращать сокращенный состав параметров;
  • WithPrices — возвращать полный состав параметров, включая цены и статистику.

Если параметр GetPhrases отсутствует, подразумевается значение Yes.

Требуется

Нет

]no-highlight]
": (string), "Limit
[no-highlight[

Количество объявлений, параметры которых выводятся в ответе (число больше нуля). Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных.

Параметры Limit и Offset учитываются только при выборке по идентификаторам кампаний (CampaignIDS) и не учитываются при выборке по идентификаторам объявлений (BannerIDS).

Требуется

Нет

]no-highlight]
": (int), "Offset
[no-highlight[

Порядковый номер объявления в выборке из базы данных (число больше нуля). В ответе выводятся объявления начиная с указанного номера. Количество объявлений, возвращаемых за раз, указывают в параметре Limit.

Требуется

Нет

]no-highlight]
": (int), "Currency
[no-highlight[

Валюта, в которой должны быть выражены ставки в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании.

Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.). В этом случае, если кампания ведется в реальной валюте, возвращаемые значения конвертируются из валюты кампании в у. е. (см. раздел Реальные валюты вместо у. е.).

Если значение отлично от NULL и не совпадает с валютой кампании (одной из кампаний), возвращается ошибка с кодом 245.

Требуется

Нет

]no-highlight]
": (string), "Filter
[no-highlight[

Содержит объект BannersFilterInfo, задающий условия отбора объявлений.

Требуется

Нет

]no-highlight]
": { /* BannersFilterInfo */ "StatusPhoneModerate
[no-highlight[

Отбирать объявления по результату модерации визитки:

  • New — контактная информация не проверена;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusBannerModerate
[no-highlight[

Отбирать объявления по результату модерации:

  • New — объявление не проверено (статус «Черновик»);
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
  • PreliminaryAccept — объявление предварительно принято, окончательный результат будет известен позже.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusPhrasesModerate
[no-highlight[

Отбирать объявления по результату модерации фраз:

  • New — фразы не проверены;
  • Pending — выполняется проверка;
  • Yes — хотя бы одна фраза принята (некоторые могли быть отклонены);
  • No — все фразы отклонены;
  • PreliminaryAccept — фразы предварительно приняты, окончательный результат будет известен позже.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusActivating
[no-highlight[

Отбирать объявления по актуальности внесенных изменений:

  • Yes — внесенные изменения вступили в силу;
  • Pending — ожидается вступление изменений в силу.

Между внесением изменений в объявления и вступлением изменений в силу проходит некоторое время. Обычно оно не превышает 40 минут, но в часы наибольшей нагрузки может достигать трех часов.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusShow
[no-highlight[

Отбирать показываемые или непоказываемые объявления :

  • Yes — показ включен;
  • No — показ выключен.

Включение и выключение показа выполняется методами ResumeBanners и StopBanners соответственно.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "IsActive
[no-highlight[

Отбирать объявления по статусу активизации:

  • Yes — активизированные объявления;
  • No — неактивизированные объявления.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusArchive
[no-highlight[

Отбирать объявления по статусу архивирования:

  • Yes — в архиве;
  • No — не в архиве;
  • CurrencyConverted — объявления, автоматически заархивированные при переходе клиента на работу в валюте (см. раздел Реальные валюты вместо у. е.).

Требуется

Нет

]no-highlight]
": [ (string) ... ], "TagIDS
[no-highlight[

Отбирать объявления по меткам с указанными идентификаторами.

Данный параметр является взаимоисключающим с параметром Tags.

Требуется

Нет

]no-highlight]
": [ (int) ... ], "Tags
[no-highlight[

Отбирать объявления по указанным меткам.

Данный параметр является взаимоисключающим с параметром TagIDS.

Требуется

Нет

]no-highlight]
": [ (string) ... ], "StatusAdImageModerate
[no-highlight[

Отбирать объявления по статусу модерации изображения:

  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.

Требуется

Нет

]no-highlight]
": [ (string) ... ] }, "AuctionBids
[no-highlight[

Возвращать ли результаты торгов (массив AuctionBids) — Yes/No. Если не задано, подразумевается No.

Требуется

Нет

]no-highlight]
": (string) } }

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

Параметр Описание Требуется
Объект GetBannersInfo
CampaignIDS

Массив идентификаторов кампаний (не более 10 идентификаторов).

Метод возвращает параметры объявлений, принадлежащих указанным кампаниям.

Один из параметров: CampaignIDS или BannerIDS
BannerIDS

Массив, содержащий идентификаторы объявлений. Допускается указывать не более 2000 идентификаторов.

Данный параметр имеет приоритет над CampaignIDS: если указаны оба параметра, объявления отбираются по идентификаторам из массива BannerIDS.

Filter Содержит объект BannersFilterInfo, задающий условия отбора объявлений.Нет
FieldsNames

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

Примечание. 

Ограничивать состав возвращаемых параметров желательно, если запрашиваются данные большого количества объявлений. Такие запросы сильно нагружают API и могут обрабатываться медленно, вплоть до отказа в выполнении.

Нет
GetPhrases

Возвращать параметры фраз в массиве Phrases:

  • No — не возвращать параметры фраз;
  • Yes — возвращать сокращенный состав параметров;
  • WithPrices — возвращать полный состав параметров, включая цены и статистику.

Если параметр GetPhrases отсутствует, подразумевается значение Yes.

Нет
Limit

Количество объявлений, параметры которых выводятся в ответе (число больше нуля). Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных.

Параметры Limit и Offset учитываются только при выборке по идентификаторам кампаний (CampaignIDS) и не учитываются при выборке по идентификаторам объявлений (BannerIDS).

Нет
Offset Порядковый номер объявления в выборке из базы данных (число больше нуля). В ответе выводятся объявления начиная с указанного номера. Количество объявлений, возвращаемых за раз, указывают в параметре Limit. Нет
Currency

Валюта, в которой должны быть выражены ставки в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании.

Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.). В этом случае, если кампания ведется в реальной валюте, возвращаемые значения конвертируются из валюты кампании в у. е. (см. раздел Реальные валюты вместо у. е.).

Если значение отлично от NULL и не совпадает с валютой кампании (одной из кампаний), возвращается ошибка с кодом 245.

Нет
AuctionBids Возвращать ли результаты торгов (массив AuctionBids) — Yes/No. Если не задано, подразумевается No.Нет
Объект BannersFilterInfo
StatusBannerModerate

Отбирать объявления по результату модерации:

  • New — объявление не проверено (статус «Черновик»);
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
  • PreliminaryAccept — объявление предварительно принято, окончательный результат будет известен позже.
Нет
StatusPhrasesModerate

Отбирать объявления по результату модерации фраз:

  • New — фразы не проверены;
  • Pending — выполняется проверка;
  • Yes — хотя бы одна фраза принята (некоторые могли быть отклонены);
  • No — все фразы отклонены;
  • PreliminaryAccept — фразы предварительно приняты, окончательный результат будет известен позже.
Нет
StatusPhoneModerate

Отбирать объявления по результату модерации визитки:

  • New — контактная информация не проверена;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
Нет
StatusActivating

Отбирать объявления по актуальности внесенных изменений:

  • Yes — внесенные изменения вступили в силу;
  • Pending — ожидается вступление изменений в силу.

Между внесением изменений в объявления и вступлением изменений в силу проходит некоторое время. Обычно оно не превышает 40 минут, но в часы наибольшей нагрузки может достигать трех часов.

Нет
StatusShow

Отбирать показываемые или непоказываемые объявления :

  • Yes — показ включен;
  • No — показ выключен.
Включение и выключение показа выполняется методами ResumeBanners
[no-highlight[

Разрешает показ объявлений.

Подробнее ResumeBanners

]no-highlight]
и StopBanners
[no-highlight[

Останавливает показ объявлений.

Подробнее StopBanners

]no-highlight]
соответственно.
Нет
IsActive

Отбирать объявления по статусу активизации:

  • Yes — активизированные объявления;
  • No — неактивизированные объявления.
Нет
StatusArchive

Отбирать объявления по статусу архивирования:

  • Yes — в архиве;
  • No — не в архиве;
  • CurrencyConverted — объявления, автоматически заархивированные при переходе клиента на работу в валюте (см. раздел Реальные валюты вместо у. е.).
Нет
TagIDS

Отбирать объявления по меткам с указанными идентификаторами.

Данный параметр является взаимоисключающим с параметром Tags.

Нет
Tags

Отбирать объявления по указанным меткам.

Данный параметр является взаимоисключающим с параметром TagIDS.

Нет
StatusAdImageModerate Отбирать объявления по статусу модерации изображения:
  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.
Нет

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

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

{
   "data": [
      {  /* BannerInfo */
         "BannerID
[no-highlight[

Идентификатор объявления. Для создания объявления задают 0, для изменения параметров объявления указывают его идентификатор.

]no-highlight]
": (long), "CampaignID
[no-highlight[

Идентификатор кампании.

]no-highlight]
": (int), "AdGroupID
[no-highlight[

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

]no-highlight]
": (long), "AdGroupName
[no-highlight[

Название группы объявлений.

]no-highlight]
": (string), "Type
[no-highlight[

Тип объявления: Desktop или Mobile.

]no-highlight]
": (string), "Title
[no-highlight[

Заголовок объявления (до 33 символов, включая пробелы и знаки препинания).

]no-highlight]
": (string), "Text
[no-highlight[

Текст объявления (до 75 символов, включая пробелы и знаки препинания).

]no-highlight]
": (string), "Href
[no-highlight[

Ссылка на сайт рекламодателя. Может содержать подстановочные переменные (см. раздел Ссылки на сайт).

]no-highlight]
": (string), "Domain
[no-highlight[

Домен, на который ведет ссылка Href. Домен заполняется автоматически. Если ссылка ведет на редирект, в параметре указан конечный домен.

]no-highlight]
": (string), "Geo
[no-highlight[

Идентификаторы регионов, для которых показы включены или выключены. Идентификатор 0 или пустая строка — показывать во всех регионах (предустановленное значение).

Чтобы выключить показ в регионе, перед идентификатором региона ставят минус, например «1,-219» — показывать для Москвы и Московской области, кроме Черноголовки. Регионы с минусом нельзя использовать, если указан нулевой регион. Также параметр не должен состоять только из минус-регионов.

Полный список регионов можно получить с помощью метода GetRegions.

]no-highlight]
": (string), "ContactInfo
[no-highlight[

Объект ContactInfo с контактными данными рекламодателя (визитка).

]no-highlight]
": { /* ContactInfo */ "ContactPerson
[no-highlight[

Контактное лицо. Не более 155 символов.

]no-highlight]
": (string), "Country
[no-highlight[

Страна. Не более 50 символов.

]no-highlight]
": (string), "CountryCode
[no-highlight[

Телефонный код страны. Например, «+7» для России.

]no-highlight]
": (string), "City
[no-highlight[

Город. Не более 50 символов.

]no-highlight]
": (string), "Street
[no-highlight[

Улица. Не более 55 символов.

]no-highlight]
": (string), "House
[no-highlight[

Номер дома. Не более 30 символов.

]no-highlight]
": (string), "Build
[no-highlight[

Номер строения или корпуса. Не более 10 символов.

]no-highlight]
": (string), "Apart
[no-highlight[

Номер квартиры или офиса. Не более 255 символов.

]no-highlight]
": (string), "CityCode
[no-highlight[

Телефонный код города.

]no-highlight]
": (string), "Phone
[no-highlight[

Телефонный номер для связи.

]no-highlight]
": (string), "PhoneExt
[no-highlight[

Добавочный телефонный номер для соединения через офисную АТС.

]no-highlight]
": (string), "CompanyName
[no-highlight[

Название организации. Не более 255 символов.

]no-highlight]
": (string), "IMClient
[no-highlight[

Тип сети мгновенного обмена сообщениями — icq, jabber, skype, mail_agent.

]no-highlight]
": (string), "IMLogin
[no-highlight[

Логин в сети мгновенного обмена сообщениями.

]no-highlight]
": (string), "ExtraMessage
[no-highlight[

Дополнительная информация о рекламируемом товаре или услуге. Не более 200 символов.

]no-highlight]
": (string), "ContactEmail
[no-highlight[

Адрес электронной почты. Не более 255 символов.

]no-highlight]
": (string), "WorkTime
[no-highlight[

Режим работы организации или режим обслуживания клиентов. Задается как строка, в которой указан диапазон дней недели, рабочих часов и минут.

Дни недели обозначаются цифрами от 0 до 6, где 0 — понедельник, 6 — воскресенье.

Минуты задают кратно 15: 0, 15, 30 или 45.

Формат строки:

“день_с;день_по;час_с;минуты_с;час_до;мин_до“

Например, строка “0;4;10;0;18;0“ задает такой режим:

0;4 — с понедельника по пятницу;

10;0 — с 10 часов 0 минут;

18;0 — до 18 часов 0 минут.

Режим может состоять из нескольких строк указанного формата, например: “0;4;10;0;18;0;5;6;11;0;16;0“. Здесь в дополнение к предыдущему примеру задан режим:

5;6 — с субботы по воскресенье;

11;0 — с 11 часов 0 минут;

16;0 — до 16 часов 0 минут.

Круглосуточный режим работы задается строкой “0;6;00;00;00;00“.

]no-highlight]
": (string), "OGRN
[no-highlight[

Код ОГРН для юридических лиц.

]no-highlight]
": (string), "PointOnMap
[no-highlight[

Объект MapPoint, задающий координаты местоположения клиента. По этим координатам ставится метка на карте. Если не заданы, метка ставится по указанному адресу клиента.

]no-highlight]
": { /* MapPoint */ "x
[no-highlight[

Долгота точки. От -180 до 180.

]no-highlight]
": (float), "y
[no-highlight[

Широта точки. От -90 до 90.

]no-highlight]
": (float), "x1
[no-highlight[

Долгота левого нижнего угла области на карте. От -180 до 180.

]no-highlight]
": (float), "y1
[no-highlight[

Широта левого нижнего угла области на карте. От -90 до 90.

]no-highlight]
": (float), "x2
[no-highlight[

Долгота правого верхнего угла области на карте. От -180 до 180.

]no-highlight]
": (float), "y2
[no-highlight[

Широта правого верхнего угла области на карте. От -90 до 90.

]no-highlight]
": (float) } }, "Phrases
[no-highlight[

Массив объектов BannerPhraseInfo с параметрами фраз. Выводится, если входной параметр GetPhrases имеет значение «Yes» или «WithPrices» либо отсутствует.

]no-highlight]
": [ { /* BannerPhraseInfo */ "BannerID
[no-highlight[

Идентификатор объявления.

]no-highlight]
": (long), "CampaignID
[no-highlight[

Идентификатор кампании.

]no-highlight]
": (int), "AdGroupID
[no-highlight[

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

]no-highlight]
": (long), "PhraseID
[no-highlight[

Идентификатор фразы.

]no-highlight]
": (long), "Phrase
[no-highlight[

Ключевая фраза.

Может содержать минус-слова, которые указывают со знаком минус перед словом, например [молния -гром -дождь]. Общие для нескольких фраз минус-слова предпочтительно задавать в параметре группы объявлений MinusKeywords.

Длина ключевой фразы — не более 4096 символов. Оператор «!» перед минус-словом не учитывается в длине фразы (последовательность «-!» считается как один символ).

Не более 7 слов во фразе, без учета стоп-слов и минус-слов. Каждое слово и минус-слово — не более 35 символов, без учета минуса перед минус-словом.

]no-highlight]
": (string), "IsRubric
[no-highlight[

Признак того, что фраза является рубрикой Яндекс.Каталога. Всегда содержит значение No.

]no-highlight]
": (string), "Price
[no-highlight[

Ставка на поиске Яндекса (в валюте, указанной в параметре Currency)1. Используется, только если для кампании выбрана стратегия с ручным управлением ставками.

]no-highlight]
": (float), "ContextPrice
[no-highlight[

Ставка в Рекламной сети Яндекса (в валюте, указанной в параметре Currency)1.

Параметр доступен для изменения в следующих случаях:

  1. Для Рекламной сети выбрана стратегия MaximumCoverage.

  2. Для Рекламной сети выбрана стратегия Default и фраза отключена на поиске за низкий CTR.

    Для новых фраз данное условие не актуально, поскольку фразы больше не отключаются за низкий CTR.

]no-highlight]
": (float), "AutoBroker
[no-highlight[

Признак включенного автоброкера. Всегда содержит значение Yes.

]no-highlight]
": (string), "UserParams
[no-highlight[

Объект PhraseUserParams. Содержит значения подстановочных переменных для формирования ссылки на сайт (см. раздел Ссылки на сайт).

]no-highlight]
": { /* PhraseUserParams */ "Param1
[no-highlight[

Значение подстановочной переменной {param1}. Не более 255 байт.

]no-highlight]
": (string), "Param2
[no-highlight[

Значение подстановочной переменной {param2}. Не более 255 байт.

]no-highlight]
": (string) } "StatusPhraseModerate
[no-highlight[

Результат проверки фразы:

  • New — фраза не проверена;
  • Yes — принята;
  • No — отклонена;
]no-highlight]
": (string), "AutoBudgetPriority
[no-highlight[

Приоритет фразы при использовании автоматических стратегий. Возможные значения:

  • Low — низкий приоритет;
  • Medium — средний приоритет;
  • High — высокий приоритет.
]no-highlight]
": (string), "Clicks
[no-highlight[

Количество кликов по всем объявлениям группы, показанным на поиске по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.

]no-highlight]
": (int), "Shows
[no-highlight[

Количество показов всех объявлений группы по данной фразе на поиске. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.

]no-highlight]
": (int), "ContextClicks
[no-highlight[

Количество кликов по всем объявлениям группы, показанным в Рекламной сети Яндекса по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.

]no-highlight]
": (int), "ContextShows
[no-highlight[

Количество показов всех объявлений группы по данной фразе в Рекламной сети Яндекса. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.

]no-highlight]
": (int), "Min
[no-highlight[

Цена (в валюте, указанной в параметре Currency)2, обеспечивающая для большинства объявлений группы показ в блоке гарантированных показов.

]no-highlight]
": (float), "Max
[no-highlight[

Цена (в валюте, указанной в параметре Currency)2, обеспечивающая для большинства объявлений группы показ на первом месте в блоке гарантированных показов.

]no-highlight]
": (float), "PremiumMin
[no-highlight[

Цена (в валюте, указанной в параметре Currency)2, обеспечивающая для большинства объявлений группы показ в спецразмещении.

]no-highlight]
": (float), "PremiumMax
[no-highlight[

Цена (в валюте, указанной в параметре Currency)2, обеспечивающая для большинства объявлений группы показ на первом месте в спецразмещении.

]no-highlight]
": (float), "LowCTRWarning
[no-highlight[

Фраза имеет низкий CTR и может быть вскоре отключена — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

]no-highlight]
": (string), "LowCTR
[no-highlight[

Фраза отключена на поиске за низкий CTR — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

]no-highlight]
": (string), "ContextLowCTR
[no-highlight[

Фраза отключена на сайтах Рекламной сети Яндекса за низкий CTR — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

]no-highlight]
": (string), "Coverage
[no-highlight[

Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории на поиске.

Ограничение. 

Параметр утратил актуальность, использовать его для подбора ставок не следует.

]no-highlight]
": [ { /* CoverageInfo */ "Probability
[no-highlight[

Частота показа при ставке из параметра Price.

В массиве ContextCoverage указывается в процентах от 0 до 100. Используется для подбора ставок.

]no-highlight]
": (float), "Price
[no-highlight[

Ставка (в валюте, указанной в параметре Currency)2, для которой параметр Probability содержит частоту показа.

]no-highlight]
": (float) } ... ], "ContextCoverage
[no-highlight[

Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории в Рекламной сети Яндекса.

Параметр полезен для подбора ставок к фразам.

]no-highlight]
": [ { /* CoverageInfo */ "Probability
[no-highlight[

Частота показа при ставке из параметра Price.

В массиве ContextCoverage указывается в процентах от 0 до 100. Используется для подбора ставок.

]no-highlight]
": (float), "Price
[no-highlight[

Ставка (в валюте, указанной в параметре Currency)2, для которой параметр Probability содержит частоту показа.

]no-highlight]
": (float) } ... ], "Prices
[no-highlight[

Массив минимальных ставок за все позиции в спецразмещении и в блоке гарантированных показов (в валюте, указанной в параметре Currency)2.

]no-highlight]
": [ (float) ... ], "CurrentOnSearch
[no-highlight[

Конечная цена клика c учетом автоброкера (в валюте, указанной в параметре Currency)2.

Если по фразе не осуществляется показ объявления на поиске или фраза отключена на поиске за низкий CTR, в параметре возвращается значение NULL.

]no-highlight]
": (float), "MinPrice
[no-highlight[

Минимальная цена, назначаемая индивидуально для каждого рекламодателя (в валюте, указанной в параметре Currency)2.

]no-highlight]
": (float), "StatusPaused
[no-highlight[

Показы по фразе остановлены — Yes/No. Останавливать и возобновлять показы можно методом Keyword (Live).

]no-highlight]
": (string), "Currency
[no-highlight[

Валюта, в которой выражены ставки.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.).

]no-highlight]
": (string), "AuctionBids
[no-highlight[

Массив объектов PhraseAuctionBids, содержащий результаты торгов по фразе: ставку за каждую позицию в спецразмещении и в нижнем блоке, а также списываемую цену для каждой позиции.

]no-highlight]
": [ { /* PhraseAuctionBids */ "Position
[no-highlight[

Позиция показа: Pmn, где

  • m — номер блока (1 — спецразмещение, 2 — блок гарантированных показов);
  • n — номер позиции в рамках блока.

Например, P12 — второе место в спецразмещении, P21 — первое место в блоке гарантированных показов.

]no-highlight]
": (string), "Bid
[no-highlight[

Минимальная ставка за указанную позицию (в валюте, указанной в параметре Currency)2.

]no-highlight]
": (float), "Price
[no-highlight[

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

]no-highlight]
": (float) } ... ] } ... ], "StatusActivating
[no-highlight[

Все внесенные изменения вступили в силу — Yes/Pending.

]no-highlight]
": (string), "StatusArchive
[no-highlight[

Состояние архивации объявления:

  • Yes — в архиве;
  • No — не в архиве;
  • CurrencyConverted — автоматически заархивировано при переходе клиента на работу в валюте и не может быть разархивировано (см. раздел Реальные валюты вместо у. е.).
]no-highlight]
": (string), "StatusBannerModerate
[no-highlight[

Результат модерации объявления (проверяется текст и ссылка):

  • New — объявление не проверено (статус «Черновик»);
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
  • PreliminaryAccept — объявление предварительно принято, окончательный результат будет известен позже.
]no-highlight]
": (string), "StatusPhrasesModerate
[no-highlight[

Результат модерации фраз:

  • New — фразы не проверены;
  • Pending — выполняется проверка;
  • Yes — хотя бы одна фраза принята (некоторые могли быть отклонены);
  • No — все фразы отклонены;
  • PreliminaryAccept — фразы предварительно приняты, окончательный результат будет известен позже.
]no-highlight]
": (string), "StatusPhoneModerate
[no-highlight[

Результат модерации визитки:

  • New — контактная информация не проверена;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
]no-highlight]
": (string), "StatusAdImageModerate
[no-highlight[

Результат модерации изображения, привязанного к объявлению:

  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.

]no-highlight]
": (string), "StatusShow
[no-highlight[

Показ объявления включен — Yes/No. Включение и выключение показа выполняется методами ResumeBanners и StopBanners.

Разрешение показа не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявление проверены модератором, показ на уровне кампании разрешен (метод ResumeCampaign). Фактическому показу соответствует значение Yes в параметре IsActive.

]no-highlight]
": (string), "IsActive
[no-highlight[

Объявление активно — Yes/No.

Под активностью понимается состояние объявлений, при котором показ включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивными являются объявления, показ которых выключен пользователем или менеджером Яндекса и не может быть включен автоматически.

]no-highlight]
": (string), "StatusSitelinksModerate
[no-highlight[

Результат проверки быстрых ссылок:

  • New — быстрые ссылки не проверены;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено.

]no-highlight]
": (string), "Sitelinks
[no-highlight[

Массив объектов Sitelink с быстрыми ссылками. Массив должен содержать от 1 до 4 объектов Sitelink или отсутствовать.

]no-highlight]
": [ { /* Sitelink */ "Title
[no-highlight[

Текст быстрой ссылки.

]no-highlight]
": (string), "Href
[no-highlight[

Адрес быстрой ссылки. Может содержать подстановочные переменные (см. раздел Ссылки на сайт).

Внимание! В быстрых ссылках подстановка значений переменных {campaign_id}, {ad_id}, {banner_id}, {phrase_id} гарантируется только при наличии этих же переменных в основной ссылке объявления.
]no-highlight]
": (string) } ... ], "AdWarnings
[no-highlight[

Массив, содержащий отметки о принадлежности объекта рекламирования к особым категориям. Для таких категорий показ объявлений либо запрещен, либо сопровождается предупреждением в соответствии с законодательством РФ. Возможные группы:

  • abortion — медицинские услуги по искусственному прерыванию беременности;
  • alcohol — алкогольная продукция, пиво и напитки на его основе;
  • baby_food — детское питание;
  • dietarysuppl — БАД;
  • medicine — лекарственные средства, медицинская техника, медицинские услуги, в том числе методы лечения;
  • pseudoweapon — изделия, конструктивно сходные с оружием;
  • tobacco — табак и табачные изделия;
  • project_declaration — долевое строительство.
]no-highlight]
": [ (string) ... ], "FixedOnModeration
[no-highlight[

В ходе модерации исправлены опечатки — Yes/No.

]no-highlight]
": (string), "ModerateRejectionReasons
[no-highlight[

Массив объектов RejectReason. Эти объекты описывают причины, по которым отклонен текст объявления, фраза, контактная информация, быстрая ссылка.

]no-highlight]
": [ { /* RejectReason */ "Type
[no-highlight[

Тип объекта, отклоненного на модерации, — Banner, Phrases, ContactInfo, Sitelink.

]no-highlight]
": (string), "Text
[no-highlight[

Причина отклонения на модерации.

]no-highlight]
": (string) } ... ], "MinusKeywords
[no-highlight[

Массив минус-фраз, общих для всех ключевых фраз группы объявлений.

Минус-фразу следует указывать без минуса перед первым словом.

Не более 7 слов в минус-фразе. Длина каждого слова — не более 35 символов. Суммарная длина минус-фраз в массиве — не более 4096 символов. Оператор «!» или «+» перед словом не учитывается в суммарной длине.

Примечание. Минус-фразы, общие для всех групп в кампании, предпочтительно задавать в одноименном параметре кампании.
]no-highlight]
": [ (string) ... ], "AgeLabel
[no-highlight[

Возрастная категория.

Для объявлений, относящихся к группе baby_food (соответствующее значение возвращается в массиве AdWarnings), — возраст ребенка в месяцах: ‘0months‘, ‘1months‘, ‘2months‘, ..., ‘12months‘.

Для прочих объявлений — возраст, на которую ориентирована информационная продукция. Возможные значения: ‘0+‘, ‘6+‘, ‘12+‘, ‘16+‘, ‘18+‘.

Если у объявления отсутствует возрастная категория, параметр не возвращается в ответах и игнорируется при попытке задать его.

Ограничение. 

Через API можно изменить только значение возрастной категории, если она есть у объявления. Чтобы изменить наличие/отсутствие возрастной категории, пожалуйста, обратитесь в службу поддержки Директа.

]no-highlight]
": (string), "AdImageHash
[no-highlight[

Хэш изображения, привязанного к объявлению.

]no-highlight]
": (string), "AdGroupMobileBidAdjustment
[no-highlight[

Коэффициент настройки цен на мобильных устройствах.

Используется для групп объявлений и указывается в процентах от ставки на десктопе. Диапазон значений от 50 до 1300. Подробнее о коэффициенте можно узнать в разделе Корректировки ставок помощи Директа.

Примечание. Если коэффициент для группы не указан, то в расчетах для установки ставки цен на мобильных устройствах используется коэффициент для кампании (параметр MobileBidAdjustment) при его наличии.
]no-highlight]
": (int) } ... ] }

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

Параметр Описание
Объект BannerInfo
BannerID

Идентификатор объявления. Для создания объявления задают 0, для изменения параметров объявления указывают его идентификатор.

CampaignID Идентификатор кампании.
AdGroupID Идентификатор группы объявлений.
AdGroupName Название группы объявлений.
Type Тип объявления: Desktop или Mobile.
Title Заголовок объявления (до 33 символов, включая пробелы и знаки препинания).
Text Текст объявления (до 75 символов, включая пробелы и знаки препинания).
Href

Ссылка на сайт рекламодателя. Может содержать подстановочные переменные (см. раздел Ссылки на сайт).

Domain Домен, на который ведет ссылка Href. Домен заполняется автоматически. Если ссылка ведет на редирект, в параметре указан конечный домен.
Geo

Идентификаторы регионов, для которых показы включены или выключены. Идентификатор 0 или пустая строка — показывать во всех регионах (предустановленное значение).

Чтобы выключить показ в регионе, перед идентификатором региона ставят минус, например «1,-219» — показывать для Москвы и Московской области, кроме Черноголовки. Регионы с минусом нельзя использовать, если указан нулевой регион. Также параметр не должен состоять только из минус-регионов.

Полный список регионов можно получить с помощью метода GetRegions
[no-highlight[

Возвращает список регионов, зарегистрированных в Яндекс.Директе.

Подробнее GetRegions

]no-highlight]
.
ContactInfo

Объект ContactInfo с контактными данными рекламодателя (визитка).

Phrases Массив объектов BannerPhraseInfo с параметрами фраз. Выводится, если входной параметр GetPhrases имеет значение «Yes» или «WithPrices» либо отсутствует.
StatusActivating Все внесенные изменения вступили в силу — Yes/Pending.
StatusArchive

Состояние архивации объявления:

  • Yes — в архиве;
  • No — не в архиве;
  • CurrencyConverted — автоматически заархивировано при переходе клиента на работу в валюте и не может быть разархивировано (см. раздел Реальные валюты вместо у. е.).
StatusBannerModerate

Результат модерации объявления (проверяется текст и ссылка):

  • New — объявление не проверено (статус «Черновик»);
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
  • PreliminaryAccept — объявление предварительно принято, окончательный результат будет известен позже.
StatusPhrasesModerate

Результат модерации фраз:

  • New — фразы не проверены;
  • Pending — выполняется проверка;
  • Yes — хотя бы одна фраза принята (некоторые могли быть отклонены);
  • No — все фразы отклонены;
  • PreliminaryAccept — фразы предварительно приняты, окончательный результат будет известен позже.
StatusPhoneModerate

Результат модерации визитки:

  • New — контактная информация не проверена;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено;
StatusAdImageModerate Результат модерации изображения, привязанного к объявлению:
  • New — изображение не проверено;
  • Pending — выполняетcя проверка;
  • Yes — принято;
  • No — отклонено.
StatusShow

Показ объявления включен — Yes/No. Включение и выключение показа выполняется методами ResumeBanners и StopBanners.

Разрешение показа не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявление проверены модератором, показ на уровне кампании разрешен (метод ResumeCampaign
[no-highlight[

Разрешает показ объявлений кампании.

Подробнее ResumeCampaign

]no-highlight]
). Фактическому показу соответствует значение Yes в параметре IsActive.
IsActive

Объявление активно — Yes/No.

Под активностью понимается состояние объявлений, при котором показ включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивными являются объявления, показ которых выключен пользователем или менеджером Яндекса и не может быть включен автоматически.

StatusSitelinksModerate Результат проверки быстрых ссылок:
  • New — быстрые ссылки не проверены;
  • Pending — выполняется проверка;
  • Yes — принято;
  • No — отклонено.
Sitelinks

Массив объектов Sitelink с быстрыми ссылками. Массив должен содержать от 1 до 4 объектов Sitelink или отсутствовать.

AdWarnings

Массив, содержащий отметки о принадлежности объекта рекламирования к особым категориям. Для таких категорий показ объявлений либо запрещен, либо сопровождается предупреждением в соответствии с законодательством РФ. Возможные группы:

  • abortion — медицинские услуги по искусственному прерыванию беременности;
  • alcohol — алкогольная продукция, пиво и напитки на его основе;
  • baby_food — детское питание;
  • dietarysuppl — БАД;
  • medicine — лекарственные средства, медицинская техника, медицинские услуги, в том числе методы лечения;
  • pseudoweapon — изделия, конструктивно сходные с оружием;
  • tobacco — табак и табачные изделия;
  • project_declaration — долевое строительство.
FixedOnModeration В ходе модерации исправлены опечатки — Yes/No.
ModerateRejectionReasons Массив объектов RejectReason. Эти объекты описывают причины, по которым отклонен текст объявления, фраза, контактная информация, быстрая ссылка.
MinusKeywords

Массив минус-фраз, общих для всех ключевых фраз группы объявлений.

Минус-фразу следует указывать без минуса перед первым словом.

Не более 7 слов в минус-фразе. Длина каждого слова — не более 35 символов. Суммарная длина минус-фраз в массиве — не более 4096 символов. Оператор «!» или «+» перед словом не учитывается в суммарной длине.

Примечание. Минус-фразы, общие для всех групп в кампании, предпочтительно задавать в одноименном параметре кампании.
AgeLabel

Возрастная категория.

Для объявлений, относящихся к группе baby_food (соответствующее значение возвращается в массиве AdWarnings), — возраст ребенка в месяцах: '0months', '1months', '2months', ..., '12months'.

Для прочих объявлений — возраст, на которую ориентирована информационная продукция. Возможные значения: '0+', '6+', '12+', '16+', '18+'.

Если у объявления отсутствует возрастная категория, параметр не возвращается в ответах и игнорируется при попытке задать его.

Ограничение. 

Через API можно изменить только значение возрастной категории, если она есть у объявления. Чтобы изменить наличие/отсутствие возрастной категории, пожалуйста, обратитесь в службу поддержки Директа.

AdImageHash Хэш изображения, привязанного к объявлению.
AdGroupMobileBidAdjustment

Коэффициент настройки цен на мобильных устройствах.

Используется для групп объявлений и указывается в процентах от ставки на десктопе. Диапазон значений от 50 до 1300. Подробнее о коэффициенте можно узнать в разделе Корректировки ставок помощи Директа.

Примечание. Если коэффициент для группы не указан, то в расчетах для установки ставки цен на мобильных устройствах используется коэффициент для кампании (параметр MobileBidAdjustment
[no-highlight[

Коэффициент настройки цен на мобильных устройствах.

Используется для кампаний и указывается в процентах от ставки на десктопе. Диапазон значений от 50 до 1300. Значение по умолчанию — 100. При данном значении ставка на мобильных устройствах равна ставке на десктопе. Подробнее о коэффициенте можно узнать в разделе Корректировки ставок помощи Директа.

Требуется

Нет

]no-highlight]
) при его наличии.
Объект ContactInfo
ContactPerson

Контактное лицо. Не более 155 символов.

Country

Страна. Не более 50 символов.

CountryCode

Телефонный код страны. Например, «+7» для России.

City

Город. Не более 50 символов.

Street

Улица. Не более 55 символов.

House

Номер дома. Не более 30 символов.

Build

Номер строения или корпуса. Не более 10 символов.

Apart

Номер квартиры или офиса. Не более 255 символов.

CityCode

Телефонный код города.

Phone

Телефонный номер для связи.

PhoneExt

Добавочный телефонный номер для соединения через офисную АТС.

CompanyName

Название организации. Не более 255 символов.

IMClient

Тип сети мгновенного обмена сообщениями — icq, jabber, skype, mail_agent.

IMLogin

Логин в сети мгновенного обмена сообщениями.

ExtraMessage

Дополнительная информация о рекламируемом товаре или услуге. Не более 200 символов.

ContactEmail

Адрес электронной почты. Не более 255 символов.

WorkTime

Режим работы организации или режим обслуживания клиентов. Задается как строка, в которой указан диапазон дней недели, рабочих часов и минут.

Дни недели обозначаются цифрами от 0 до 6, где 0 — понедельник, 6 — воскресенье.

Минуты задают кратно 15: 0, 15, 30 или 45.

Формат строки:

"день_с;день_по;час_с;минуты_с;час_до;мин_до"

Например, строка "0;4;10;0;18;0" задает такой режим:

0;4 — с понедельника по пятницу;

10;0 — с 10 часов 0 минут;

18;0 — до 18 часов 0 минут.

Режим может состоять из нескольких строк указанного формата, например: "0;4;10;0;18;0;5;6;11;0;16;0". Здесь в дополнение к предыдущему примеру задан режим:

5;6 — с субботы по воскресенье;

11;0 — с 11 часов 0 минут;

16;0 — до 16 часов 0 минут.

Круглосуточный режим работы задается строкой "0;6;00;00;00;00".

OGRN

Код ОГРН для юридических лиц.

PointOnMap

Объект MapPoint, задающий координаты местоположения клиента. По этим координатам ставится метка на карте. Если не заданы, метка ставится по указанному адресу клиента.

Объект MapPoint
x

Долгота точки. От -180 до 180.

y

Широта точки. От -90 до 90.

x1

Долгота левого нижнего угла области на карте. От -180 до 180.

y1

Широта левого нижнего угла области на карте. От -90 до 90.

x2

Долгота правого верхнего угла области на карте. От -180 до 180.

y2

Широта правого верхнего угла области на карте. От -90 до 90.

Объект BannerPhraseInfo
BannerID

Идентификатор объявления.

CampaignID

Идентификатор кампании.

AdGroupID Идентификатор группы объявлений.
PhraseID

Идентификатор фразы.

Phrase

Ключевая фраза.

Может содержать минус-слова, которые указывают со знаком минус перед словом, например [молния -гром -дождь]. Общие для нескольких фраз минус-слова предпочтительно задавать в параметре группы объявлений MinusKeywords.

Длина ключевой фразы — не более 4096 символов. Оператор «!» перед минус-словом не учитывается в длине фразы (последовательность «-!» считается как один символ).

Не более 7 слов во фразе, без учета стоп-слов и минус-слов. Каждое слово и минус-слово — не более 35 символов, без учета минуса перед минус-словом.

IsRubric

Признак того, что фраза является рубрикой Яндекс.Каталога. Всегда содержит значение No.

Price
Ставка на поиске Яндекса (в валюте, указанной в параметре Currency) 1
[no-highlight[

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

]no-highlight]
. Используется, только если для кампании выбрана стратегия
[no-highlight[

Стратегия на поиске. Ниже перечислены возможные значения.

  • ShowsDisabled — выключить показ объявлений на поиске. Это необходимо для использования автоматической стратегии в Рекламной сети Яндекса. Показ на поиске невозможно выключить, если для Рекламной сети применяется стратегия Default.

Стратегии с ручным управлением ставками на поиске:

  • HighestPosition — стратегия «Наивысшая доступная позиция»;
  • LowestCost — стратегия «Показ в блоке по минимальной цене»;
  • LowestCostPremium — стратегия «Показ в блоке по минимальной цене», но объявления показываются только в спецразмещении;
  • LowestCostGuarantee — стратегия «Показ под результатами поиска» (в нижнем блоке по наименьшей цене);
  • RightBlockHighest — стратегия «Показ под результатами поиска» (в нижнем блоке на наивысшей позиции, доступной при указанной ставке).

Автоматические стратегии на поиске:

  • WeeklyBudget — стратегия «Недельный бюджет: максимум кликов» (обязательный параметр WeeklySumLimit, дополнительный MaxPrice);
  • CPAOptimizer — стратегия «Недельный бюджет: максимальная конверсия» (обязательные параметры WeeklySumLimit и GoalID, дополнительный MaxPrice); см. условия подключения стратегии в помощи Директа;
  • AverageClickPrice — стратегия «Средняя цена клика» (обязательный параметр AveragePrice, дополнительный WeeklySumLimit);
  • WeeklyPacketOfClicks — стратегия «Недельный пакет кликов» (обязательный параметр ClicksPerWeek, дополнительные MaxPrice или AveragePrice);
  • AverageCPAOptimization — стратегия «Средняя цена конверсии» (обязательные параметры AverageCPA и GoalID, дополнительные WeeklySumLimit и MaxPrice); см. условия подключения стратегии в помощи Директа;
  • ROIOptimization — стратегия «Средняя рентабельность инвестиций» (обязательные параметры ReserveReturn, ROICoef, GoalID, дополнительные Profitability, WeeklySumLimit и MaxPrice); см. условия подключения стратегии в помощи Директа.

Требуется

Да

]no-highlight]
с ручным управлением ставками.
ContextPrice
Ставка в Рекламной сети Яндекса (в валюте, указанной в параметре Currency) 1
[no-highlight[

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

]no-highlight]
.

Параметр доступен для изменения в следующих случаях:

  1. Для Рекламной сети выбрана стратегия MaximumCoverage.

  2. Для Рекламной сети выбрана стратегия Default и фраза отключена на поиске за низкий CTR.

    Для новых фраз данное условие не актуально, поскольку фразы больше не отключаются за низкий CTR.

AutoBroker

Признак включенного автоброкера. Всегда содержит значение Yes.

UserParams

Объект PhraseUserParams. Содержит значения подстановочных переменных для формирования ссылки на сайт (см. раздел Ссылки на сайт).

StatusPhraseModerate

Результат проверки фразы:

  • New — фраза не проверена;
  • Yes — принята;
  • No — отклонена;
AutoBudgetPriority

Приоритет фразы при использовании автоматических стратегий. Возможные значения:

  • Low — низкий приоритет;
  • Medium — средний приоритет;
  • High — высокий приоритет.
Clicks

Количество кликов по всем объявлениям группы, показанным на поиске по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.

Shows

Количество показов всех объявлений группы по данной фразе на поиске. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.

ContextClicks

Количество кликов по всем объявлениям группы, показанным в Рекламной сети Яндекса по данной фразе. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один клик по объявлению.

ContextShows

Количество показов всех объявлений группы по данной фразе в Рекламной сети Яндекса. Рассчитывается за 28 дней от текущей даты. Для расчета отбираются дни, в течение которых был хотя бы один показ объявления по данной фразе.

Min Цена (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
, обеспечивающая для большинства объявлений группы показ в блоке гарантированных показов.
Max Цена (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
, обеспечивающая для большинства объявлений группы показ на первом месте в блоке гарантированных показов.
PremiumMin
Цена (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
, обеспечивающая для большинства объявлений группы показ в спецразмещении.
PremiumMax Цена (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
, обеспечивающая для большинства объявлений группы показ на первом месте в спецразмещении.
LowCTRWarning

Фраза имеет низкий CTR и может быть вскоре отключена — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

LowCTR

Фраза отключена на поиске за низкий CTR — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

ContextLowCTR

Фраза отключена на сайтах Рекламной сети Яндекса за низкий CTR — Yes/No.

Ограничение. 

Параметр утратил актуальность для новых фраз, поскольку фразы больше не отключаются за низкий CTR.

Coverage

Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории на поиске.

Ограничение. 

Параметр утратил актуальность, использовать его для подбора ставок не следует.

ContextCoverage

Массив объектов CoverageInfo, которые указывают прогнозируемый охват аудитории в Рекламной сети Яндекса.

Параметр полезен для подбора ставок к фразам.

Prices
Массив минимальных ставок за все позиции в спецразмещении и в блоке гарантированных показов (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
.
CurrentOnSearch
Конечная цена клика c учетом автоброкера (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
.

Если по фразе не осуществляется показ объявления на поиске или фраза отключена на поиске за низкий CTR, в параметре возвращается значение NULL.

MinPrice
Минимальная цена, назначаемая индивидуально для каждого рекламодателя (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
.
StatusPaused

Показы по фразе остановлены — Yes/No. Останавливать и возобновлять показы можно методом Keyword (Live).

Currency

Валюта, в которой выражены ставки.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Если параметр отсутствует или равен NULL, подразумеваются условные единицы (у. е.).

AuctionBids Массив объектов PhraseAuctionBids, содержащий результаты торгов по фразе: ставку за каждую позицию в спецразмещении и в нижнем блоке, а также списываемую цену для каждой позиции.
Объект CoverageInfo
Probability

Частота показа при ставке из параметра Price.

В массиве ContextCoverage указывается в процентах от 0 до 100. Используется для подбора ставок.

Price Ставка (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
, для которой параметр Probability содержит частоту показа.
Объект PhraseUserParams
Param1

Значение подстановочной переменной {param1}. Не более 255 байт.

Param2

Значение подстановочной переменной {param2}. Не более 255 байт.

Объект Sitelink
Title

Текст быстрой ссылки.

Href

Адрес быстрой ссылки. Может содержать подстановочные переменные (см. раздел Ссылки на сайт).

Внимание! В быстрых ссылках подстановка значений переменных {campaign_id}, {ad_id}, {banner_id}, {phrase_id} гарантируется только при наличии этих же переменных в основной ссылке объявления.
Объект RejectReason
Type Тип объекта, отклоненного на модерации, — Banner, Phrases, ContactInfo, Sitelink.
Text Причина отклонения на модерации.
Объект PhraseAuctionBids
Position Позиция показа: Pmn, где
  • m — номер блока (1 — спецразмещение, 2 — блок гарантированных показов);
  • n — номер позиции в рамках блока.

Например, P12 — второе место в спецразмещении, P21 — первое место в блоке гарантированных показов.

Bid Минимальная ставка за указанную позицию (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
.
Price Списываемая цена для указанной позиции (в валюте, указанной в параметре Currency) 2
[no-highlight[Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).]no-highlight]
.
Примечания
  1. Если возвращаемые ставки конвертируются из валюты кампании в у. е., то они округляются по математическим правилам с точностью до второго знака после запятой (для всех валют, в том числе тенге).

  2. Если возвращаемые параметры торгов (цены позиций показа и охвата аудитории, ставки конкурентов) конвертируются из валюты кампании в у. е., то они округляются вверх с точностью до шага торгов (0,01 у. е., см. также раздел Реальные валюты вместо у. е.).
  3. В редких случаях цены позиций показа и некоторые другие параметры, связанные с результатами аукциона, могут иметь значение NULL, что говорит об ошибке получения данных на стороне API. Рекомендуется повторить вызов метода через некоторое время.

Примеры входных данных

{
   'BannerIDS': [1974642, 20920155, 20155899, 64654],
   'Filter': {
      'StatusPhoneModerate': ['Yes'],
      'StatusBannerModerate': ['Yes'],
      'StatusPhrasesModerate': ['Yes'],
      'StatusActivating': ['Yes'],
      'StatusShow': ['Yes'],
      'IsActive': ['Yes'],
      'StatusArchive': ['No']
   },
   'GetPhrases': 'WithPrices',
   'Limit': 20,
   'Offset': 1
}
array(
   'BannerIDS' => array(1974642, 20920155, 20155899, 64654),
   'Filter' => array(
      'StatusPhoneModerate' => array('Yes'),
      'StatusBannerModerate' => array('Yes'),
      'StatusPhrasesModerate' => array('Yes'),
      'StatusActivating' => array('Yes'),
      'StatusShow' => array('Yes'),
      'IsActive' => array('Yes'),
      'StatusArchive' => array('No')
   ),
   'GetPhrases' => 'WithPrices',
   'Limit' => 20,
   'Offset' => 1
)
{
   'BannerIDS' => [1974642, 20920155, 20155899, 64654],
   'Filter' => {
      'StatusPhoneModerate' => ['Yes'],
      'StatusBannerModerate' => ['Yes'],
      'StatusPhrasesModerate' => ['Yes'],
      'StatusActivating' => ['Yes'],
      'StatusShow' => ['Yes'],
      'IsActive' => ['Yes'],
      'StatusArchive' => ['No']
   },
   'GetPhrases' => 'WithPrices',
   'Limit' => 20,
   'Offset' => 1
}