Медіа

Доступ до медіа надається всім користувачам, в яких є відповідний дозвіл в особистому кабінеті.
Для отримання інформації про медіа передбачені наступні запити:

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"},
  ]
}