Медиа

Доступ к медиа предоставляется всем пользователям,у которых указано соответствующее разрешение в личном кабинете.
Для получения информации о медиа предусмотрены следующие запросы:

List

Метод list позволяет получить список медиа

Запрос:

{site_path}/{lang}/api/media/list

Список GET параметров:

filter	array	Позволяет фильтровать данные по всем доступным полям
fields	string	Позволяет выбрать из всех доступных только указанные поля
sort	string	Позволяет сортировать по возрастанию и по убыванию сущности по всем доступным полям
page	int	Позволяет передать порядковый номер страницы списка сущностей

Список всех доступных полей

id	int	ID медиа
name	string	Название медиа
format	int	ID размера медиа
notes	string	Заметки медиа
templateID	int	ID шаблона
advertiserID	int	ID рекламодателя медиа
advertiserName	string	Имя рекламодателя
typeName	string	Тип медиа
assignID	int	ID ответсовенного медиа
iabCat	int	ID категории медиа
url	int	Url для кликов
version	int	Версия медиа
created_by	int	ID создателя медиа
updated_by	int	ID последнего редактировавшего медиа
created_at	int	Время создания медиа в формате UTC
updated_at	int	Время последнего редактирования в формате UTC
views	int	Общее количество просмотров
viewsToday	int	Количество просмотров за текущие сутки
viewsYtd	int	Количество просмотров за прошедшие сутки
clicks	int	Общее количество кликов
clicksToday	int	Количество кликов за текущие сутки
clicksYtd	int	Количество кликов за прошедшие сутки
active	boolean	Статус медиа Значения: 1 - активно 0 - не активно
tag	array	Теги

Ответ

Ответ передается в формате JSON. Список полей ответа:

result	array	Список медиа с учетом параметров запроса
_links	array	Список ссылок навигации. Может содержать элементы: self - содержит ссылку на текущую страницу списка first - содержит ссылку на первую страницу списка last - содержит ссылку на последнюю страницу списка prev - содержит ссылку на предыдущую страницу списка next - содержит ссылку на следующую страницу списка
_meta	array	Информация по навигации списка. Содержит элементы: totalCount - общееколичество доступных сущностей учитывая все выбранные параметры pageCount - порядковый номер сущности в полученном списке, с которого начинается текущая страница currentPage - порядковый номер текущей страницы perPage - количество сущностей отображаемых на одной странице

Пример запроса:


              {site_path}/{lang}/api/media/list?filter[id][in][]=1&filter[id][in][]=2&filter[id][in][]=3&filter[name][like]=media&sort=name

Пример ответа:

{
  "result": [
    {
      "id": 1,
      "name": "media name",
      "format": 1,
      "assignID": 0,
      "advertiserID": "0",
      "templateID": 2,
      "typeName": null,
      "advertiserName": null,
      "notes": " ",
      "iabCat": "",
      "url": "ccc",
      "version": 0,
      "created_by": 903,
      "updated_by": 903,
      "updated_at": 1511438669,
      "created_at": 1509720442,
      "views": "2",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    },
    {
      "id": 2,
      "name": "another media name",
      "format": 197,
      "assignID": 0,
      "advertiserID": "904",
      "templateID": 18,
      "typeName": "banner",
      "advertiserName": "testadvertiser",
      "notes": " notes",
      "iabCat": "",
      "url": "//media.url",
      "version": 1,
      "created_by": 903,
      "updated_by": 907,
      "updated_at": 1575885099,
      "created_at": 1509720442,
      "views": "5",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "2": "general"
      }
    },
    {
      "id": 3,
      "name": "one more media name",
      "format": 55,
      "assignID": 0,
      "advertiserID": "904",
      "templateID": 18,
      "typeName": "banner",
      "advertiserName": "testadvertiser",
      "notes": "",
      "iabCat": "",
      "url": "http://media.url/",
      "version": 1,
      "created_by": 903,
      "updated_by": 907,
      "updated_at": 1560517756,
      "created_at": 1509720442,
      "views": "2008672583",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "306212",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "0",
      "tag": {
        "1": "sport"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/media/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1&filter%5Bid%5D%5Bin%5D%5B1%5D=2&filter%5Bid%5D%5Bin%5D%5B2%5D=3&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 3,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

View

Метод view позволяет получить расширенную информацию по медиа

Запрос:

{site_path}/{lang}/api/media/view/[id]

Список GET параметров:

id	int	Является обязательным параметром. Порядковый номер медиа
fields	string	Позволяет выбрать из всех доступных только указанные поля *Не распространяется на поля связанных сущностей

Список всех доступных полей

id	int	ID медиа
name	string	Название медиа
format	int	ID размера медиа
notes	string	Заметки медиа
templateID	int	ID шаблона
advertiserID	int	ID рекламодателя медиа
advertiserName	string	Имя рекламодателя
typeName	string	Тип медиа
assignID	int	ID ответсовенного медиа
iabCat	int	ID категории медиа
url	int	Url для кликов
version	int	Версия медиа
created_by	int	ID создателя медиа
updated_by	int	ID последнего редактировавшего медиа
created_at	int	Время создания медиа в формате UTC
updated_at	int	Время последнего редактирования в формате UTC
views	int	Общее количество просмотров
viewsToday	int	Количество просмотров за текущие сутки
viewsYtd	int	Количество просмотров за прошедшие сутки
clicks	int	Общее количество кликов
clicksToday	int	Количество кликов за текущие сутки
clicksYtd	int	Количество кликов за прошедшие сутки
active	boolean	Статус медиа Значения: 1 - активно 0 - не активно
campaign	array	Связанные с медиа кампании Со всеми доступными полями кампаний можно ознакомиться на этой странице
tag	array	Теги

Пример запроса:


              {site_path}/{lang}/api/media/view/2

Пример ответа:

{
  "id": 2,
  "name": "media name",
  "format": 135,
  "assignID": 0,
  "advertiserID": null,
  "templateID": 9,
  "typeName": banner,
  "advertiserName": name,
  "notes": "",
  "iabCat": "",
  "url": "http://media.url",
  "version": 1,
  "created_by": 1660984908,
  "updated_by": 1839588080,
  "updated_at": 1576002408,
  "created_at": 1525274553,
  "views": null,
  "viewsToday": null,
  "viewsYtd": null,
  "clicks": null,
  "clicksToday": null,
  "clicksYtd": null,
  "active": null,
  "campaign": [
    {
      "id": "1501852",
      "name": "campaign name",
      "chain": "0",
      "priority": "1",
      "created_by": "1660984908",
      "updated_by": "1839588080",
      "created_at": "1525273838",
      "updated_at": "1576594907",
      "attach_created_by": "1660984908",
      "attach_updated_by": "1660984908",
      "attach_created_at": "1525274689",
      "attach_updated_at": "1562066504",
      "views": "53323771",
      "viewsToday": "17",
      "viewsYtd": "192",
      "clicks": "4028",
      "clicksToday": "0",
      "clicksYtd": "0",
      "attached": "1",
      "active": "1"
    },
    {
      "id": "2033457146",
      "name": "another campaign name",
      "chain": "0",
      "priority": "1",
      "created_by": "1660984908",
      "updated_by": "1839588080",
      "created_at": "1562066495",
      "updated_at": "1576594879",
      "attach_created_by": "1660984908",
      "attach_updated_by": "1660984908",
      "attach_created_at": "1562066495",
      "attach_updated_at": "1562066495",
      "views": "3098010",
      "viewsToday": "5",
      "viewsYtd": "14",
      "clicks": "393",
      "clicksToday": "0",
      "clicksYtd": "0",
      "attached": "1",
      "active": "1"
    }
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}