Версия 4 (deprecated)
Стабильная версия API Яндекс Директа. Выпущена в мае 2011 г.
Использование версии 4 ограничено.
Следующие методы версии 4 отключены:
Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.
Адрес для запросов в формате JSON:
https://api.direct.yandex.ru/v4/json/Адрес WSDL (для взаимодействия по протоколу SOAP):
https://api.direct.yandex.ru/v4/wsdl/Адрес для SOAP-запросов:
https://api.direct.yandex.ru/v4/soap/Новое в версии 4
Для рекламодателей, работающих в у. е. и не осуществлявших оплату более года, доступ к аккаунту может быть приостановлен. В этом случае при попытке вызова методов API выдается ошибка 54, а в веб-интерфейсе недоступны никакие операции, кроме перевода в валюту.
Чтобы возобновить работу, переведите аккаунт в валюту оплаты. Для этого нажмите кнопку Перевести сейчас в веб-интерфейсе Директа. Подробнее о процедуре перевода читайте в помощи Директа: российские рубли, другая валюта.
С 10 октября 2016 г. рекламные агентства могут регистрировать только клиентов, работающих в реальной валюте. Возможность регистрации новых клиентов, работающих в у. е., отключена. В связи с этим изменена логика работы метода CreateNewSubclient. Подробнее...
Статистика, предоставляемая методами GetSummaryStat и CreateNewReport, доступна за последние три года от текущего месяца: например, 15 сентября 2016 года можно получить данные начиная с 1 сентября 2013 года.
25 апреля 2016 г. внесены изменения в структуры данных: изменились типы параметров BannerID, BannerIDS, Banner, Banners. Подробнее...
Параметр кампании DisabledDomains теперь поддерживает внешние сети (SSP).
В метод GetWordstatReportList добавлено значение Failed результирующего параметра StatusReport.
В метод GetForecastList добавлено значение Failed результирующего параметра StatusForecast.
Параметр кампании RelevantPhrasesBudgetLimit больше не поддерживает значение –1. Чтобы расход по дополнительным релевантным фразам был неограничен (в рамках бюджета кампании), используйте значение 100.
Изменены ограничения для ключевых фраз. Теперь группа объявлений может содержать не более 200 фраз, длина каждой фразы — не более 4096 символов.
- Методы GetBanners, GetBannerPhrases, GetBannerPhrasesFilter возвращают ограничения на получение результатов торгов. Подробнее...
С 22 октября 2015 г. создание новых SSL-сертификатов недоступно. Ранее созданные сертификаты можно использовать до окончания срока их действия.
- Добавлено ограничение для метода CreateOrUpdateBanners: не более 1000 объявлений в одном вызове.
- Введена процедура регистрации приложений.
- Установлены требования к приложениям, взаимодействующим с API.
Все обращения к API Директа, в том числе получение WSDL-описания, выполняются по протоколу HTTPS. Доступ по протоколу HTTP закрыт.
1 апреля 2014 года произошли изменения в структурах данных: изменился тип параметра PhraseID. Подробнее...
Изменился порядок работы с быстрыми ссылками: метод CreateOrUpdateBanners теперь принимает на вход от 1 до 4 быстрых ссылок в массиве Sitelinks и метод GetBanners возвращает от 1 до 4 быстрых ссылок в массиве Sitelinks.
Исправлено поведение по умолчанию для методов CreateNewReport и GetSummaryStat: если клиент работает в реальной валюте, в отчете будет приведена стоимость кликов до применения скидки, пересчитанная из валюты в у. е.
- Метод GetCampaignsParams — возвращает параметры нескольких кампаний за один вызов. Рекомендуется использовать вместо метода GetCampaignParams.
- Блок финансовых методов:
- CreateInvoice — формирует счет на оплату одной или нескольких кампаний;
- GetCreditLimits — возвращает информацию о кредитах, предоставленных для оплаты кампаний;
- PayCampaigns — оплачивает кампании за счет предоставленного кредита;
TransferMoney — переводит средства между кампаниями.
Реализована защита финансовых методов с помощью дополнительных токенов (см. Доступ к финансовым методам).
- Метод GetChanges — проверяет наличие изменений в кампаниях и объявлениях, в справочнике регионов, справочнике временных зон, в Яндекс Каталоге.
- Метод DeleteWordstatReport — удаляет отчет о статистике ключевых слов.
- Метод UpdateClientInfo — изменяет персональные данные клиентов, полномочия и параметры отправки уведомлений.
- Метод GetSummaryStat — возвращает сводную статистику по кампаниям за каждый день указанного диапазона времени.
- Подстановочные параметры в ссылках на сайт (см. входные параметры Param1 и Param2 в методе CreateOrUpdateBanners). Подстановочные параметры задаются для фраз и автоматически подставляются в ссылки на сайт рекламодателя при показе объявлений. Это позволяет модифицировать ссылки в зависимости от фразы, по которой найдено объявление.
Изменения в структурах данных
- Результирующий параметр SumAvailableForTransfer в методах GetCampaignParams, GetCampaignsParams, GetCampaignsList. Указывает сумму, доступную для перевода с помощью метода TransferMoney.
- Результирующий параметр Strategy в методах GetCampaignParams, GetCampaignsParams. Содержит структуру с настройками стратегии показов. Параметр Strategy заменил параметры AutoBudget, AutobudgetSum, AutobudgetMaxBid, которые использовались в предыдущих версиях API и удалены в версии 4.
- Параметр ClientRights, описывающий полномочия клиентов. Результирующий параметр методов GetClientInfo и GetClientsList, входной параметр метода UpdateClientInfo.
- Результирующий параметр CampaignEmails в методах GetClientInfo и GetClientsList. Содержит адреса электронной почты всех кампаний клиента.
- Входной параметр PhrasesType в методе SetAutoPrice. Задает условия отбора фраз, для которых нужно рассчитать цены за клик.
- Входной параметр Scope в методе SetAutoPrice. Задает параметры расчета цен за клик для фраз, отключенных на поиске, но активных в Рекламной сети Яндекса.
- Входной параметр GetPhrases в методе GetBanners. Указывает, нужно ли выводить в ответе массив Phrases с данными о всех фразах объявления.
- Результирующий параметр MinusKeywords в методе GetBanners. Содержит минус-слова, общие для всех фраз объявления (дополняют минус-слова, указанные во фразах).
Прочие изменения
- Методы GetRegions, GetRubrics и GetTimeZones возвращают данные на английском языке, если при вызове не указан параметр locale. В предыдущей версии предустановленным языком был русский.
Сформированные отчеты о статистике теперь не перезаписываются при достижении лимита на количество отчетов (не более пяти). Ранее при наличии пяти отчетов вызов метода CreateNewWordstatReport приводил к удалению самого старого из них, чтобы освободить место под новый отчет. Теперь в аналогичной ситуации метод возвращает сообщение об ошибке. Для освобождения места под новый отчет служит метод DeleteWordstatReport.
Такой же подход реализован для прогнозов бюджета, формируемых с помощью метода CreateNewForecast. Для их удаления служит метод DeleteForecastReport.