API Яндекс.Директа

Здесь мы будем рассказывать о новостях и тонкостях использования нашего API.

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

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

Вопросы об API можно задавать через форму обратной связи.

Другие полезные ссылки:
Обучающий онлайн-курс Как начать работать с API
Руководство по переходу с версий 4 и Live 4 на версию 5
Коды ошибок и предупреждений
Форма для отзывов и предложений
Английская версия блога
RSS-канал блога

Команда API Яндекс.Директа

Профили организаций в API Директа
25 марта, 14:54

Появилась поддержка профилей организаций из Яндекс.Справочника:

  • Добавлен сервис Businesses для получения профилей организаций рекламодателя.
  • В методы сервиса Ads добавлен параметр BusinessId для текстово-графических объявлений.
api5,новости
Смарт-баннеры в API Директа
16 марта, 17:10

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

Какие нововведения появились в API:

  • Сервис Feeds для управления фидами — файлами с товарными предложениями.
  • Сервис SmartAdTargets для управления фильтрами — условиями нацеливания для смарт-баннеров.
  • Поддержка кампаний с типом SMART_CAMPAIGN в сервисе Campaigns.
  • Поддержка групп объявлений с типом SMART_AD_GROUP в сервисе AdGroups.
  • Поддержка объявлений с типом SMART_AD в сервисе Ads.
  • Поддержка креативов с типом SMART_CREATIVE в сервисе Creatives.
  • Поддержка корректировок с типом SMART_AD_ADJUSTMENT в сервисе BidModifiers.

Прочитать подробности об управлении смарт-баннерами через API можно в документации.

новости,api5
Таргетинг по интересам для текстово-графических объявлений
19 декабря 2019, 15:41

Добавлен таргетинг по интересам для текстово-графических объявлений:

  • В группу с типом TEXT_AD_GROUP можно добавить условие нацеливания на аудиторию, в котором условие ретаргетинга и подбора аудитории имеет тип AUDIENCE и содержит только сегменты по краткосрочным интересам.
  • В ответ метода RetargetingLists.get добавлен параметр AvailableForTargetsInAdGroupTypes.

Изменения подробно описаны в документации.

новости,api5
Дневной бюджет общего счета
11 ноября 2019, 17:29

Метод Dictionaries.get возвращает в справочнике Currencies новый параметр MinimumAccountDailyBudget — минимальный дневной бюджет общего счета.

Валютный параметр MinimumPayment, который ранее совмещал два значения — минимальный платеж (без учета НДС) и минимальный дневной бюджет общего счета, используйте только в качестве ограничения минимального платежа.

api5,новости
Изменения в методе Campaigns.get
1 октября 2019, 13:33

Значения возвращаемых параметров SharedAccountFunds.Spend и CampaignFunds.Sum теперь включают НДС.

api5,новости
Метка yclid добавляется по умолчанию
25 сентября 2019, 15:18

В сервисе Campaigns  для настройки ADD_METRICA_TAG в структуре Settings значение по умолчанию изменено с NO на YES.

Таким образом, для новых кампаний настройка по умолчанию включена. Это означает, что к ссылкам объявлений автоматически добавляется метка ?yclid= с уникальным номером клика. Необходимо убедиться, что страницы сайта рекламодателя корректно открываются по  ссылкам с этой меткой.

новости,api5
Модели атрибуции в API
17 сентября 2019, 13:57

В методы сервиса Campaigns добавлен параметр AttributionModel для кампаний с типом «Текстово-графические объявления» и «Динамические объявления».

В сервисе Reports для входного параметра AttributionModels добавлено значение LYDC — «Последний переход из Яндекс.Директа». Статистика по новой модели атрибуции доступна за период начиная с 30 июля 2019 г.

новости,api5
8 быстрых ссылок
9 сентября 2019, 14:49

Сервис Sitelinks теперь поддерживает до 8 быстрых ссылок в каждом наборе.

Суммарная длина текстов быстрых ссылок № 1–4 — не более 66 символов. Суммарная длина текстов быстрых ссылок № 5–8 — также не более 66 символов.

api5,новости
Изменены настройки стратегий в сетях
22 августа 2019, 18:12

В сервис Campaigns внесены изменения, о которых мы сообщали ранее:

  • Из структуры NetworkDefault исключен параметр BidPercent.
  • Параметр LimitPercent в структуре NetworkDefault используется только в случае, если стратегия на поиске — HIGHEST_POSITION.
  • Настройка MAINTAIN_NETWORK_CPC в структуре Settings используется только в случае, если стратегия на поиске — HIGHEST_POSITION, а стратегия в сетях — NETWORK_DEFAULT.

Изменения подробно описаны в документации.

новости,api5
Обновление стратегий: что изменится в API
30 июля 2019, 14:02

Хотим предупредить вас, что в середине августа в сервисе Campaigns произойдут изменения, связанные с недавно анонсированным обновлением стратегий. Изменения затронут кампании с типом TEXT_CAMPAIGN и  MOBILE_APP_CAMPAIGN.

  • Из структуры NetworkDefault будет исключен параметр BidPercent. Методы add и update будут выдавать ошибку при попытке задать его, а метод get перестанет возвращать.
  • Параметр LimitPercent в структуре NetworkDefault будет использоваться только в случае, если стратегия на поиске — HIGHEST_POSITION.

    Если на поиске автоматическая стратегия:

    • Методы add и update будут игнорировать переданное значение и выдавать предупреждение.  Чтобы включить стратегию в сетях NETWORK_DEFAULT вместе с автоматической на поиске, необходимо будет передать пустую структуру NetworkDefault.
    • Метод get не будет возвращать структуру NetworkDefault.
  • Настройка MAINTAIN_NETWORK_CPC в структуре Settings будет использоваться только в случае, если стратегия на поиске — HIGHEST_POSITION, а стратегия в сетях — NETWORK_DEFAULT. В остальных случаях методы add и update будут игнорировать переданное значение и выдавать предупреждение, а метод get не будет возвращать настройку MAINTAIN_NETWORK_CPC.

Если у вас появились вопросы, вы можете задать их  специалистам службы поддержки.

новости,api5
Библиотека минус-фраз в API Директа
11 июля 2019, 13:27

В API Директа появилась поддержка наборов минус-фраз:

  • Добавлен сервис NegativeKeywordSharedSets для управления наборами минус-фраз.
  • В методы сервиса AdGroups добавлен параметр NegativeKeywordSharedSetIds — в нем можно указать до трех идентификаторов наборов. Метод AdGroups.get позволяет отбирать группы объявлений, в которых используются заданные наборы минус-фраз.

Если у вас появились вопросы, вы можете задать их специалистам службы поддержки.

новости,api5
Медийные видеообъявления в API Директа
24 июня 2019, 16:26

Появилась поддержка видеообъявлений в медийных кампаниях:

  • В сервис AdGroups добавлена поддержка групп объявлений с типом CPM_VIDEO_AD_GROUP.

    Ограничение. Настройка Сбор аудитории видео в настоящее время не поддерживается в API.

  • В сервис Ads добавлена поддержка объявлений с типом CPM_VIDEO_AD.
  • В сервис Creatives добавлена поддержка креативов с типом CPM_VIDEO_CREATIVE.

Подробнее об управлении медийными кампаниями читайте в документации.

новости,api5
Изменения в сервисе RetargetingLists
3 июня 2019, 17:26
  • Отменено ограничение на условия ретаргетинга и подбора аудитории, состоящие только из правил с оператором NONE. Теперь в таких условиях можно использовать не только цели Яндекс.Метрики, но и сегменты Яндекс.Метрики, и сегменты Яндекс.Аудиторий.
  • Параметр MembershipLifeSpan теперь используется только для целей Яндекс.Метрики. Для сегментов Яндекс.Метрики и сегментов Яндекс.Аудиторий методы add и update игнорируют переданное значение.
  • Максимальное количество дней в параметре MembershipLifeSpan увеличено до 540.
api5,новости
Скоро: 8 быстрых ссылок
28 мая 2019, 17:36

Хотим предупредить вас, что скоро к объявлениям в Директе можно будет добавить до восьми быстрых ссылок. Новый лимит начнет применяться в июне.

Изменения затронут сервис Sitelinks — если вы используете его, подготовьте свои приложения.

Любые вопросы вы можете задать специалистам службы поддержки API Директа.

api5,news
Турбо-страницы в API
15 мая 2019, 11:04

Изменения, о которых мы писали ранее, вступили в силу: в API Директа появилась поддержка Турбо-страниц.

  • Добавлен сервис TurboPages для получения Турбо-страниц, созданных в конструкторе.
  • В методы сервиса Ads добавлен параметр TurboPageId. В ответ метода Ads.get также добавлен параметр TurboPageModeration.

    Параметр Href в структурах TextImageAd, TextAdBuilderAd, CpcVideoAdBuilderAd, CpmBannerAdBuilderAd стал nillable в методах Ads.update и Ads.get.

  • В методы сервиса Sitelinks добавлен параметр TurboPageId.

    Параметры Href и Description стали nillable в методе Sitelinks.get.

    В метод Sitelinks.get добавлен входной параметр SitelinkFieldNames.

Подробнее о Турбо-страницах читайте в документации.

новости,api5
Турбо-страницы в API Директа: подготовьте приложения к изменениям
18 апреля 2019, 13:25

Недавно мы запустили Турбо-страницы для десктопов. Теперь во многих типах объявлений ссылка на сайт стала необязательной — рекламодатель может указать только Турбо-страницу.

Что изменится в API

В сервисе Ads появится новое поле — TurboPageId. В структуре TextAd достаточно будет указать одно из полей Href, VCardId и TurboPageId.

В структурах TextImageAd, TextAdBuilderAd, CpcVideoAdBuilderAd, CpmBannerAdBuilderAd достаточно будет указать одно из полей Href и TurboPageId. Таким образом, поле Href станет необязательным в методе add, а в методах update и get оно станет nillable. Обратите внимание: метод get может вернуть nil (null) в поле Href — например, если рекламодатель удалил основную ссылку объявления. Приложение должно корректно обработать такой ответ.

В сервисе Sitelinks также появится поле TurboPageId. В структуре Sitelink достаточно будет указать одно из полей Href и TurboPageId. Кроме того, в методе get появится входной параметр SitelinkFieldNames: в нём можно перечислить имена полей быстрой ссылки, которые требуется получить. В ответе метода get поля Href и Description станут nillable — приложение также должно корректно обработать значение nil (null) в этих полях.

Список опубликованных Турбо-страниц рекламодателя можно будет получить с помощью нового метода — TurboPages.get.

Когда произойдут изменения

Поддержка Турбо-страниц в API появится ориентировочно через две-три недели. Пожалуйста, запланируйте обновление своих приложений. Если у вас появились вопросы, вы можете задать их специалистам службы поддержки API Директа.

новости,api5
Ключевые цели в статистике
9 апреля 2019, 11:09

Сервис Reports поддерживает ключевые цели:

  • Добавлено поле Profit.
  • Значения полей RevenueProfit и GoalsRoi для ключевых целей рассчитываются исходя из ценностей конверсий, указанных в настройках кампании.
новости,api5
Цена в объявлении
27 марта 2019, 18:47

В текстово-графическом объявлении теперь можно настроить отображение цены товара или услуги.

  • Чтобы добавить или изменить цену, передайте параметры цены в структуре PriceExtension метода Ads.add или Ads.update.
  • Чтобы сбросить цену, передайте значение nil (null) в параметре PriceExtension метода Ads.update.

Чтобы получить параметры цены, нужно при вызове метода Ads.get указать в запросе параметр TextAdPriceExtensionFieldNames вместе с параметром TextAdFieldNames.

новости,api5
Для конверсионных стратегий отключены настройки в сетях
11 марта 2019, 16:30

В сервисе Campaigns произошли изменения настроек для кампаний с конверсионными стратегиями:

  • стратегия на поиске AVERAGE_CPA, AVERAGE_ROI или WB_MAXIMUM_CONVERSION_RATE для текстово-графических объявлений;
  • стратегия на поиске AVERAGE_CPI или WB_MAXIMUM_APP_INSTALLS для рекламы мобильных приложений.

Для таких кампаний больше не поддерживаются параметры стратегии в сетях NetworkDefault.BidPercent и NetworkDefault.LimitPercent, а также опция MAINTAIN_NETWORK_CPC в структуре Settings

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

Метод get не возвращает структуру NetworkDefault и опцию MAINTAIN_NETWORK_CPC.

новости,api5
Настройка ключевых целей кампании доступна в API
4 февраля 2019, 18:32

Сервис Campaigns теперь поддерживает ключевые цели для кампаний с типом «Текстово-графические объявления»: в методы addupdate и get добавлена структура PriorityGoals.

новости,api5