Объявление (Ad)
Объявление представляет собой рекламный материал. Набор параметров объявления зависит от его типа.
Узнайте больше
Сервис
Для управления объявлениями предназначен сервис Ads.
Методы
add | update | delete | suspend | resume | archive | unarchive | moderate |get
Для работы с товарными объявлениями используется адрес https://api.direct.yandex.com/v501/
.
Ограничения
Тип объявления должен соответствовать типу группы, см. таблицу в разделе Тип объявления.
Никакие операции с объявлениями в архивной кампании невозможны.
Ограничение на количество объявлений в группе для рекламодателя можно получить с помощью метода Clients.get или AgencyClients.get (элемент ADS_TOTAL_PER_ADGROUP массива Restrictions.
Ограничения на параметры объявления см. в разделе Количественные ограничения помощи Директа.
Примечание
- Объявление на белорусском языке можно добавить только в группу, у которой регионы показа ограничены Беларусью.
- Объявление на казахском языке можно добавить только в группу, у которой регионы показа ограничены Казахстаном.
- Объявление на турецком языке можно добавить только в группу, у которой регионы показа ограничены Турцией.
Тип объявления
Тип объявления задается при создании и недоступен для изменения.
В настоящее время существуют следующие типы объявлений:
-
TEXT_AD — текстово-графическое (обычное) объявление.
Объявление содержит заголовок и текст объявления, а также ссылку на рекламируемый сайт. В объявление также можно добавить Турбо-страницу, отображаемую ссылку, изображение, видеодополнение, цену, набор быстрых ссылок, виртуальную визитку, уточнения, идентификатор профиля организации на Яндексе. При наличии Турбо-страницы, или визитки, или идентификатора профиля организации ссылка на сайт необязательна. Объявлению может быть автоматически присвоена возрастная метка — в этом случае значение метки можно изменить.
Чтобы создать или отредактировать текстово-графическое объявление, его параметры необходимо передать в структуре
TextAd
методов add, update.Чтобы получить параметры объявления (кроме параметров цены), необходимо перечислить имена параметров во входном параметре
TextAdFieldNames
метода get. Чтобы получить параметры цены, необходимо перечислить их имена во входном параметреTextAdPriceExtensionFieldNames
. -
SMART_AD — смарт-баннер.
Объявление содержит креатив, созданный в конструкторе креативов.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
SmartAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
SmartAdBuilderAdFieldNames
метода 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. -
TEXT_AD_BUILDER_AD
Объявление содержит креатив, созданный в конструкторе креативов, а также ссылку на рекламируемый сайт и/или Турбо-страницу.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
TextAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
TextAdBuilderAdFieldNames
метода get. -
MOBILE_APP_AD_BUILDER_AD
Объявление содержит креатив, созданный в конструкторе креативов. В объявление также можно добавить трекинговую ссылку для отслеживания установок.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
MobileAppAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
MobileAppAdBuilderAdFieldNames
метода get.
Внимание
Графические объявления показываются только в сетях (Рекламной сети Яндекса и внешних сетях), но не показываются на поиске.
Показ графического объявления возможен только при условии, что ставка по ключевой фразе или условию нацеливания на аудиторию не ниже минимальной ставки для объявления с включенным в него изображением, указанной на странице Минимальный и максимальный размер цены за клик.
Подробнее о графических объявлениях см. в разделе Графические объявления помощи Директа.
-
-
CPC_VIDEO_AD — видеообъявление в кампаниях с типом «Текстово-графические объявления» или «Реклама мобильных приложений».
Объявление содержит креатив, созданный в конструкторе креативов, а также ссылку на рекламируемый сайт и/или Турбо-страницу.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
CpcVideoAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
CpcVideoAdBuilderAdFieldNames
метода get.В кампаниях с типом «Реклама мобильных приложений» используется отдельный подтип для видеообъявлений — MOBILE_APP_CPC_VIDEO_AD_BUILDER_AD.
-
MOBILE_APP_CPC_VIDEO_AD_BUILDER_AD
Такое объявление содержит креатив, созданный в конструкторе креативов. В объявление также можно добавить трекинговую ссылку для отслеживания установок.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
MobileAppCpcVideoAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
MobileAppCpcVideoAdBuilderAdFieldNames
метода get.
-
-
CPM_BANNER_AD — медийный баннер.
Объявление содержит креатив, загруженный в веб-интерфейсе или созданный в конструкторе креативов, а также ссылку на рекламируемый сайт и/или Турбо-страницу. В объявление также можно добавить пиксель Яндекс Аудиторий и счетчик показов ADFOX.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
CpmBannerAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
CpmBannerAdBuilderAdFieldNames
метода get. -
CPM_VIDEO_AD — медийное видеообъявление (в кампании с типом «Медийная кампания»).
Объявление содержит креатив, созданный в конструкторе креативов, а также ссылку на рекламируемый сайт и/или Турбо-страницу. В объявление также можно добавить счетчик показов ADFOX.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
CpmVideoAdBuilderAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
CpmVideoAdBuilderAdFieldNames
метода get. -
SHOPPING_AD – товарное объявление (в кампании с типом «Единая перфоманс кампания»).
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
ShoppingAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
ShoppingAdFieldNames
метода get. -
LISTING_AD – объявление для страниц каталога (в кампании с типом «Единая перфоманс кампания»).
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
ListingAd
методов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
ListingAdFieldNames
метода get.
Параметры Type
, Subtype
, Status
, State
, StatusClarification
, AdCategories
, AgeLabel
являются общими для всех типов объявлений. Чтобы получить их, необходимо перечислить имена нужных параметров во входном параметре FieldNames
метода get.
Соответствие типов объявлений и групп представлено в таблице ниже.
Тип группы |
Допустимые типы объявлений |
TEXT_AD_GROUP |
TEXT_AD IMAGE_AD, подтипы TEXT_IMAGE_AD, TEXT_AD_BUILDER_AD CPC_VIDEO_AD |
SMART_AD_GROUP |
SMART_AD |
MOBILE_APP_AD_GROUP |
MOBILE_APP_AD IMAGE_AD, подтипы MOBILE_APP_IMAGE_AD, MOBILE_APP_AD_BUILDER_AD CPC_VIDEO_AD, подтип MOBILE_APP_CPC_VIDEO_AD_BUILDER_AD |
DYNAMIC_TEXT_AD_GROUP |
DYNAMIC_TEXT_AD |
CPM_BANNER_AD_GROUP |
CPM_BANNER_AD |
CPM_VIDEO_AD_GROUP |
CPM_VIDEO_AD |
UNIFIED_AD_GROUP |
TEXT_AD IMAGE_AD, подтипы TEXT_IMAGE_AD, TEXT_AD_BUILDER_AD SHOPPING_AD, LISTING_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. |
Правила отбора для товарных объявлений
Правило отбора состоит из трех параметров:
Operand
— поле фида;Operator
— оператор сравнения;Arguments
— массив значений, с которыми сравнивается значение поля в фиде.
Описание полей для каждого типа фида представлено в разделе Настройка фильтров помощи Директа.
Совместимость полей фида и операторов зависит от фида:
Розничная торговля, другой бизнес: фид Яндекс Маркета
Поле фида |
Операторы |
Ограничения на значения |
categoryId |
GREATER_THAN, LESS_THAN |
Одно число |
EQUALS_ANY |
До 20 000 чисел |
|
RANGE |
До 10 диапазонов, см. пример. |
|
id |
GREATER_THAN, LESS_THAN |
Одно число |
EQUALS_ANY |
До 50 чисел |
|
RANGE |
До 10 диапазонов, см. пример. |
|
market_category typePrefix vendor |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
EXISTS |
Передайте значение 1 |
|
description model name |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
url |
EQUALS,CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
oldprice price |
GREATER_THAN, LESS_THAN |
Одно число, до 2 знаков после запятой |
EQUALS_ANY |
До 50 чисел, до 2 знаков после запятой |
|
RANGE |
До 10 диапазонов, до 2 знаков после запятой, см. пример. |
|
EXISTS |
Передайте значение 1 |
|
adult manufacturer_warranty pickup store |
EQUALS_ANY |
Допустимые значения:
|
EXISTS |
Передайте значение 1 |
|
age |
EQUALS_ANY |
Допустимые значения: целое число от 0 до 12, 16 или 18. |
EXISTS |
Передайте значение 1 |
Отели: фид «Отели и аренда жилья» Google Рекламы
Поле фида |
Операторы |
Ограничения на значения |
Рrice |
GREATER_THAN, LESS_THAN |
Одно число, до 2 знаков после запятой |
EQUALS_ANY |
До 50 чисел, до 2 знаков после запятой |
|
RANGE |
До 10 диапазонов, до 2 знаков после запятой, см. пример. |
|
Description max_score name location url |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
class |
EQUALS_ANY |
Допустимые значения:
|
EXISTS |
Передайте значение 1 |
|
OfferID score |
GREATER_THAN, LESS_THAN |
Одно целое число |
EQUALS_ANY |
До 50 целых чисел |
|
RANGE |
До 10 диапазонов, целые числа, см. пример. |
Автомобили: фид Авто.ру
Поле фида |
Операторы |
Ограничения на значения |
body_type color folder_id mark_id |
CONTAINS_ANY, NOT_CONTAINS_ALL, |
До 50 строк, не более 175 символов в строке |
wheel |
CONTAINS_ANY |
Рекомендуемые значения:
|
metallic |
EQUALS_ANY |
Рекомендуемые значения:
|
availability |
EQUALS_ANY |
Рекомендуемые значения:
|
year |
EQUALS_ANY |
До 10 чисел |
url |
CONTAINS_ANY, NOT_CONTAINS_ALL, EQUALS_ANY |
До 50 строк, не более 175 символов в строке |
price |
GREATER_THAN, LESS_THAN |
Одно целое число |
EQUALS_ANY |
До 50 целых чисел |
|
RANGE |
До 10 диапазонов, см. пример. |
Недвижимость: фид Яндекс Недвижимости
Правила отбора для такого фида не предусмотрены.
Авиабилеты: фид «Авиабилеты» Google Рекламы
Правила отбора для такого фида не предусмотрены.
Другой бизнес: универсальный фид
Поле фида |
Операторы |
Ограничения на значения |
url |
EQUALS_ANY, CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
description name |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
EXISTS |
Передайте значение 1 |
|
price oldprice |
GREATER_THAN, LESS_THAN |
Одно число, до 2 знаков после запятой |
EQUALS_ANY |
До 50 чисел, до 2 знаков после запятой |
|
RANGE |
До 10 диапазонов, до 2 знаков после запятой, см. пример. |
Другой бизнес: фид «Специальный» Google Рекламы
Поле фида |
Операторы |
Ограничения на значения |
category description name second_title |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
EXISTS |
Передайте значение 1 |
|
url |
EQUALS_ANY, CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
price sale_price |
GREATER_THAN, LESS_THAN |
Одно число, до 2 знаков после запятой |
IN_RANGE |
До 10 диапазонов, до 2 знаков после запятой |
|
EQUALS_ANY |
До 50 значений, до 2 знаков после запятой |
Другой бизнес: фид «Путешествия» Google Рекламы
Поле фида |
Операторы |
Ограничения на значения |
Category destination origin Title |
CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
EXISTS |
Передайте значение 1 |
|
url |
EQUALS_ANY, CONTAINS_ANY, NOT_CONTAINS_ALL |
До 50 строк, не более 175 символов в строке |
price sale_price |
GREATER_THAN, LESS_THAN |
Одно число, до 2 знаков после запятой |
IN_RANGE |
До 10 диапазонов, до 2 знаков после запятой |
|
EQUALS_ANY |
До 50 чисел, до 2 знаков после запятой |
Примеры
Значение содержит одну из заданных строк:
{
"Operand": "mark_id",
"Operator": "CONTAINS_ANY",
"Arguments": ["Audi","Opel"]
}
Диапазон: цена от 111 до 222 или от 3000 до 10000:
{
"Operand": "price",
"Operator": "IN_RANGE",
"Arguments": ["111-222", "3000-10000"]
}
Значение из списка:
{
"Operand": "wheel",
"Operator": "EQUALS_ANY",
"Arguments": ["левый"]
}
Маркировка рекламы
Параметр ErirAdDescription
содержит описание объекта рекламы.
Параметр AutogeneratedErirAdDescription
содержит автоматически сгенерированное описание объекта рекламы.
Подробнее про маркировку рекламы см. здесь.
Для рекламодателя
Количественные ограничения на объекты рекламодателя.
Для агентства
—