tracingPoint

Получить список точек учета действия.

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

Формат запроса

Примечание. Доступна пагинация.
https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=list
 & actionObject=tracingPoint
 & [actionObjectID=<integer>]
 & [advertiserID=<integer>]
 & [categoryID=<integer>]
 & [templateTypeID=<integer>]
 & [userID=<integer>]
 & [referrer=<string>]
 & [campaignID=<integer>]
Query-параметры
actionObjectID

Получить список только из одного объекта с указанным ID.

Если используется этот параметр, остальные необязательные параметры игнорируются.

advertiserID

ID рекламодателя.

См. также:

categoryID

ID категории, к которой будет размечена аудитория, контактирующая с точкой учета действия.

Допустимые значения:

  • 0 — категория не задана;
  • N — где N — ID категории;

Значение по умолчанию: 0

templateTypeID

ID типа шаблона. Подробнее о типах шаблонов см. Шаблоны referer.

Допустимые значения:

  • 0 — стандартный;
  • 1 — POSIX.2.

Значение по умолчанию: 0.

userID

Идентификатор.

referrer

Шаблон URL для сравнения с адресом страницы сайта, полученным из запроса. Если адрес не подходит под шаблон URL, загрузка точки не будет засчитана.

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

  • для стандартного типа шаблонов:
    ⃰site.ru/index.php
  • Для POSIX.2:
    homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$

Может содержать русские и латинские буквы, цифры и любые символы.

campaignID

ID кампании.

См. также:

*  Обязательный параметр

Формат ответа

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <objectID>{integer}</objectID>
     <advertiserID>{integer}</advertiserID>
     <userID>{integer}</userID>
     <objectName>{string}</objectName>
     <weight>{integer}</weight>
     <categoryID>{integer}</categoryID>
     <templateTypeID>{integer}</templateTypeID>
     <objectReferrer>{string}</objectReferrer>
     <objectDescription>{string}</objectDescription>
     <counterPostView>{integer}</counterPostView>
     <counterPostViewToday>{integer}</counterPostViewToday>
     <counterPostClick>{integer}</counterPostClick>
     <counterPostClickToday>{integer}</counterPostClickToday>
     <dateAdded>{date}</dateAdded>
    </row0>
</response>

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

rows

Количество элементов в дереве ответа.

rowN

Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе).

objectID

Уникальный идентификатор точки учета действия.

advertiserID
ID рекламодателя.
userID

Идентификатор.

objectName

Название точки учета.

weight

Вес точки учета.

categoryID

ID категории.

templateTypeID

ID типа шаблона.

Возможные значения:

  • 0 — стандартный;
  • 1 — POSIX.2.
objectReferrer

Шаблон URL для сравнения с адресом страницы сайта, полученным из запроса. Если адрес не подходит под шаблон URL, загрузка точки не будет засчитана.

counterPostView

Показания счетчика PostView за все время.

counterPostViewToday

Показания счетчика PostView за сегодня.

counterPostClick

Показания счетчика PostClick за все время.

counterPostClickToday

Показания счетчика PostClick за сегодня.

dateAdded

Дата добавления.

Пример запроса и ответа

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=tracingPoint

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <objectID>8309</objectID>
     <advertiserID>226201</advertiserID>
     <userID>5</userID>
     <objectName>точка5</objectName>
     <weight>2</weight>
     <categoryID>11564</categoryID>
     <templateTypeID>0</templateTypeID>
     <objectReferrer/>
     <objectDescription/>
     <counterPostView>0</counterPostView>
     <counterPostViewToday>0</counterPostViewToday>
     <counterPostClick>0</counterPostClick>
     <counterPostClickToday>0</counterPostClickToday>
     <dateAdded>2014-07-15</dateAdded>
    </row0>
</response>

Другие действия с объектом

См. также другие действия с объектом tracingPoint: