Перейти к содержимому
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

API платформы автоматизирует все функции, доступные в панели администратора, как для рекламодателей, так и для издателей.

1. Что можно автоматизировать для рекламодателей
  • Кампании и группы, варианты, офферы и рекламные форматы

  • Настройка и блокировка параметров таргетинга и категорий

  • Цели

  • Получение статистики, включая данные о пользователях с блокировщиками рекламы

  • Дневной бюджет, пополнение счета, способы оплаты

  • Название и URL целевой страницы, алгоритм распределения трафика

2. Что можно автоматизировать для издателей
  • Рекламные форматы и рекламные зоны

  • Сайты, проверка URL-адресов

  • Блокировка типов рекламы и категорий товаров

  • Получение всей статистики, включая данные о пользователях с блокировщиками рекламы

  • Цены ставок для каждого рекламного формата и GEO, модели ценообразования

  • Способы оплаты

3. Как пользоваться API
  • Интерфейс API быстрый и простой в использовании

  • Просто выберите параметр и нажмите кнопку Попробовать — код будет сгенерирован автоматически

4. Скачать техническую документацию

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

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

Перед началом работы

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

список API

HTTP-методы

API поддерживает следующие HTTP-методы:

Не все функции поддерживают все методы.

Примеры использования API

Настройка

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

Чтобы создать токен API:

  1. Перейдите в раздел Мой профиль > Токены API и нажмите Новый токен API.

  2. Введите название токена. Нажмите Сохранить.

  3. Полный токен будет показан рядом с кнопкой Копировать . Скопируйте его и сохраните в надежном месте. Это единственный раз, когда токен отображается полностью.

  4. Нажмите Готово , чтобы закрыть окно.

Окно копирования токена API

После этого в таблице токенов API будут отображаться только последние 4 символа токена (например, ••••a1b2). Полный токен больше нельзя будет просмотреть или скопировать.

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

Токен создан.

Таблица токенов API

Вход в API

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

вход в API
вход в API

Как отправить запрос к API

В качестве примера используем группу Campaigns. Нажмите на неё, чтобы раскрыть список доступных запросов.

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

получение кампании

Нажмите Получить кампанию — откроется окно. Введите идентификатор кампании в поле:

идентификатор кампании
идентификатор кампании

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

тело ответа

Код ответа 200 означает, что запрос выполнен успешно.

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

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

приостановка кампании

Нажмите Приостановить для одной или нескольких кампаний. Открыв окно, нажмите Пример значения, затем нажмите на жёлтый блок — структура JSON автоматически скопируется в поле тела запроса.

приостановить

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

идентификатор кампании

Как изменить цену кампании

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

идентификатор кампании

Нажмите Изменить кампанию, чтобы открыть окно. Добавьте CID в поле идентификатора кампании, затем нажмите Пример значения, затем нажмите на жёлтый блок — структура JSON скопируется в поле тела запроса.

Этот код содержит несколько разных функций. Удалите всё, кроме кода для задания цены кампании, как показано ниже:

идентификатор кампании

Теперь измените два значения в поле тела запроса. Начните с модели. Ниже перечислены значения для каждой модели ценообразования.

В этом примере используется CPC, поэтому оставьте значение model равным 1.

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

идентификатор кампании

Затем нажмите Попробуйте кнопка для генерации кода.

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

Это было полезно?