Адрес сервиса: https://adm.spotsnetwork.com/api/v2/

Спецификация

Обращение к сервису выполняется по протоколу JSON-RPC 2.0. Подробнее о спецификации протокола можете прочитать в официальных источниках.

Получение списка размеров

Для получения списка размеров для различных типов необходимо вызвать метод "block.getSizes".

Параметры запроса

Вызов метода происходит без параметров.

Параметры ответа

В ответе будут возвращены следующие значения:

"banner" - список размеров (массив строк);
"video" - список размеров (массив строк).

Пример использования метода

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"block.getSizes", 
    "params":{}, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": {
        "banner": [
            "adaptive",
            "fullscreen",
            "970x250",
            "970x90",
            "728x250"
        ],
        "video": [
            "xs",
            "s",
            "m",
            "l",
            "xl"
        ]
    },
    "id": 1
}

Получение списка типов размещения

Для получения списка типов размещения необходимо вызвать метод "block.getPlacementTypes".

Параметры запроса

Вызов метода происходит без параметров.

Параметры ответа

В ответе будут возвращены массив объектов, где каждый объект содержит следующие значения:

"id" - идентификатор;
"title" - название.

Пример использования метода

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"block.getPlacementTypes", 
    "params":{}, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": [
        {
            "id": 0,
            "title": "None"
        },
        {
            "id": 1,
            "title": "InStream"
        },
        {
            "id": 2,
            "title": "InStream - preroll"
        }
    ],
    "id": 1
}

Создание блока

Для создания блока необходимо вызвать метод "block.create".

Параметры запроса

Название	Описание	Тип
fields	Поля объекта	object

Параметры объекта fields

В таблице ниже описаны все возможные параметры объекта fields.

Название	Описание	Тип
platform	Идентификатор площадки. Обязательное	int
title	Название. Обязательное. Минимальная длина 1, максимальная 255.	string
type	Тип. Обязательное. Допустимые значения: 2 - banner 3 - video 4 - combo	int
size	Размер баннера. Обязательное только для типа banner и combo. Значение из списка размеров баннера.	string
main_type_block	Подтип для баннера. Обязательное только для типа banner и combo. Допустимые значения:1 - html	int
size_video	Размер видео. Обязательное только для типа video и combo. Значение из списка размеров видео.	string
main_type_block_video	Подтип для видео. Обязательное только для типа video и combo. Допустимые значения:3 - video	int
placementType	Тип размещения для видео. Обязательное только для типа video и combo. Идентификатор из списка типов размещения	int
bidflor	Бидфлор (руб). Обязательное. Минимальное значение 1	float

Параметры ответа

В ответе будут возвращены следующие значения:

"id" - список размеров (массив строк);
"video" - список размеров (массив строк).
"id" - Идентификатор;
"title" - Название;
"type" - Тип;
"size" - Размер баннера;
"main_type_block" - Подтип для баннера;
"size_video" - Размер видео;
"main_type_block_video" - Подтип для видео;
"placementType" - Тип размещения для видео;
"bidflor" - Бидфлор (руб);
"placementId" - Идентификатор placement.

Пример использования метода

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"block.create", 
    "params":{
        "fields": {
          "platform": 3000,
          "title": "Название", 
          "type": 4, 
          "size": "160x600", 
          "main_type_block": 1, 
          "size_video": "s",
          "main_type_block_video": 3,
          "placementType": 6,
          "bidflor": 1.5
        }
    }, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": {
        "id": 28382,
        "title": "Название",
        "type": 4, 
        "size": "160x600", 
        "main_type_block": 1, 
        "size_video": "s",
        "main_type_block_video": 3,
        "placementType": 6,
        "bidflor": 1.5
        "placementId": 28382
    },
    "id": 1
}

Обновление блока

Для обновления полей блока необходимо вызвать метод "block.update".

Параметры запроса

Название	Описание	Тип
id	Идентификатор. Обязательное	int
fields	Поля объекта	object

Параметры объекта fields

В таблице ниже описаны все возможные параметры объекта fields.

Название	Описание	Тип
title	Название. Минимальная длина 1, максимальная 255.	string
type	Тип. Допустимые значения: 2 - banner 3 - video 4 - combo	int
size	Размер баннера. Только для типа banner и combo. Значение из списка размеров баннера.	string
main_type_block	Подтип для баннера. Только для типа banner и combo. Допустимые значения:1 - html	int
size_video	Размер видео. Только для типа video и combo. Значение из списка размеров видео.	string
main_type_block_video	Подтип для видео. Только для типа video и combo. Допустимые значения:3 - video	int
placementType	Тип размещения для видео. Только для типа video и combo. Идентификатор из списка типов размещения	int
bidflor	Бидфлор (руб). Минимальное значение 1	float

Параметры ответа

В ответе будут возвращены следующие значения:

"id" - список размеров (массив строк);
"video" - список размеров (массив строк).
"id" - Идентификатор;
"title" - Название;
"type" - Тип;
"size" - Размер баннера;
"main_type_block" - Подтип для баннера;
"size_video" - Размер видео;
"main_type_block_video" - Подтип для видео;
"placementType" - Тип размещения для видео;
"bidflor" - Бидфлор (руб);
"placementId" - Идентификатор placement.

Пример использования метода

// пример запроса
 
{
    "jsonrpc": "2.0", 
    "method":"block.update", 
    "params":{
        "id": 28382,
        "fields": {
          "title": "Название", 
          "bidflor": 1.5
        }
    }, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": {
        "id": 28382,
        "title": "Название",
        "type": 4, 
        "size": "160x600", 
        "main_type_block": 1, 
        "size_video": "s",
        "main_type_block_video": 3,
        "placementType": 6,
        "bidflor": 1.5
        "placementId": 28382
    },
    "id": 1
}