Объявление (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).
Ограничения на параметры объявления см. в разделе Количественные ограничения Справки Директа.
Примечание
- Объявление на белорусском языке можно добавить только в группу, у которой регионы показа ограничены Беларусью.
- Объявление на казахском языке можно добавить только в группу, у которой регионы показа ограничены Казахстаном.
- Объявление на турецком языке можно добавить только в группу, у которой регионы показа ограничены Турцией.
Тип объявления
С 30 июня текстово-графические объявления в Единых перфоманс-кампаниях доступны только для редактирования. Для задач, которые раньше решались с помощью текстово-графических объявлений, создавайте комбинаторные.
С 14 июля началось обновление существующих текстово-графических объявлений до комбинаторных. Статистика и настройки, которые вы задавали изначально, после обновления сохранятся.
Тип объявления задается при создании и недоступен для изменения.
Существуют следующие типы объявлений:
-
TEXT_AD — текстово-графическое (обычное) объявление.
Объявление содержит заголовок и текст объявления, а также ссылку на продвигаемый сайт. В объявление также можно добавить отображаемую ссылку, изображение, видео, цену, набор быстрых ссылок, уточнения, идентификатор профиля организации на Яндексе. Объявлению может быть автоматически присвоена возрастная метка — в этом случае значение метки можно изменить.
Чтобы создать или отредактировать текстово-графическое объявление, его параметры необходимо передать в структуре
TextAdметодов add, update.Чтобы получить параметры объявления (кроме параметров цены), необходимо перечислить имена параметров во входном параметре
TextAdFieldNamesметода get. Чтобы получить параметры цены, необходимо перечислить их имена во входном параметреTextAdPriceExtensionFieldNames. -
IMAGE_AD — графическое объявление.
Подтипы графических объявлений:
-
TEXT_IMAGE_AD
Объявление содержит изображение, а также ссылку на продвигаемый сайт.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
TextImageAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
TextImageAdFieldNamesметода get. -
TEXT_AD_BUILDER_AD
Объявление содержит креатив, созданный в конструкторе креативов, а также ссылку на продвигаемый сайт.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
TextAdBuilderAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
TextAdBuilderAdFieldNamesметода get.
Внимание
Графические объявления показываются только в сетях (Рекламной сети Яндекса и внешних сетях), но не показываются на поиске.
Показ графического объявления возможен только при условии, что ставка по ключевой фразе или условию нацеливания на аудиторию не ниже минимальной ставки для объявления с включенным в него изображением, указанной на странице Минимальный и максимальный размер цены за клик.
Подробнее о графических объявлениях см. в разделе Графические объявления Справки Директа.
-
-
CPM_BANNER_AD — медийный баннер.
Объявление содержит креатив, загруженный в веб-интерфейсе или созданный в конструкторе креативов, а также ссылку на продвигаемый сайт или страницу в соцсети с дополнительной информацией о предложении. В объявление также можно добавить пиксель Яндекс Аудиторий и счетчик показов ADFOX.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
CpmBannerAdBuilderAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
CpmBannerAdBuilderAdFieldNamesметода get. -
CPM_VIDEO_AD — медийное видеообъявление (в кампании с типом «Медийная кампания»).
Объявление содержит креатив, созданный в конструкторе креативов, а также ссылку на продвигаемый сайт или страницу в соцсети с дополнительной информацией о предложении. В объявление также можно добавить счетчик показов ADFOX.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
CpmVideoAdBuilderAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
CpmVideoAdBuilderAdFieldNamesметода get. -
SHOPPING_AD – товарное объявление (в кампании с типом «Единая перфоманс-кампания»).
Объявление формируется на основе товарных предложений и/или страниц каталога из фида — в зависимости от значения параметра
GenerationScopes. В одну группу можно добавить до двух неархивных товарных объявлений.Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
ShoppingAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
ShoppingAdFieldNamesметода get. -
LISTING_AD — объявление для страниц каталога (в кампании с типом «Единая перфоманс-кампания»).
Внимание
Тип объявления
LISTING_ADи структураListingAdустарели. Для работы со страницами каталога используйтеShoppingAdсо значением параметраGenerationScopes = ["LISTING"].Подробнее см. в разделе Совместимость с объявлениями страниц каталога.
-
RESPONSIVE_AD – объявление, в котором можно указать несколько заголовков, текстов, изображений и видео.
В одну группу можно добавить до 3 неархивных комбинаторных объявлений и до 10 объявлений этого типа с учетом архивных.
Чтобы создать или отредактировать объявление, его параметры необходимо передать в структуре
ResponsiveAdметодов add, update.Чтобы получить параметры объявления, необходимо перечислить имена параметров во входном параметре
ResponsiveAdFieldNamesметода get.
Параметры Type, Subtype, Status, State, StatusClarification, AdCategories, AgeLabel являются общими для всех типов объявлений. Чтобы получить их, необходимо перечислить имена нужных параметров во входном параметре FieldNames метода get.
Устаревшие типы объявлений
Типы объявлений устарели и больше не поддерживаются.
-
SMART_AD — смарт-баннер.
-
MOBILE_APP_AD — объявление для продвижения мобильных приложений.
-
DYNAMIC_TEXT_AD — динамическое объявление.
-
MOBILE_APP_IMAGE_AD – графическое объявление с изображением для продвижения мобильных приложений.
-
MOBILE_APP_AD_BUILDER_AD – графическое объявление с креативом, созданным в конструкторе креативов, для продвижения мобильных приложений.
-
MOBILE_APP_CPC_VIDEO_AD_BUILDER_AD – видеообъявление в кампании с типом «Реклама мобильных приложений».
-
CPC_VIDEO_AD — видеообъявление в кампаниях с типом «Текстово-графические объявления».
Соответствие типов объявлений и групп представлено в таблице ниже.
|
Тип группы |
Допустимые типы объявлений |
|
UNIFIED_AD_GROUP |
TEXT_AD, IMAGE_AD, подтипы TEXT_IMAGE_AD, TEXT_AD_BUILDER_AD, SHOPPING_AD, LISTING_AD, RESPONSIVE_AD |
|
CPM_BANNER_AD_GROUP |
CPM_BANNER_AD |
|
CPM_VIDEO_AD_GROUP |
CPM_VIDEO_AD |
|
TEXT_AD_GROUP Тип группы устарел и поддерживается только для обратной совместимости. |
TEXT_AD, IMAGE_AD, подтипы TEXT_IMAGE_AD, TEXT_AD_BUILDER_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 |
|
TEXT_AD_GROUP |
CPC_VIDEO_AD |
Совместимость с объявлениями страниц каталога
Тип объявления LISTING_AD и структура ListingAd устарели. Для работы со страницами каталога используйте ShoppingAd со значением параметра GenerationScopes = ["LISTING"]. Для товаров по-прежнему используются параметры FeedFilterConditions, TitleSources и TextSources структуры ShoppingAd. Фид для товаров и страниц каталога задается общим параметром FeedId.
Существующие запросы с ListingAd продолжают поддерживаться в режиме совместимости:
-
Метод add. При передаче структуры
ListingAdсоздается товарное объявление сGenerationScopes = ["LISTING"]. ПараметрыFeedFilterConditions,TitleSourcesиTextSourcesсохраняются соответственно вListingFeedFilterConditions,ListingTitleSourcesиListingTextSources. -
Метод update. Через структуру
ListingAdможно изменять существующие объявления типаLISTING_ADи товарные объявления сGenerationScopes = ["LISTING"]. Соответствие параметров такое же, как в методеadd. Для изменения объявлений, продвигающих товары или товары и страницы каталога, используйтеShoppingAd. -
Метод get. Режим получения объявлений зависит от параметра
ListingAdFieldNames:-
Передан непустой список
ListingAdFieldNames— используется режим совместимости. Товарные объявления сGenerationScopes = ["LISTING"]возвращаются с типомLISTING_ADи структуройListingAd, даже если также запрошены поляShoppingAdFieldNames. При фильтрации поSelectionCriteria.Typesтакие объявления учитываются какLISTING_AD. -
Параметр
ListingAdFieldNamesотсутствует — режим совместимости не используется. Такие объявления возвращаются с типомSHOPPING_AD; для получения их параметров используйтеShoppingAdFieldNames.
-
Статус и состояние объявления
Параметр 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 содержит возрастную категорию продвигаемой продукции, если указание категории требует Федеральный закон РФ «О рекламе». Порядок присвоения возрастной метки отличается в зависимости от типа объявления.
Для объявлений TEXT_AD и RESPONSIVE_AD значение возрастной метки зависит от принадлежности к особой категории BABY_FOOD:
-
Для объявлений, относящихся к категории BABY_FOOD, — возраст ребенка в месяцах: "MONTHS_0", "MONTHS_1", "MONTHS_2", ..., "MONTHS_12".
-
Для прочих объявлений — возраст, на который ориентирована информационная продукция. Возможные значения: "AGE_0", "AGE_6", "AGE_12", "AGE_16", "AGE_18".
Если у объявления отсутствует возрастная метка, задать ее нельзя (значение параметра игнорируется методом update).
Внимание
Через API можно изменить только значение возрастной категории, если она есть у объявления. Чтобы изменить наличие/отсутствие возрастной категории, пожалуйста, обратитесь в службу поддержки.
Возрастная метка для устаревшего типа объявления MOBILE_APP_AD
Возрастная метка присваивается всем объявлениям. Возможные значения: "AGE_0", "AGE_6", "AGE_12", "AGE_16", "AGE_18".
Метку можно указать при создании объявления. Значение по умолчанию — "AGE_18". Значение метки можно изменить при редактировании объявления, но удалить метку нельзя.
Дополнения к объявлению
Методы add и update позволяют привязать к объявлению изображение, видеодополнение, набор быстрых ссылок, уточнения (в зависимости от типа объявления). Подробная инструкция приведена в разделе Дополнения к объявлению.
Видеодополнения показываются только в сетях (Рекламной сети Яндекса и внешних сетях), но не показываются на поиске.
Ставка для изображений и видеодополнений
Показ изображения или видеодополнения возможен только в случае, если ставка по ключевой фразе или условию нацеливания на аудиторию не ниже минимальной ставки для объявления с включенным в него изображением, указанной на странице Минимальный и максимальный размер цены за клик. В противном случае объявление будет показано без изображения и видеодополнения.
Результат модерации дополнений
Изображение, видеодополнение, набор быстрых ссылок проходят модерацию не изолированно, а в связке с объявлением. Отправка на модерацию происходит автоматически, если само объявление находится на модерации или уже проверено модерацией.
Метод get возвращает результат модерации изображения (структура 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 содержит автоматически сгенерированное описание объекта продвижения.
Подробнее про маркировку продвижения см. здесь.
Для пользователя
Количественные ограничения на объекты пользователя.
Для агентства
—