category

Получить информацию о ценообразовании на уровне категории. Только для продукта ADFOX.Nets.

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

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

Примечание. Доступна пагинация.
https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=adNetwork
 & action=pricing
 & actionObject=category
 & objectID=<integer>
 & actionObjectID=<integer>
Query-параметры
objectID *ID объекта, над которым производится действие.
actionObjectID *

ID категории.

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

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

<response>
  <status>
   <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <adNetworkID>{integer}</adNetworkID>
     <adNetworkName>{string}</adNetworkName>
     <categoryID>{integer}</categoryID>
     <categoryName>{string}</categoryName>
     <bannerTypeID>{integer}</bannerTypeID>
     <bannerTypeName>{string}</bannerTypeName>
     <parentID>{integer}</parentID>
     <parentName>{string}</parentName>
     <presentationTypeID>{integer}</presentationTypeID>
     <presentationTypeName>{string}</presentationTypeName>
     <width>{integer}</width>
     <height>{integer}</height>
     <CPMCost>{string}</CPMCost>
     <CPCCost>{string}</CPCCost>
     <CPECost>{string}</CPECost>
     <CPMPayout>{string}</CPMPayout>
     <CPCPayout>{string}</CPCPayout>
     <CPEPayout>{string}</CPEPayout>
     <revenueSharePercent>{integer}</revenueSharePercent>
     <isPredefined>{integer}</isPredefined>
    </row0>
</response>

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

code

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

rows

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

rowN

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

adNetworkID

ID рекламной сети.

adNetworkName

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

categoryID

ID категории.

categoryName

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

bannerTypeID

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

bannerTypeName

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

parentID

Идентификатор родительского объекта.

parentName

Название родительского объекта.

presentationTypeID

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

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

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

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

width

Ширина.

height

Высота.

CPMCost

Стоимость за 1000 показов.

CPCCost

Стоимость за переход.

CPECost

Стоимость за событие.

CPMPayout

Выплата за 1000 показов.

CPCPayout

Выплата за переход.

CPEPayout

Выплата за событие.

revenueSharePercent

Процент по revenue share.

isPredefined

Настройки переопределены на этом уровне и отменяют настройки уровня выше.

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

  • 0 — не переопределены. Наследуются настройки с уровня выше;
  • 1 — переопределены. Применяются настройки этого уровня.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=adNetwork&action=pricing&actionObject=category&objectID=34&actionObjectID=3

Ответ:

<response>
  <status>
   <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <adNetworkID>658</adNetworkID>
     <adNetworkName>Рекламная сеть 1</adNetworkName>
     <categoryID>11192</categoryID>
     <categoryName>Категория 1</categoryName>
     <bannerTypeID>32</bannerTypeID>
     <bannerTypeName>300x300</bannerTypeName>
     <parentID>32</parentID>
     <parentName>300x300</parentName>
     <presentationTypeID>0</presentationTypeID>
     <presentationTypeName>Стандартный</presentationTypeName>
     <width>300</width>
     <height>300</height>
     <CPMCost>33.00</CPMCost>
     <CPCCost>33.00</CPCCost>
     <CPECost>0.00</CPECost>
     <CPMPayout>0.00</CPMPayout>
     <CPCPayout>0.00</CPCPayout>
     <CPEPayout>0.00</CPEPayout>
     <revenueSharePercent>0</revenueSharePercent>
     <isPredefined>1</isPredefined>
    </row0>
</response>

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

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