Кампанії

  • API
  • Кампанії

Кампанії

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

Метод list дозволяє отримати список кампаній

Запит:

{site_path}/{lang}/api/campaign/list

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

filter array Дозволяє фільтрувати дані по всіх доступних полях
fields string Дозволяє обрати з усіх доступних тільки вказані поля
sort string Дозволяє сортувати у порядку зростання або зменшення сутності по всіх доступних полях
page int Дозволяє передати порядковий номар сторінки списка сутностей

Список всіх доступних полів

id int ID кампанії
name string Назва кампанії
notes string Нотатки кампанії
advertiserID int ID рекламодавця кампанії
advertiserName string Назва рекламодавця
assignID int ID відповідального кампанії
active boolean Статус кампанії
Значення:
  • 1 - активна
  • 0 - не активна
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 Кількість кліків за минулу добу
tag array Теги

Відповідь

Відповідь передається у форматі JSON. Список полів відповіді:

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

Приклад запиту:

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

Приклад відповіді:

{
  "result" : [
    {
      "id" : 2,
      "name" : "testadvertiser_adbet_logo",
      "notes" : "",
      "advertiserID" : "904",
      "advertiserName" : "testadvertiser",
      "assignID" : 0,
      "active" : "0",
      "created_by" : 1,
      "updated_by" : 907,
      "created_at" : 0,
      "updated_at" : 1560517823,
      "views" : "2008672583",
      "viewsToday" : "0",
      "viewsYtd" : "0",
      "clicks" : "306212",
      "clicksToday" : "0",
      "clicksYtd" : "0",
      "tag": {
        "2": "general",
      }
    },
    {
      "id" : 3,
      "name" : "testadvertiser_adverserve code 700x270",
      "notes" : "",
      "advertiserID" : "904",
      "advertiserName" : "testadvertiser",
      "assignID" : 0,
      "active" : "1",
      "created_by" : 906,
      "updated_by" : 903,
      "created_at" : 1521734211,
      "updated_at" : 1532513186,
      "views" : "121145798",
      "viewsToday" : "0",
      "viewsYtd" : "0",
      "clicks" : "3431004",
      "clicksToday" : "0",
      "clicksYtd" : "0",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    }
  ],
  "_links" :
  {
    "self" :
      {
      "href" : "{site_path}/{lang}/api/campaign/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&filter%5Bname%5D%5Blike%5D=test&sort=name&page=1"
      }
  },
  "_meta" : {
    "totalCount" : 2,
    "pageCount" : 1,
    "currentPage" : 1,
    "perPage" : 20
  }
}

Метод view дозволяє отримати розширену інформацію по кампанії

Запит:

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

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

id int Є обов'язковим параметром. Порядковий номер кампанії
fields string Дозволяє обрати з усіх доступних тільки вказані поля
*Не розповсюджується на поля пов'язаних сутностей

Список всіх доступних полів

id int ID кампанії
name string Назва кампанії
notes string Нотатки кампанії
advertiserID int ID рекламодавця кампанії
advertiserName string Назва рекламодавця
assignID int ID відповідального кампанії
active boolean Статус кампанії
Значення:
  • 1 - активна
  • 0 - не активна
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 Кількість кліків за минулу добу
media array Зв'язані з кампанією медіа
З усіма доступними полями медіа можна ознайомитись на цій сторінці
pool array Зв'язані з кампанією пули
З усіма доступними полями пулів можна ознайомитись на цій сторінці
tag array Теги

Приклад запиту:

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

Приклад відповіді:

{
  "id": 2,
  "name": "testadvertiser_adbet_logo",
  "notes": "",
  "advertiserID": null,
  "advertiserName": null,
  "assignID": 0,
  "active": null,
  "created_by": 1,
  "updated_by": 907,
  "created_at": 0,
  "updated_at": 1560517823,
  "views": null,
  "viewsToday": null,
  "viewsYtd": null,
  "clicks": null,
  "clicksToday": null,
  "clicksYtd": null,
  "media": [
    {
      "id": "3",
      "name": "Media name",
      "active": "0",
      "attached": "1",
      "chain": "0",
      "priority": "1",
      "views": "2008672256",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "306149",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "903",
      "updated_by": "907",
      "created_at": "1509720442",
      "updated_at": "1560517756",
      "attach_created_by": "0",
      "attach_updated_by": "906",
      "attach_created_at": "0",
      "attach_updated_at": "1527774613"
    },
    {
      "id": "4",
      "name": "another media name",
      "active": "0",
      "attached": "1",
      "chain": "0",
      "priority": "1",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "903",
      "updated_by": "906",
      "created_at": "1509720442",
      "updated_at": "1521734441",
      "attach_created_by": "0",
      "attach_updated_by": "906",
      "attach_created_at": "0",
      "attach_updated_at": "1518601987"
    }
  ],
  "pool": [
    {
      "id": "3",
      "name": "pool name",
      "active": "1",
      "attached": "1",
      "chain": "50",
      "priority": "1",
      "views": "2008672932",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "306212",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1",
      "updated_by": "906",
      "created_at": "1431594683",
      "updated_at": "1527606301",
      "attach_created_by": "906",
      "attach_updated_by": "906",
      "attach_created_at": "1521803312",
      "attach_updated_at": "1527774613"
    }
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}