Документация
API версии 5. Руководство разработчика
API версии 5. Справочник

Объявление (Ad)

Объявление представляет собой рекламный материал. Набор параметров объявления зависит от его типа.

Сервис

Для управления объявлениями предназначен сервис Ads.

Методы

add | update | delete | suspend | resume | archive | unarchive | moderate | get

Ограничения

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

Тип объявления должен соответствовать типу группы, см. таблицу в разделе Тип объявления.

Ограничения на параметры объявления см. в разделе Количественные ограничения помощи Директа.

Никакие операции с объявлениями в архивной кампании невозможны.

Примечание. 
  • Объявление на украинском языке можно добавить только в группу, у которой регионы показа ограничены Украиной.
  • Объявление на казахском языке можно добавить только в группу, у которой регионы показа ограничены Казахстаном.
  • Объявление на турецком языке можно добавить только в группу, у которой регионы показа ограничены Турцией.

Тип объявления

Тип объявления задается при создании и недоступен для изменения.

В настоящее время существуют следующие типы объявлений:

  • TEXT_AD — текстово-графическое (обычное) объявление.

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

    Чтобы создать или отредактировать текстово-графическое объявление, его параметры необходимо передать в структуре TextAd методов add, update.

    Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре TextAdFieldNames метода get.

  • MOBILE_APP_AD — объявление для рекламы мобильных приложений.

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

    Чтобы создать или отредактировать объявление для рекламы мобильных приложений, его параметры необходимо передать в структуре MobileAppAd методов add, update.

    Чтобы получить параметры мобильного объявления, необходимо перечислить имена параметров во входном параметре MobileAppAdFieldNames метода get.

  • DYNAMIC_TEXT_AD — динамическое объявление.

    Объявление содержит текст. В объявление также можно добавить изображение, набор быстрых ссылок, виртуальную визитку, уточнения. Подробнее о динамических объявлениях см. в разделе Динамические объявления помощи Директа.

    Чтобы создать или отредактировать динамическое объявление, его параметры необходимо передать в структуре DynamicTextAd методов add, update.

    Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре DynamicTextAdFieldNames метода get.

  • IMAGE_AD — графическое объявление.

    Существуют два подтипа графических объявлений:

    • TEXT_IMAGE_AD

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

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

      Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре TextImageAdFieldNames метода get.

    • MOBILE_APP_IMAGE_AD

      Объявление содержит изображение. В объявление также можно добавить трекинговую ссылку для отслеживания установок.

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

      Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре MobileAppImageAdFieldNames метода get.

    Внимание! 

    Графические объявления показываются только в сетях (Рекламной сети Яндекса и внешних сетях), но не показываются на поиске.

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

    Подробнее о графических объявлениях см. в разделе Графические объявления помощи Директа.

Параметры Type, Subtype, Status, State, StatusClarification, AdCategories, AgeLabel являются общими для всех типов объявлений. Чтобы получить их, необходимо перечислить имена нужных параметров во входном параметре FieldNames метода get.

Соответствие типов объявлений и групп представлено в таблице ниже.

Тип группыДопустимые типы объявлений
TEXT_AD_GROUP

TEXT_AD

IMAGE_AD, подтип TEXT_IMAGE_AD

MOBILE_APP_AD_GROUP

MOBILE_APP_AD

IMAGE_AD, подтип MOBILE_APP_IMAGE_AD

DYNAMIC_TEXT_AD_GROUPDYNAMIC_TEXT_AD

Статус и состояние объявления

Параметр State отражает текущее состояние объявления.

СостояниеОписание
SUSPENDEDПоказы объявления остановлены владельцем с помощью метода suspend или в веб-интерфейсе.
OFF_BY_MONITORINGПоказы объявления автоматически остановлены мониторингом доступности сайта.
ONОбъявление активно, принадлежит к активной кампании и может быть показано (при наличии средств на кампании, в соответствии с настройками временного таргетинга и т. п.).
OFFОбъявление неактивно (черновик, ожидает модерации, отклонено) или принадлежит к неактивной либо остановленной кампании.
ARCHIVEDОбъявление помещено в архив (с помощью метода archive или пользователем в веб-интерфейсе) или принадлежит к архивной кампании.

Параметр Status отражает результат модерации объявления.

СтатусОписание
DRAFT

Объявление создано и еще не отправлено на модерацию.

MODERATIONОбъявление находится на модерации.
PREACCEPTEDОбъявление допущено к показам автоматически, но будет дополнительно проверено модератором.
ACCEPTEDОбъявление принято модерацией.
REJECTEDОбъявление отклонено модерацией.
Примечание. 

Если объявление было отредактировано, новая версия ожидает модерации (статус MODERATION) или сразу отклонена модерацией (статус REJECTED), то продолжаются показы предыдущей версии объявления, если оно не было остановлено. В этом случае объявление находится в состоянии ON.

Если после редактирования новая версия объявления была допущена к показам автоматически (PREACCEPTED), а затем отклонена (REJECTED), показы предыдущей версии не возобновляются.

Особая категория

На модерации объявлению может быть присвоена отметка о принадлежности рекламируемого товара или услуги к особой категории. При этом у объявления появляется параметр AdCategories, недоступный для изменения.

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

Справочник особых категорий можно получить с помощью метода Dictionaries.get.

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

Возрастная метка

Параметр AgeLabel содержит возрастную категорию рекламируемой продукции, если указание категории требует Федеральный закон РФ «О рекламе». Порядок присвоения возрастной метки отличается в зависимости от типа объявления.

Значение возрастной метки зависит от принадлежности к особой категории BABY_FOOD:

  • Для объявлений, относящихся к категории BABY_FOOD, — возраст ребенка в месяцах: "MONTHS_0", "MONTHS_1", "MONTHS_2", ..., "MONTHS_12".

  • Для прочих объявлений — возраст, на которую ориентирована информационная продукция. Возможные значения: "AGE_0", "AGE_6", "AGE_12", "AGE_16", "AGE_18".

Если у объявления отсутствует возрастная метка, задать ее нельзя (значение параметра игнорируется методом update).

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

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

Возрастная метка присваивается всем объявлениям. Возможные значения: "AGE_0", "AGE_6", "AGE_12", "AGE_16", "AGE_18".

Метку можно указать при создании объявления. Значение по умолчанию — "AGE_18". Значение метки можно изменить при редактировании объявления, но удалить метку нельзя.

Дополнения к объявлению

Методы add и update позволяют привязать к объявлению визитку, изображение, видеодополнение, набор быстрых ссылок, уточнения (в зависимости от типа объявления). Подробная инструкция приведена в разделе Добавление визитки, изображения, быстрых ссылок, уточнений, видеодополнения.

Ставка для изображений и видеодополнений

Изображения и видеодополнения показываются только в сетях (Рекламной сети Яндекса и внешних сетях), но не показываются на поиске.

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

Результат модерации дополнений

Визитка, изображение, видеодополнение, набор быстрых ссылок проходят модерацию не изолированно, а в связке с объявлением. Отправка на модерацию происходит автоматически, если само объявление находится на модерации или уже проверено модерацией.

Метод get возвращает результат модерации визитки (структура VCardModeration), изображения (структура AdImageModeration), набора быстрых ссылок (структура SitelinksModeration), видеодополнения (параметр Status в структуре VideoExtension).

Статус модерацииОписание
DRAFTДополнение не отправлялось на модерацию.
MODERATION

Дополнение находится на модерации.

ACCEPTEDДополнение принято модерацией. Объявление при показе будет содержать дополнение.
REJECTEDДополнение отклонено модерацией.
UNKNOWNНеизвестный статус. Используется для обеспечения обратной совместимости и отображения статусов, не поддерживаемых в данной версии API.