place

Получить список площадок.

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

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

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

Укажите идентификатор площадки, если требуется получить данные только по одной площадке.

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

actionObjectID2

Фильтр по ID сайта.

См. также:

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <positionID>{integer}</positionID>
     <positionName>{string}</positionName>
     <zoneID>{integer}</zoneID>
     <zoneName>{string}</zoneName>
     <siteID>{integer}</siteID>
     <siteName>{string}</siteName>
     <categoryID>{integer}</categoryID>
     <categoryName>{string}</categoryName>
     <bannerTypeID>{integer}</bannerTypeID>
     <bannerTypeName>{string}</bannerTypeName>
     <presentationTypeID>{integer}</presentationTypeID>
     <presentationTypeName>{string}</presentationTypeName>
     <dateAdded>{date}</dateAdded>
    </row0>
</response>

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

code

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

row0

Элемент списка с соответствующим номером.

ID

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

name
Название площадки.
positionID

ID расположения.

positionName

Название расположения.

zoneID

ID раздела сайта, в котором находится площадка.

zoneName

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

siteID

ID сайта, в котором находится площадка.

siteName

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

categoryID

ID категории площадки.

categoryName

Название категории.

bannerTypeID

ID типа баннера.

bannerTypeName

Название типа баннера.

presentationTypeID

Идентификатор типа представления — указания для сервера, в каком виде производить выгрузку баннеров на сайт.

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

  • 0 — стандартный. Код баннера будет выгружен как HTML-код в iframe с заданными размерами.
  • 4 — безразмерный. Код баннера будет выгружен как JavaScript-код.
  • 5 — XML. Код баннера будет выгружен как XML-код.
presentationTypeName

Название типа представления для типа баннера.

dateAdded

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

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

Запрос:

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

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>667290</ID>
     <name>площадка1</name>
     <positionID>6</positionID>
     <positionName><верх страницы></positionName>
     <zoneID>60119</zoneID>
     <zoneName>раздел1</zoneName>
     <siteID>27185</siteID>
     <siteName>сайт</siteName>
     <categoryID>0</categoryID>
     <categoryName/>
     <bannerTypeID>17</bannerTypeID>
     <bannerTypeName>600x90</bannerTypeName>
     <presentationTypeID>0</presentationTypeID>
     <presentationTypeName>Стандартный</presentationTypeName>
     <dateAdded>2013-11-27</dateAdded>
    </row0>
</response>

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

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