website

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

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

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

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

Чтобы получить данные только по одному сайту, укажите его идентификатор.

Значение по умолчанию: 0 — выводить список всех сайтов.

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <URL>{string}</URL>
     <isActive>{integer}</isActive>
     <webmasterID>{integer}</webmasterID>
     <webmasterAccount>{string}</webmasterAccount>
     <adNetworkID>{integer}</adNetworkID>
     <adNetworkName>{string}</adNetworkName>
     <categoryID>{integer}</categoryID>
     <categoryName>{string}</categoryName>
     <loadsToday>{integer}</loadsToday>
     <impressionsToday>{integer}</impressionsToday>
     <impressionsDefaultToday>{integer}</impressionsDefaultToday>
     <clicksToday>{integer}</clicksToday>
     <CTRToday>{integer}</CTRToday>
     <isBannersExchange>{integer}</isBannersExchange>
     <isReferrerByURL>{integer}</isReferrerByURL>
     <templateTypeID>{integer}</templateTypeID>
     <template>{string}</template>
     <dateAdded>{date}</dateAdded>
    </row0>
</response>

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

code

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

rows

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

rowN

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

ID

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

name
Название сайта.
URL

URL сайта.

Только для продукта ADFOX.Nets.

isActive

Активность сайта.

Только для продукта ADFOX.Nets.

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

  • 0 — неактивен;
  • 1 — активен.
webmasterID

ID владельца сайта.

webmasterAccount

Логин владельца сайта.

adNetworkID

ID рекламной сети, к которой принадлежит сайт.

Только для продукта ADFOX.Nets.

adNetworkName

Название рекламной сети, к которой принадлежит сайт.

Только для продукта ADFOX.Nets.

categoryID

ID категории, присвоенной сайту.

categoryName

Название категории, присвоенной сайту.

loadsToday

Показания счетчиков. Запросы кода сегодня.

impressionsToday

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

impressionsDefaultToday

Показания счетчиков. Загрузки по умолчанию сегодня.

clicksToday

Показания счетчиков. Клики сегодня.

CTRToday

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

isBannersExchange

Участвует в баннерообмене.

Только для продукта ADFOX.Exchange.

isReferrerByURL

Шаблон referrer по URL.

Только для продукта ADFOX.Nets.

templateTypeID
Тип шаблона referrer. Только для продукта ADFOX.Nets.
template

Шаблон referrer.

dateAdded

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

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

Запрос:

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

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>27185</ID>
     <name>сайт</name>
     <URL/>
     <isActive>1</isActive>
     <webmasterID/>
     <webmasterAccount/>
     <adNetworkID/>
     <adNetworkName/>
     <categoryID/>
     <categoryName/>
     <loadsToday>0</loadsToday>
     <impressionsToday>0</impressionsToday>
     <impressionsDefaultToday>0</impressionsDefaultToday>
     <clicksToday>0</clicksToday>
     <CTRToday>0.0000</CTRToday>
     <isBannersExchange>0</isBannersExchange>
     <isReferrerByURL>0</isReferrerByURL>
     <templateTypeID>0</templateTypeID>
     <template/>
     <dateAdded>2013-11-27</dateAdded>
    </row0>
</response>

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

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