GetBanners (Live)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• abortion — медицинские услуги по искусственному прерыванию беременности;
• alcohol — алкогольная продукция, пиво и напитки на его основе;
• baby_food — детское питание;
• dietarysuppl — БАД;
• medicine — лекарственные средства, медицинская техника, медицинские услуги, в том числе методы лечения;
• pseudoweapon — изделия, конструктивно сходные с оружием;
• tobacco — табак и табачные изделия;
• project_declaration — долевое строительство.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Дни недели обозначаются цифрами от 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".

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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