category

Получить список категорий.

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

Примечание

Доступна пагинация.

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=category
  & [actionObjectID=<integer>]
  & [type=<integer>]

actionObjectID

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

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

type

Фильтр по типу категории.

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

  • 0 — постоянные категории;
  • 1 — временные категории.

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>     
     <type>{integer}</type>
     <timeout>{integer}</timeout>
    </row0>
</response>

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

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

row0

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

ID

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

name

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

type

Тип категории.

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

  • 0 — постоянная категория;
  • 1 — временная категория.

timeout

Активность категории в днях.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=category

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>11419</ID>
     <name>example</name>
     <type>1</type>
     <timeout>23</timeout>
    </row0>
</response>

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

Читайте также о других действиях с объектом category:

Предыдущая
campaign
Следующая
contract
В этой статье: