Введение
В документе описаны основные ресурсы, которыми можно управлять через API Метрики для медийной рекламы.
API сервиса позволяют:
-
Управлять кампаниями, не используя веб-интерфейс.
-
Получать статистику кампаний (количество показов, достижений целей и др.).
-
Формировать отчеты, в том числе с помощью сегментации.
Для использования API Метрики для медийной рекламы необходима авторизация с помощью OAuth-токена.
Структура API
API включает в себя следующие разделы:
-
API управления — позволяет управлять кампаниями, целями и другими объектами API Метрики для медийной рекламы.
-
API отчетов — позволяет формировать сводки по кампаниям, создавать отчеты, поддерживает полный набор группировок и метрик, сравнение сегментов и т. п. Доступно в рамках Метрики Про.
Ресурсы
API Метрики для медийной рекламы построен по REST-принципам.
Все, чем можно управлять через API, представлено в виде ресурсов: статистика, список кампаний, цели кампаний и каждая конкретная цель, доступы к кампании и т. д.
То есть ресурс — это некая целостная часть системы, с которой можно работать:
-
читать содержимое и текущее состояние ресурса (GET);
-
изменять содержимое и состояние и записывать его в ресурс (PUT);
-
удалять ресурс (DELETE);
-
выполнять специальные действия ― например, добавлять новые элементы в список (POST).
У каждого ресурса есть свой уникальный URL. Все действия выполняются соответствующими методами протокола HTTP на URL'ы ресурсов.