Кампании

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