API Яндекс.Директа: встречайте пятую версию

Нашему программному интерфейсу пять лет. За это время он несколько раз сильно менялся, пока не дорос до «живой» версии 4 live в 2012 году. Наконец пришло время для запуска API 5 — новой версии с полностью перестроенной архитектурой, которая готова к появлению любых (даже самых неожиданных) настроек и форматов в Директе.

photoartboard.003.png

Первые методы API 5 появились в открытом доступе. Новая версия в разы удобнее и быстрее предыдущих. В течение года она будет работать в паре с привычным API 4 live — так что вы можете ускорять и оптимизировать рутинные операции, понемногу переключаясь на работу с API 5.


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


О ключевых изменениях в API:


1. Отдельные веб-сервисы для операций с разными классами объектов. И у каждого — свой унифицированный набор методов. Такая архитектура позволяет работать только с нужными вам наборами данных, не выгружая все связанные с ними дополнительные параметры (к примеру, чтобы изменить регион показа для всех групп в кампании или добавить в список ключевых слов новую фразу не придется «возить» туда-обратно все данные кампании).
Большинство объектов — группу, визитку, быстрые ссылки и так далее — можно создать один раз и дальше использовать для всех объявлений, где они нужны.
Поддержка новых функций реализована без риска повредить уже отлаженной работе приложений: в API просто будут добавляться дополнительные веб-сервисы и наборы методов, которые вы сможете использовать, когда будете готовы.

2. Все объекты и ошибки подробно задокументированы. Чтобы элементы кампании было удобнее редактировать по отдельности, каждому из них теперь сразу присваивается свой Id.
По каждой операции вы получаете подробный отчет обо всех объектах внутри запроса, так что если один из них выдаст ошибку, вы точно будете знать, какой именно и что произошло. Остальные объекты внутри запроса не будут отклонены за ту же ошибку — вы получите отчет о том, что они успешно созданы или отредактированы.
Если в процессе работы с API что-то пойдет не так, сотрудникам службы поддержки будет достаточно идентификатора requestID, который вы получаете в ответе от сервера — в нём есть вся нужная информация.

3. Более прозрачная и гибкая система баллов. В API 5 баллы начисляются не раз в сутки, а равномерно в течение дня.
Баллы списываются за каждую операцию и в ответе от сервера к вам возвращается количество списанных и оставшихся баллов. Они рассчитываются и списываются точнее, поскольку для незначительных правок больше не приходится выгружать и загружать всю кампанию.
Мы упразднили почти все ограничения на количество запросов с одним и тем же методом, так что вы сами решаете, на какие операции вам важнее потратить баллы.

4. Универсальный язык методов. Принявшись за такие глобальные изменения в API, мы заодно поменяли названия методов, максимально приблизив их к международному обиходу. Так что специалистам, которые пишут приложения для разных рекламных систем, не придется держать в голове дополнительные термины. Banner превратился в Ad, Price — в Bid, Phrase — в Keyword и так далее.
У методов схожие названия, в которых легко разобраться. Например, VCards.add и Sitelinks.add для добавления элементов, а VCards.get и Sitelinks.get — для выгрузки данных о них.

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




Версии 4 и 4 live будут закрыты в 2016 году. Мы предупредим вас об этом заранее. Но изучение новой версии лучше не откладывать на потом, поскольку интерфейс Директа стремительно пополняется новыми настройками, которые будут поддерживаться в API 5.

.

Полный текст статьи читайте на Яндекс