Обзор API Директа версии 5
Программный интерфейс (API) Яндекс Директа предназначен для автоматизированного управления рекламными кампаниями. Через API внешние приложения добавляют и редактируют кампании, объявления, ключевые фразы, задают ставки, получают статистику показов и кликов.
Структура API
API Директа состоит из веб-сервисов. Каждый сервис имеет собственный URL.
Каждый сервис предназначен для работы с определенным классом объектов: например, сервис AdGroups предназначен для управления группами объявлений, Ads — объявлениями и т. д.
Сервис предоставляет набор методов для выполнения различных операций с объектами. Как правило, сервис включает следующие методы:
- add — добавление объектов;
- update — изменение параметров объектов;
- delete — удаление объектов;
- get — получение параметров объектов.
Сервисы могут включать и другие, специфические для объекта методы. Например, метод moderate сервиса Ads для отправки объявлений на модерацию.
Доступ к API
Подключение к API Директа и его использование является бесплатным.
Запросы к API выполняются приложением от имени пользователей Директа — рекламодателей и рекламных агентств. Для авторизации API использует протокол OAuth 2.0: в запросах необходимо указывать авторизационный токен.
Разработчик приложения, выполняющего запросы к API, должен его предварительно зарегистрировать.
Формат взаимодействия
Запросы к API выполняются по протоколу HTTPS методом POST. Авторизационный токен и другие специальные параметры передаются в HTTP-заголовке. Входные и выходные структуры данных передаются в теле запроса и ответа.
API Яндекс Директа поддерживает два формата взаимодействия: JSON и SOAP/XML.