Версия Live 4 (deprecated)

Развиваемая версия на основе стабильной версии 4. Выпущена в январе 2012 г.

Внимание.

Использование версии Live 4 ограничено.

Следующие методы версии Live 4 отключены:

ArchiveBanners (Live) GetBanners (Live) ModerateBanners (Live)
ArchiveCampaign (Live) GetBannersStat (Live) ResumeBanners (Live)
CreateNewReport (Live) GetCampaignParams (Live) ResumeCampaign (Live)
CreateNewSubclient (Live) GetCampaignsList (Live) Retargeting (Live)
CreateOfflineReport (Live) GetCampaignsListFilter (Live) RetargetingCondition (Live)
CreateOrUpdateBanners (Live) GetCampaignsParams (Live) SetAutoPrice (Live)
CreateOrUpdateCampaign (Live) GetChanges (Live) StopBanners (Live)
DeleteBanners (Live) GetClientInfo (Live) StopCampaign (Live)
DeleteCampaign (Live) GetClientsList (Live) UnArchiveBanners (Live)
DeleteOfflineReport (Live) GetOfflineReportList (Live) UnArchiveCampaign (Live)
DeleteReport GetReportList UpdateClientInfo (Live)
GetBalance (Live) GetSubClients UpdatePrices (Live)
GetBannerPhrases (Live) GetSummaryStat (Live)
GetBannerPhrasesFilter (Live) Keyword (Live)

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Адрес для запросов в формате JSON:

https://api.direct.yandex.ru/live/v4/json/

Адрес WSDL (для взаимодействия по протоколу SOAP):

https://api.direct.yandex.ru/live/v4/wsdl/

Адрес для SOAP-запросов:

https://api.direct.yandex.ru/live/v4/soap/

Новое в версии Live 4

10 декабря 2018 г.

Внесены изменения в справочник регионов: у Забайкальского края и Республики Бурятии родительским регионом стал Дальний Восток (вместо Сибири).

Рекомендуем получить обновленный справочник с помощью метода GetRegions (Live).

4 декабря 2018 г.

В ближайшее время будут внесены изменения в справочник регионов: у Забайкальского края и Республики Бурятии родительским регионом станет Дальний Восток (вместо Сибири).

После обновления справочника рекомендуем получить его заново с помощью метода GetRegions (Live).

3 декабря 2018 г.

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

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

Входной параметр Currency стал обязательным для получения статистики кампаний, работающих в реальной валюте, в следующих методах:

Значение параметра Currency должно совпадать с валютой кампании или рекламодателя для всех методов, кроме CreateNewForecast (Live) и GetEventsLog (Live).

Для метода GetSummaryStat (Live) вводится дополнительное ограничение: все кампании, указанные в одном вызове метода, должны быть в одной валюте.

17 октября 2017 г.

В методы CreateNewReport (Live) и GetBannersStat (Live) добавлена возможность получать в отчете данные о показах по автотаргетингу.

9 октября 2017 г.
В метод AccountManagement (Live) добавлена поддержка дневного ограничения на общий счет: входные параметры AccountDayBudget, PausedByDayBudgetSms (вложен в SmsNotification), PausedByDayBudget (вложен в EmailNotification) операции Update и аналогичные результирующие параметры операции Get.
4 июля 2017 г.

В методы CreateNewReport (Live) и GetBannersStat (Live) добавлена возможность получать в отчете данные о показе объявлений с видео.

22 марта 2017 г.

Изменена минимальная сумма платежа и минимальная сумма перевода между кампаниями.

14 февраля 2017 г.

В методы CreateNewWordstatReport и CreateNewForecast (Live) добавлена поддержка минус-фраз, содержащих до 7 слов, в параметре Phrases.

1 ноября 2016 г.

Добавлена поддержка новой валюты: белорусские рубли (BYN).

17 октября 2016 г.
Внимание.

Для рекламодателей, работающих в у. е. и не осуществлявших оплату более года, доступ к аккаунту может быть приостановлен. В этом случае при попытке вызова методов API выдается ошибка 54, а в веб-интерфейсе недоступны никакие операции, кроме перевода в валюту.

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

13 октября 2016 г.

Внесены изменения в справочник регионов. Рекомендуем получить обновленный справочник с помощью метода GetRegions (Live).

В частности, из справочника удалены регионы, перечисленные ниже:
  • эти регионы больше нельзя указывать при создании и редактировании групп объявлений;

  • в группах, где были указаны эти регионы, они автоматически заменены набором нижестоящих регионов;

  • статистика по этим регионам отнесена к вышестоящим регионам.

Список регионов, которые были удалены
Удален регион В настройках групп заменен набором регионов Статистика отнесена к региону
Идентификатор Название региона (с вышестоящими)
20524 Запад/Украина/СНГ (исключая Россию) 20529, 20530, 20531, 20532, 20533, 20534, 20535, 20550 187
20525 Восток/Украина/СНГ (исключая Россию) 20536, 20537, 20538, 20539, 20540 187
20526 Юг/Украина/СНГ (исключая Россию) 20541, 20542, 20543 187
20527 Центр/Украина/СНГ (исключая Россию) 20544, 20545, 20546, 20547, 20548, 20549 187
20528 Север/Украина/СНГ (исключая Россию) 20551, 20552 187
980 Страны Балтии/Европа 117, 179, 206 111
1004 Ближний Восток/Азия 181, 210, 1056 183
Удален регион В настройках групп заменен набором регионов Статистика отнесена к региону
Идентификатор Название региона (с вышестоящими)
20524 Запад/Украина/СНГ (исключая Россию) 20529, 20530, 20531, 20532, 20533, 20534, 20535, 20550 187
20525 Восток/Украина/СНГ (исключая Россию) 20536, 20537, 20538, 20539, 20540 187
20526 Юг/Украина/СНГ (исключая Россию) 20541, 20542, 20543 187
20527 Центр/Украина/СНГ (исключая Россию) 20544, 20545, 20546, 20547, 20548, 20549 187
20528 Север/Украина/СНГ (исключая Россию) 20551, 20552 187
980 Страны Балтии/Европа 117, 179, 206 111
1004 Ближний Восток/Азия 181, 210, 1056 183
12 октября 2016 г.

Добавлено ограничение для ключевых фраз: длина каждого слова и минус-слова в ключевой фразе — не более 35 символов.

10 октября 2016 г.
Внимание. С 10 октября 2016 г. рекламные агентства могут регистрировать только клиентов, работающих в реальной валюте. Возможность регистрации новых клиентов, работающих в у. е., отключена. В связи с этим изменена логика работы метода CreateNewSubclient (Live). Подробнее...
3 октября 2016 г.

В статистике, предоставляемой методами GetBannersStat (Live) и CreateNewReport (Live), изменился период, за который доступны данные по средней позиции объявления и типу устройства. Теперь данные доступны начиная с 01.11.2014.

21 сентября 2016 г.
Внимание. Через неделю произойдет изменение диапазона дат, за которые доступны данные по средней позиции объявления в статистике, формируемой методом CreateNewReport (Live). А именно, данные по средней позиции будут доступны только начиная с 01.11.2014. В настоящее время доступны данные начиная с 01.07.2014. Если вам необходима статистика по средней позиции за период с 01.07.2014 по 31.10.2014, рекомендуем запросить ее в ближайшие дни.
20 сентября 2016 г.

Ориентировочно через две-три недели будут внесены изменения в справочник регионов. После обновления справочника рекомендуем получить его заново с помощью метода GetRegions (Live).

В частности, из справочника будут удалены регионы, перечисленные ниже:
  • эти регионы нельзя будет указывать при создании и редактировании групп объявлений;

  • в группах, где указаны эти регионы, они будут автоматически заменены набором нижестоящих регионов;

  • статистика по этим регионам будет отнесена к вышестоящим регионам.

Список регионов, которые будут удалены
Удаляемый регион В настройках групп будет заменен набором регионов Статистика будет отнесена к региону
Идентификатор Название региона (с вышестоящими)
20524 Запад/Украина/СНГ (исключая Россию) 20529, 20530, 20531, 20532, 20533, 20534, 20535, 20550 187
20525 Восток/Украина/СНГ (исключая Россию) 20536, 20537, 20538, 20539, 20540 187
20526 Юг/Украина/СНГ (исключая Россию) 20541, 20542, 20543 187
20527 Центр/Украина/СНГ (исключая Россию) 20544, 20545, 20546, 20547, 20548, 20549 187
20528 Север/Украина/СНГ (исключая Россию) 20551, 20552 187
980 Страны Балтии/Европа 117, 179, 206 111
1004 Ближний Восток/Азия 181, 210, 1056 183
Удаляемый регион В настройках групп будет заменен набором регионов Статистика будет отнесена к региону
Идентификатор Название региона (с вышестоящими)
20524 Запад/Украина/СНГ (исключая Россию) 20529, 20530, 20531, 20532, 20533, 20534, 20535, 20550 187
20525 Восток/Украина/СНГ (исключая Россию) 20536, 20537, 20538, 20539, 20540 187
20526 Юг/Украина/СНГ (исключая Россию) 20541, 20542, 20543 187
20527 Центр/Украина/СНГ (исключая Россию) 20544, 20545, 20546, 20547, 20548, 20549 187
20528 Север/Украина/СНГ (исключая Россию) 20551, 20552 187
980 Страны Балтии/Европа 117, 179, 206 111
1004 Ближний Восток/Азия 181, 210, 1056 183
8 сентября 2016 г.

В метод CreateNewReport (Live) добавлена возможность получать в отчете данные по условию ретаргетинга, в соответствии с которым применена корректировка ставок для посетивших сайт (см. раздел Корректировки (BidModifier) документации API версии 5).

8 сентября 2016 г.

В метод GetBanners (Live) добавлено значение project_declaration результирующего параметра AdWarnings.

30 августа 2016 г.
Внимание. Статистика, предоставляемая методами GetSummaryStat (Live), GetBannersStat (Live), CreateNewReport (Live), доступна за последние три года от текущего месяца: например, 15 сентября 2016 года можно получить данные начиная с 1 сентября 2013 года.
29 августа 2016 г.

Настройка дневного бюджета доступна всем клиентам с правом редактирования кампаний.

29 июня 2016 г.

Методы RetargetingCondition (Live) и GetRetargetingGoals (Live) теперь поддерживают сегменты Яндекс Аудиторий. В метод GetRetargetingGoals (Live) добавлено значение audience_segment результирующего параметра Type.

23 июня 2016 г.

В метод RetargetingCondition (Live) добавлена возможность работать с условиями ретаргетинга, состоящими только из групп целей с типом not. Такие условия ретаргетинга можно использовать только в корректировках ставок (см. раздел Корректировки (BidModifier) документации API версии 5). Создание ретаргетингов с такими условиями не допускается.

26 апреля 2016 г.

Параметр условия ретаргетинга Time теперь поддерживает значения от 1 до 90.

25 апреля 2016 г.
Внимание.

Внесены изменения в структуры данных: изменились типы параметров BannerID, BannerIDS, Banner, Banners, AdID, AdIDS, AdGroupID. Подробнее...

14 апреля 2016 г.

Отключена возможность загрузки изображений размера 150 пикселей по минимальной стороне и привязки таких изображений к объявлениям.

30 марта 2016 г.

Параметр кампании DisabledDomains теперь поддерживает внешние сети (SSP).

24 марта 2016 г.

В метод GetWordstatReportList добавлено значение Failed результирующего параметра StatusReport.

В метод GetForecastList добавлено значение Failed результирующего параметра StatusForecast.

14 марта 2016 г.

Параметр кампании RelevantPhrasesBudgetLimit больше не поддерживает значение –1. Чтобы расход по дополнительным релевантным фразам был неограничен (в рамках бюджета кампании), используйте значение 100.

29 февраля 2016 г.
Изменены требования к размеру изображений в объявлениях:
  • при соотношении сторон от 1:1 до 3:4/4:3 — от 450 до 5000 пикселей по каждой стороне;

  • при соотношении сторон 16:9 — от 1080 × 607 до 5000 × 2812 пикселей.

Внимание. Загрузка изображений прежнего размера — 150 пикселей по минимальной стороне — будет поддерживаться в течение месяца.
9 февраля 2016 г.

Изменены ограничения для ключевых фраз. Теперь группа объявлений может содержать не более 200 фраз, длина каждой фразы — не более 4096 символов.

15 декабря 2015 г.

Добавлена возможность получения статистики по динамическим текстовым объявлениям (см. раздел Динамические объявления помощи Директа):

9 ноября 2015 г.

Методы GetBanners (Live), GetBannerPhrases (Live), GetBannerPhrasesFilter (Live) возвращают ограничения на получение результатов торгов. Подробнее...

В метод CreateNewReport (Live) добавлена возможность получать в отчете данные по типу операционной системы и типу связи (только для рекламы мобильных приложений).

22 октября 2015 г.
Внимание.

С 22 октября 2015 г. создание новых SSL-сертификатов недоступно. Ранее созданные сертификаты можно использовать до окончания срока их действия.

30 сентября 2015 г.
В метод SetAutoPrice (Live) добавлена возможность рассчитывать ставки на поиске на основе минимальной ставки за второе место в спецразмещении.
8 сентября 2015 г.
  • В метод CreateNewReport (Live) добавлена возможность получать в отчете возрастную группу и пол пользователя.

  • Исправлено поведение по умолчанию для методов CreateNewReport (Live), GetBannersStat (Live) и GetSummaryStat (Live): если клиент работает в реальной валюте, а входной параметр Currency не передан, в отчете будет приведена стоимость кликов до применения скидки, пересчитанная из валюты в у. е.

1 сентября 2015 г.
30 июля 2015 г.
В API Директа будет добавлена возможность получать результаты торгов нового аукциона: минимальную ставку за каждую позицию и списываемую цену на каждой позиции. Подробнее...
6 июля 2015 г.
В методы CreateNewReport (Live) и GetBannersStat (Live) добавлена возможность получать в отчете данные о доходе и рентабельности рекламы.
29 июня 2015 г.
В методы GetClientInfo (Live) и GetClientsList (Live) добавлен результирующий параметр OverdraftSumAvailableInCurrency.
9 июня 2015 г.
Методы RetargetingCondition (Live) и GetRetargetingGoals (Live) поддерживают, наряду с целями, сегменты Яндекс Метрики. В метод GetRetargetingGoals (Live) добавлен результирующий параметр Type.
27 мая 2015 г.
20 мая 2015 г.
Доступна стратегия управления ставками ROIOptimization (см. параметр StrategyName в объекте CampaignStrategy).
15 апреля 2015 г.
Добавлен параметр кампании EnableRelatedKeywords в методы CreateOrUpdateCampaign (Live), GetCampaignParams (Live), GetCampaignsParams (Live), GetCampaignsList (Live), GetCampaignsListFilter (Live).
3 апреля 2015 г.
В метод GetEventsLog (Live) добавлены входные параметры Limit и Offset.
23 марта 2015 г.
В метод GetBannersStat (Live) добавлена возможность получать в отчете среднюю позицию показов объявления и среднюю позицию кликов по объявлению. Данные доступны начиная с 4.12.2014.
3 марта 2015 г.
В методы CreateNewReport (Live) и GetBannersStat (Live) добавлена возможность получать в отчете данные о типах устройств.
Добавлен коэффициент для настройки цен на мобильных устройствах:
26 февраля 2015 г.
В метод Keyword (Live) добавлена операция Get, предназначенная для получения значений продуктивности фраз.

Автоброкер постоянно включен для всех фраз. Отключение автоброкера не поддерживается.

11 февраля 2015 г.
Добавлен результирующий параметр AdGroupID операции Get метода Retargeting (Live).
29 января 2015 г.
Добавлено ограничение для метода CreateOrUpdateBanners (Live): не более 1000 объявлений в одном вызове.
20 января 2015 г.
Внимание.

Все обращения к API Директа, в том числе получение WSDL-описания, выполняются по протоколу HTTPS. Доступ по протоколу HTTP закрыт.

17 декабря 2014 г.
Добавлен параметр клиента DisplayStoreRating в методы GetClientInfo (Live) и UpdateClientInfo (Live).
9 октября 2014 г.
В метод CreateNewReport (Live) добавлена возможность получать в отчете среднюю позицию показов объявления и среднюю позицию кликов по объявлению.
18 сентября 2014 г.
Изменено поведение метода SetAutoPrice (Live): теперь метод не учитывает активность объявлений при обновлении ставок. Входной параметр BannersType игнорируется.
27 августа 2014 г.
В метод CreateNewReport (Live) добавлена возможность получать в отчете количество целевых визитов (конверсий).
24 июля 2014 г.
10 апреля 2014 г.

Добавлен метод Keyword (Live), предназначенный для остановки и возобновления показов по ключевым фразам.

1 апреля 2014 г.
Внимание.

1 апреля 2014 года произошли изменения в структурах данных: изменились типы параметров PhraseID и PhraseIDS. Подробнее...

17 марта 2014 г.
Изменился порядок работы с быстрыми ссылками: метод CreateOrUpdateBanners (Live) теперь принимает на вход от 1 до 4 быстрых ссылок в массиве Sitelinks и метод GetBanners (Live) возвращает от 1 до 4 быстрых ссылок в массиве Sitelinks.
27 февраля 2014 г.
Внимание. В методе SetAutoPrice (Live) входной параметр CampaignID стал обязательным.
19 февраля 2014 г.
Доступна стратегия управления ставками AverageCPAOptimization (см. параметр StrategyName в объекте CampaignStrategy).
27 января 2014 г.

Добавлены методы работы с общим счетом (см. раздел Общий счет (Account)).

5 декабря 2013 г.

Метод CreateNewSubclient (Live) теперь позволяет агентствам, работающим в реальной валюте, создавать клиентов в валюте.

Внимание.
  • В операциях метода Retargeting (Live) добавлен входной параметр Login, обязательный при запросе от лица рекламного агентства.
  • Поместить кампанию в архив можно не ранее чем через час после последнего показа.
14 ноября 2013 г.

Отключена поддержка рубрик Каталога:

Внимание. В методе UpdatePrices (Live) входной параметр CampaignID стал обязательным.
31 октября 2013 г.
27 августа 2013 г.
  • Добавлена поддержка ведения рекламных кампаний в реальных валютах клиентов. Методы, в которые добавлены новые параметры, перечислены в разделе Реальные валюты вместо у. е.
  • Добавлено ограничение на длительность отчетного периода в методе CreateNewReport (Live).
24 июня 2013 г.
20 июня 2013 г.
  • Добавлена поддержка следующих подстановочных переменных в ссылке объявления: идентификатор рекламной кампании, идентификатор объявления, идентификатор ключевой фразы (см. подраздел Ссылки на сайт, а также раздел Параметры, передаваемые в URL объявлений помощи Яндекс Директа). Таким образом, появилась возможность анализировать статистику показов и кликов, конверсию и другие параметры визитов на сайт по каждой фразе в отдельности.
21 мая 2013 г.
10 февраля 2013 г.
17 декабря 2012 г.
  • Добавлены параметры BannerIDS, PhraseIDS, BannersType, Price, ContextPrice в метод SetAutoPrice (Live). Теперь метод может задавать ставки отдельно для поиска, отдельно для Рекламной сети Яндекса.
  • Добавлен параметр AgeLabel в методы GetBanners (Live) и CreateOrUpdateBanners (Live). Позволяет задавать возрастную категорию информационной продукции в соответствии с требованием Федерального закона РФ «О рекламе».
7 ноября 2012 г.
5 сентября 2012 г.
9 июня 2012 г.
19 апреля 2012 г.
6 марта 2012 г.

Рекомендации по использованию версии Live

Ниже перечислены характерные изменения и даны рекомендации, повышающие адаптивность программ.

Новое значение параметра

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

Новый параметр

Если программа знакома с форматом Live, она корректно обрабатывает новые параметры, иначе пропускает их. Игнорирование новых параметров не приводит к ошибкам, поскольку лишь выражает отказ от использования новых возможностей (они добавляются в версию Live таким образом, чтобы не повлиять на существующие функции).

Если программа не указывает параметры версии Live в запросе, значит программа ориентирована на формат стабильной версии. В этом случае API не меняет параметры Live, если они были заданы, например, через веб-интерфейс. Однако если программа указывает одни параметры Live и не указывает другие, неуказанным параметрам могут быть присвоены предустановленные значения версии Live. Избежать сброса значений помогает техника, описанная в разделе Техника редактирования объектов.