Урок 1. Что такое API Директа

В этом уроке вы узнаете:

  1. Что такое API
  2. Для чего нужен API Директа
  3. С чего начать
  4. Объекты в веб-интерфейсе и в API
  5. Задание
  6. Как выглядит запрос к API
  7. Полезные ссылки
  8. Вопросы

В этом уроке мы расскажем, зачем Директу API, и познакомим вас с основными принципами работы.

Яндекс Директ — это единая платформа для размещения контекстной и медийной рекламы. Директ покажет объявления целевой аудитории вашего бизнеса, заинтересованной в ваших товарах или услугах.



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

Совет. Если вы еще не работали с Директом, рекомендуем предварительно пройти обучающий курс Как разместить рекламу в Директе и ознакомиться с Помощью. Это позволит вам понять общие принципы создания и ведения рекламных кампаний и лучше освоить наш курс по API.

Что такое API

API (англ. Application Programming Interface) — это интерфейс программирования приложений. API сервиса предоставляет набор готовых процедур, функций и структур, с помощью которых разработчики могут создавать свои программы, приложения, скрипты (далее — приложения) для работы с сервисом.

Другими словами, API — это конструктор, в котором есть набор деталей (функций, методов) и правил их использования. Из этих деталей вы можете построить собственное приложение.



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

Для чего нужен API Директа

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



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

Подключение к API Директа и его использование является бесплатным.

С чего начать

Для прохождения курса вам потребуется аккаунт в Директе. Создайте, если у вас его еще нет:

  1. Войдите на Яндекс под своим логином, который будете использовать как разработчик приложений. Если у вас нет логина на Яндексе — зарегистрируйтесь.
  2. В веб-интерфейсе Директа (https://direct.yandex.ru) нажмите кнопку Запустить рекламу.
  3. Укажите актуальный адрес электронной почты, выберите страну и валюту. Нажмите кнопку Начать пользоваться сервисом.
  4. Создайте первую рекламную кампанию — рекомендуем выбрать тип кампании «Текстово-графические объявления». Укажите параметры кампании и создайте первое объявление. На этом этапе вам достаточно создать одно объявление-черновик с одной ключевой фразой. Отправлять объявления на модерацию и зачислять денежные средства на кампанию не требуется.
Примечание. Более подробную информацию о создании аккаунта в Директе вы можете найти в Помощи. Советуем также пройти соответствующий урок курса по Директу.

Теперь у вас есть аккаунт в Директе. Давайте посмотрим, как выглядят ваши рекламные материалы в веб-интерфейсе и в API.

Объекты в веб-интерфейсе и в API

Рекламная кампания в Директе состоит из групп объявлений, каждая из которых содержит объявления и ключевые фразы. Объявления могут включать в себя дополнительные элементы: изображения, быстрые ссылки и другие.



Взаимосвязь объектов в API представлена на схеме:



  • Campaign — рекламная кампания, AdGroup — группа объявлений, Ad — объявление.
  • Дополнения к объявлению: AdImage — изображение, VCard — визитка, SitelinksSet — набор быстрых ссылок, AdExtension — уточнение.
  • Условия показа объявлений группы: Keyword — ключевая фраза и другие, в зависимости от типа кампании. Для условия показа можно установить ставку — KeywordBid.


Задание

Изучите настройки своей рекламной кампании в Директе. Создайте новые объявления с разными параметрами. Если вы не хотите запускать реальную кампанию — не отправляйте группы объявлений на модерацию, тогда объявления останутся в статусе «Черновик».

Выполнить задание

Как выглядит запрос к API

Рекламные материалы, которые вы видите в веб-интерфейсе, можно получить с помощью запросов к API. Внести изменения тоже можно с помощью запросов к API — и сразу увидеть результат в веб-интерфейсе. API работает с каждым объектом в отдельности: различные методы API позволяют создать объявление, обновить визитку, получить статистику и многое другое.

Вот как выглядит запрос к API, который позволяет получить список рекламных кампаний пользователя. Запрос отправляется по сетевому протоколу HTTPS методом POST.



В следующих уроках мы проведем вас по всем начальным этапам работы с API:

  • Расскажем, как получить доступ к API — зарегистрировать приложение на сервисе Яндекс.OAuth, подать заявку на доступ, получить OAuth-токен.
  • Поможем настроить тестовую среду для отладки приложения — Песочницу.
  • Научим формировать запросы к API: покажем, какие сервисы и методы предоставляет API, подробно рассмотрим структуру запроса.
  • В завершение дадим несколько советов, как перейти от тренировки в Песочнице к работе с реальными рекламными материалами реальных пользователей.

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

Желаем успеха!

Вопросы

  1. Для работы с API необходим аккаунт в Директе. Что нужно сделать для создания аккаунта в Директе?
    Неверно.
    Верно!
    Неверно.
  2. Что можно делать с помощью API Директа?
    Неверно.
    Верно!
    Неверно.
  3. Если вы внесете изменения в рекламную кампанию через API Директа, то где они будут отображены?
    Неверно.
    Неверно.
    Верно!