API docs by Redocly

MADS API (1.0.0)

Download OpenAPI specification:

API рекламной платформы MADS. Интеграция рекламы через REST API без использования SDK.

Schemas

AdResponse

padId
integer

Id рекламного плейсмента

templateGroupName
string
Enum: "modalwindow" "fulscreen" "multiformat" "stories" "clickout"

Формат рекламы

templateName
string

Имя шаблона, реализующего UI отображение

ModalWindowDisplayOptions (object) or MultiformatDisplayOptions (object) or StoriesDisplayOptions (object)

UI-конфигурация на уровне блока (зависит от templateGroupName)

Array of ModalWindowCreative (object) or MultiformatCreative (object) or StoriesCreative (object)

Массив креативов (структура зависит от templateGroupName)

Array of objects (Statistic)

Пиксели для всего блока

{
  • "padId": 0,
  • "templateGroupName": "modalwindow",
  • "templateName": "string",
  • "displayOptions": {
    },
  • "items": [
    ],
  • "statistics": [
    ]
}

ModalWindowDisplayOptions

modalWindowCornerRadius
integer

Радиус скругления верха модалки

backgroundColor
string

Цвет заднего фона модалки

{
  • "modalWindowCornerRadius": 0,
  • "backgroundColor": "string"
}

MultiformatDisplayOptions

object (AspectRatio)
useAutoScroll
boolean

Включено ли автоперелистывание

autoScrollTimeout
integer or null

Время между автоперелистываниями (сек)

useHeader
boolean

Использовать хедер над креативами

cornerRadius
integer

Радиус скругления слайдов

earsWidth
integer

Ширина ушей (видимых частей боковых баннеров)

interItemSpacing
integer

Отступы между слайдами

format
string

Формат (carousel)

{
  • "size": {
    },
  • "useAutoScroll": true,
  • "autoScrollTimeout": 0,
  • "useHeader": true,
  • "cornerRadius": 0,
  • "earsWidth": 0,
  • "interItemSpacing": 0,
  • "format": "string"
}

StoriesDisplayOptions

defaultSlideDuration
integer

Длительность показа слайда (сек)

coverBorderColor
string

Цвет не просмотренной обложки

coverBorderViewedColor
string

Цвет просмотренной обложки

coverCornerRadius
integer

Скругление обложки и рамки

object (AspectRatio)
interItemSpacing
integer

Расстояние между обложками

{
  • "defaultSlideDuration": 0,
  • "coverBorderColor": "string",
  • "coverBorderViewedColor": "string",
  • "coverCornerRadius": 0,
  • "size": {
    },
  • "interItemSpacing": 0
}

ModalWindowCreative

id
required
string

Уникальный идентификатор объявления

integrationType
required
string
Enum: "sdk" "native"
required
Array of objects (Statistic)
contentType
required
string
Enum: "image" "video"
required
Image (object) or Video (object)
required
object (MarkingInfo)

Информация о маркировке рекламы

title
string or null
subtitle
string or null
object (Button)
{
  • "id": "string",
  • "integrationType": "sdk",
  • "statistics": [
    ],
  • "contentType": "image",
  • "content": {
    },
  • "markingInfo": {
    },
  • "title": "string",
  • "subtitle": "string",
  • "button": {
    }
}

MultiformatCreative

id
required
string

Уникальный идентификатор объявления

integrationType
required
string
Enum: "sdk" "native"
required
Array of objects (Statistic)
contentType
required
string
Enum: "image" "video"
required
Image (object) or Video (object)
required
object (MarkingInfo)

Информация о маркировке рекламы

object (Link)
{
  • "id": "string",
  • "integrationType": "sdk",
  • "statistics": [
    ],
  • "contentType": "image",
  • "content": {
    },
  • "markingInfo": {
    },
  • "link": {
    }
}

StoriesCreative

id
required
string

Уникальный идентификатор объявления

integrationType
required
string
Enum: "sdk" "native"
contentType
required
string
Enum: "image" "video"
required
object (Image)
title
required
string

Заголовок под обложкой

required
Array of objects (Statistic)
required
Array of objects (StorySlide)
{
  • "id": "string",
  • "integrationType": "sdk",
  • "contentType": "image",
  • "content": {
    },
  • "title": "string",
  • "statistics": [
    ],
  • "slides": [
    ]
}

StorySlide

id
integer

Порядковый номер слайда

isViewed
boolean

Просмотрен ли слайд

contentType
string
Enum: "image" "video"
Image (object) or Video (object)
object (Button)
object (MarkingInfo)

Информация о маркировке рекламы

Array of objects (Statistic)
{
  • "id": 0,
  • "isViewed": true,
  • "contentType": "image",
  • "content": {
    },
  • "button": {
    },
  • "markingInfo": {
    },
  • "statistics": [
    ]
}

Statistic

url
string

URL пикселя

type
string

Тип пикселя (impression, click и др.)

value
integer or null

Время в секундах

pvalue
integer or null

Время в процентах от duration

viewablePercent
integer or null

Процент вхождения в область видимости

{
  • "url": "string",
  • "type": "string",
  • "value": 0,
  • "pvalue": 0,
  • "viewablePercent": 0
}

MarkingInfo

labelText
string

Текст элемента (Реклама, Соц. реклама)

orgInfo
string

Информация о рекламодателе

url
string

Ссылка в кнопке

buttonText
string

Текст на кнопке в маркировочной модалке

description
string

Текст над информацией о рекламодателе

object (MarkingDisplayOptions)
{
  • "labelText": "string",
  • "orgInfo": "string",
  • "url": "string",
  • "buttonText": "string",
  • "description": "string",
  • "displayOptions": {
    }
}

MarkingDisplayOptions

backgroundColor
string

Цвет фона для лейбла

textColor
string

Цвет текста

{
  • "backgroundColor": "string",
  • "textColor": "string"
}

AspectRatio

width
integer

Ширина

height
integer

Высота

{
  • "width": 0,
  • "height": 0
}

Image

url
string

URL изображения

object (AspectRatio)
{
  • "url": "string",
  • "size": {
    }
}

Video

url
string

URL видео

object (AspectRatio)
bitrate
integer

Битрейт

format
string

Формат (mp4)

duration
integer

Длительность в миллисекундах

{
  • "url": "string",
  • "size": {
    },
  • "bitrate": 0,
  • "format": "string",
  • "duration": 0
}

Button

type
string

Тип кнопки (cta, customAction и др.)

subType
string

Подтип (rich, promocodeCopy и др.)

text
string <= 30 characters

Текст кнопки

object or object (ButtonContent)

LinkButton или PromocodeButton

object (ButtonDisplayOptions)
{
  • "type": "string",
  • "subType": "string",
  • "text": "string",
  • "model": {
    },
  • "displayOptions": {
    }
}

ButtonDisplayOptions

textColor
string

Цвет текста в HEX

backgroundColor
string

Цвет фона в HEX

cornerRadius
integer

Скругление кнопки

{
  • "textColor": "string",
  • "backgroundColor": "string",
  • "cornerRadius": 0
}

ButtonContent

One of
object (Link)
{
  • "promocode": "string",
  • "onCopyText": "string",
  • "alertText": "string"
}

Получение рекламных форматов

Запрос рекламных креативов по идентификатору плейсмента (padId). API не требует авторизации.

query Parameters
padId
required
integer

Идентификатор плейсмента

userId
string

Ваш идентификатор пользователя

gaid
string <uuid>

Рекламный идентификатор устройства Android

idfa
string <uuid>

Рекламный идентификатор устройства iOS

bundleId
string

ID сборки (для отладки и контроля качества)

deviceId
string

Сгенерированный постоянный идентификатор устройства (используется, если невозможно отправить gaid/idfa)

appVersion
string

Версия вашего приложения

sdkVersion
string

Версия рекламного SDK

osName
string

Название операционной системы пользователя

osVersion
string

Версия операционной системы

connectionType
string
Enum: "wifi" "3g" "4g" "5g"

Тип подключения к интернету

category
string

Тематическая или товарная категория внутри вашего приложения

searchQuery
string

Поисковый запрос внутри приложения или на сайте

utcOffset
integer

Часовой пояс пользователя относительно UTC (в минутах)

debugCreative
boolean

Получить ли дебаг-креатив

Responses

Response samples

Content type
application/json
{
  • "padId": 0,
  • "templateGroupName": "modalwindow",
  • "templateName": "string",
  • "displayOptions": {
    },
  • "items": [
    ],
  • "statistics": [
    ]
}