RTB.SAPE.RU XML-RPC

Наш xml-rpc интерфейс доступен по адресу: http://api.sape.ru/xmlrpc/?rtb=1. Обращаться нужно по 80-му порту, тело xml-запроса класть в POST_DATA. Всё общение происходит полностью в кодировке UTF-8. Кроме того, можно работать по https по адресу: https://api.sape.ru/xmlrpc/?rtb=1.

Если Вы ещё ничего не знаете про XML-RPC, то рекомендуем почитать на сайте www.xmlrpc.com:

Важно: перед вызовом функций необходимо залогиниться в системе в с помощью функции: sape.login


Описание существующих функций

  • (array) rtb.get_sites() — список площадок пользователя.
    Структура ответа:
    • id — ID площадки,
    • url — Url площадки,
    • status — Статус площадки,
    • date_created — Дата и время создания
  • (array) rtb.get_places([(array) site_ids = array()]) — список рекламных мест пользователя
    Параметры:
    • site_ids — массив ID интересующих площадок (по-умолчанию: пустой)
    Структура ответа:
    • id — ID рекламного места
    • site_id — ID площадки
    • name — Название рекламного места
    • size — Размер рекламного места
    • date_created — Дата и время создания
    • code — Скрипт, поместите внутрь тега <head>. Достаточно установить один раз, даже если у вас несколько рекламных мест.
  • (array) rtb.get_stats( (string) date_from, (string) date_to [, (string) group_by = 'site' [, (array) site_ids = array(), [ (array) place_ids = array()]]] ) — подневная статистика показов
    Параметры:
    • date_from — Дата начала интервала в формате: 'YYYY-MM-DD'
    • date_to — Дата окончания интервала в формате: 'YYYY-MM-DD'
    • group_by — Тип группировки результатов (по-умолчанию: 'site')
      • 'site' - по площадкам
      • 'place' - по рекламным местам
    • site_ids — массив ID интересующих площадок (по-умолчанию: пустой)
    • place_ids — массив ID интересующих рекламных мест (по-умолчанию: пустой)
    Максимальный размах дат между date_from и date_to составляет 31 день

    Структура ответа:
    • date_view — Дата показа в формате YYYY-MM-DD
    • site_id — ID Площадки
    • place_id — ID Рекламного места
    • price_wm — Заработано
    • imps_total — Показов всего
    • imps_billed — RTB-показов оплаченных
    • imps_unbilled — RTB-показов неоплаченных
    • rtb_cpm — CPM
  • (array) rtb.site_add( (string) url, (integer) show_mobile_ad, (integer) category_id [, (array) bl_domain = array()] ) — Добавление сайта
    Параметры:
    • url — ссылка на сайт
    • show_mobile_ad — Мобильная реклама маска
      • 0 - выключена
      • +1 - Fullscreen, средний CPM - 14 руб
      • +4 - Float banner (Стикер), средний CPM - 10 руб
      • +8 - Видео-реклама, средний CPM - 40 руб
    • category_id — Тематика Выберите наиболее подходящую
    • bl_domain — Черные списки площадок

    Структура ответа:
    • id — ID Площадки
    • url — Ссылка на сайт
    • status — Статус
    • category_id — Тематика
    • bl_domains — Черные списки площадок
    • date_created — Дата создания в формате YYYY-MM-DD
  • (array) rtb.site_update( (integer) site_id, (integer) show_mobile_ad, (integer) category_id [, (array) bl_domain = array()] ) — Редактирование сайта
    Параметры:
    • site_id — ID Площадки
    • show_mobile_ad — Мобильная реклама маска
      • 0 - выключена
      • +1 - Fullscreen, средний CPM - 14 руб
      • +4 - Float banner (Стикер), средний CPM - 10 руб
      • +8 - Видео-реклама, средний CPM - 40 руб
    • category_id — Тематика Выберите наиболее подходящую
    • bl_domain — Черные списки площадок

    Структура ответа:
    • id — ID Площадки
    • url — Ссылка на сайт
    • status — Статус
    • category_id — Тематика
    • bl_domains — Черные списки площадок
    • date_created — Дата создания в формате YYYY-MM-DD
  • (array) rtb.float_place_add( (integer) site_id, (string) place_name, [ (integer) timeout = 15, [ (string) background = 'rgba(255,255,255,0.5)', [ (string) color = 'rgba(0,0,0,1)']]] ) — Добавление баннера-растяжки
    Параметры:
    • site_id — ID сайта
    • place_name — Название рекламного места
    • timeout — Задержка
    • background — Цвет подложки
    • color — Цвет текста

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • background — Цвет подложки
    • color — Цвет текста
    • timeout — Задержка
  • (array) rtb.inpage_place_add( (integer) site_id, (string) place_name, [ (string) html = null, [ (boolean) async = true]] ) — Добавление inpage-видео баннера
    Параметры:
    • site_id — ID сайта
    • place_name — Название рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.video_place_add( (integer) site_id, (string) place_name, [ (string) html = null, [ (boolean) async = true]] ) — добавление видео-баннера
    Параметры:
    • site_id — ID сайта
    • place_name — Название рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.banner_place_add( (integer) site_id, (string) place_name, (integer) popup, [ (integer) size = 0, [ (double) min_cpm = 2.0, [ (string) html = null, [ (boolean) async = true]]]] ) — добавление баннера
    Параметры:
    • site_id — ID сайта
    • place_name — Название рекламного места
    • popup — Плавающее место
      • 0 - Нет
      • 1 - Снизу справа
      • 2 - Снизу слева
      • 3 - Сверху справа
      • 4 - Сверху слева
      • 5 - Сверху посередине
      • 6 - Снизу посередине
    • size — Размер рекламного места
      • 1 - 240x400
      • 2 - 728x90
      • 3 - 300x250
      • 4 - 468x60
      • 5 - 160x600
      • 6 - 120x600
      • 7 - 300x600
      • 8 - 970x90
      • 10 - 240x120
    • min_cpm — Минимальны CPM места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • popup — Плавающее место
    • size — Размер рекламного места
    • min_cpm — Минимальны CPM места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.float_place_update( (integer) place_id, (string) place_name, [ (integer) timeout = 15, [ (string) background = 'rgba(255,255,255,0.5)', [ (string) color = 'rgba(0,0,0,1)']]] ) — обновление баннера-растяжки
    Параметры:
    • place_id — ID рекламного места
    • place_name — Название рекламного места
    • timeout — Задержка
    • background — Цвет подложки
    • color — Цвет текста

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • background — Цвет подложки
    • color — Цвет текста
    • timeout — Задержка
  • (array) rtb.inpage_place_update( (integer) place_id, (string) place_name, [ (string) html = null, [ (boolean) async = true]] ) — обновление inpage-видео баннера
    Параметры:
    • place_id — ID рекламного места
    • place_name — Название рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.video_place_update( (integer) place_id, (string) place_name, [ (string) html = null, [ (boolean) async = true]] ) — обновление видео-баннера
    Параметры:
    • place_id — ID рекламного места
    • place_name — Название рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.banner_place_update( (integer) place_id, (string) place_name, (integer) popup, [ (double) min_cpm = 2.0, [ (string) html = null, [ (boolean) async = true]]] ) — обновление баннера
    Параметры:
    • place_id — ID рекламного места
    • place_name — Название рекламного места
    • popup — Плавающее место
      • 0 - Нет
      • 1 - Снизу справа
      • 2 - Снизу слева
      • 3 - Сверху справа
      • 4 - Сверху слева
      • 5 - Сверху посередине
      • 6 - Снизу посередине
    • min_cpm — Минимальны CPM места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме

    Структура ответа:
    • id — ID Рекламного места
    • site_id — ID Площадки
    • name — Название рекламного места
    • type — Тип рекламного места
    • popup — Плавающее место
    • size — Размер рекламного места
    • min_cpm — Минимальны CPM места
    • html — Заглушка
    • async — Заглушка работает в асинхронном режиме
  • (array) rtb.get_site_categories() — список тематик сайтов.
    Структура ответа:
    • id — ID тематики,
    • title — Название