Перейти к основному содержанию

API для разработчиков

С помощью API платформы можно автоматизировать все функции, которые находятся в панели администратора.

1. Что могут автоматизировать рекламодатели?
  • Кампании/группы, вариации, предложения и форматы объявлений
  • Нацеливание/блокирование параметров нацеливания, категорий
  • Цели
  • Получение статистики, включая данные о пользователях adblock
  • Ежедневный бюджет, пополнение счета, типы платежей
  • Название посадочной страницы, URL и алгоритм доли трафика
2. Что могут автоматизировать издатели?
  • Форматы объявлений и рекламные зоны
  • Сайты, проверка URL-адресов
  • Блокируйте типы объявлений и категории продуктов
  • Соберите всю статистику, включая данные о пользователях adblock
  • Цены торгов на формат объявления/GEO, модели ценообразования
  • Типы платежей
3. Как использовать API
  • Интерфейс API быстр и прост в использовании
  • Просто выберите параметр и нажмите кнопку Try It Out, чтобы автоматически сгенерировать код
4. Скачать техническую документацию

Как использовать API платформы​

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

Характеристики​

Как издателям, так и рекламодателям доступен огромный набор функций. Вот краткое описание того, что можно автоматизировать:

Рекламодатели​

  • Индивидуальные/групповые кампании, вариации, предложения, форматы объявлений.
  • Нацеливание/блокирование опций нацеливания, категорий, разбора дня.
  • Цели.
  • Получение статистики, включая данные о пользователях adblock.
  • Ежедневный бюджет, финансирование счетов, типы платежей.
  • Название посадочной страницы, URL и алгоритм доли трафика.

Издательство​

  • Форматы объявлений и рекламные зоны.
  • Сайты, проверка URL-адресов.
  • Блокируйте типы объявлений и категории товаров.
  • Соберите всю статистику, включая данные о пользователях adblock.
  • Цены торгов для каждого формата объявлений/GEO, модели ценообразования.
  • Виды оплаты.
Прежде чем приступить к работе​

В интерфейсе API отображается список названий групп. Нажмите на группу, и все доступные опции выпадут.

list api

Глаголы HTTP​

API поддерживает следующее подмножество глаголов HTTP. Обратите внимание, что не все функции поддерживают все глаголы.

API uses

Давайте начнем!

Настройка​

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

Создание API-токена доступно в меню Мой профиль. Выберите API-токены.

my profile

Нажмите на Новый API-токен.

api tokens

Введите имя токена, в данном руководстве мы назвали его "testToken", затем нажмите Save.

Создается идентификатор токена.

token id

Вход в API​

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

api login

api login

Как сделать запрос к API​

На примере группы "Кампании" щелкните по ней, и группа раскроется со списком доступных запросов:

Нажмите на запрос, который вы хотите автоматизировать, в этом примере мы запросим данные для CID 1923724:

get campaign

Нажмите на Получить кампанию, в результате чего откроется окно. Введите в поле идентификационный номер кампании:

campaign id

Затем нажмите на кнопку Попробовать сейчас. Тело ответа автоматически сгенерирует код.

response body

Код ответа 200 означает, что все в порядке.

Как приостановить кампанию​

Вот еще один пример. Сначала выберите нужную функцию в группе "Кампании":

campaign pause

Нажмите на Пауза для одной или нескольких кампаний. После открытия нажмите на Пример значения, затем нажмите на желтое поле, это автоматически вставит структуру json в поле body.

pause

Теперь текущее значение равно нулю, поэтому измените ноль на CID, который вы хотите поставить на паузу. Затем нажмите кнопку Попробовать, чтобы сгенерировать необходимый код.

campaign id

Как обновить ценообразование кампании​

Выберите нужную функцию:

campaign id

Нажмите на Обновить кампанию, чтобы открыть окно. Добавьте CID в поле id кампании, затем нажмите Пример значения, нажмите на желтое поле, которое скопирует json-структуру в поле body.

Этот код содержит несколько различных функций, но нам нужен код ценообразования кампании, поэтому удалите ненужную часть кода, оставив код ценообразования кампании в поле, как показано ниже:

campaign id

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


CampaignPricing {
model (integer, optional): Campaign pricing model (1: CPC, 2: CPM, 3: CPA, 4: Smart CPM, 5: CPV) = [‘1’, ‘2’, ‘3’, ‘4’, ‘5’],
price (number, optional): Campaign price
}

Мы будем использовать CPC, поэтому оставим модель на 1

Теперь нам нужно изменить цену с нуля на нужную нам цену. Мы изменим ее на 200, что означает, что новая цена будет равна 200 центам или двум евро.

campaign id

Затем просто нажмите кнопку Опробовать, чтобы сгенерировать код. Легко!

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

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