website

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

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

Примечание

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

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

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>
    <isReferrerByURL>{integer}</isReferrerByURL>
    <templateTypeID>{integer}</templateTypeID>
    <template>{string}</template>
    <dateAdded>{date}</dateAdded>
    <sendToErir>{integer}</sendToErir>
    <platformName>{string}</platformName>
    <platformType>{integer}</platformType>
    <contractorID>{integer}</contractorID>
    <url>{string}</url>
    <isMobileApp>{integer}</isMobileApp>
  </row>
</result>
</data>
</response>

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

code

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

rows

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

rowN

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

ID

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

name

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

webmasterID

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

webmasterAccount

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

categoryID

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

categoryName

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

loadsToday

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

impressionsToday

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

impressionsDefaultToday

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

clicksToday

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

CTRToday

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

templateTypeID

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

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

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

template

Шаблон referer.

dateAdded

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

platformName

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

sendToErir

Передавать данные в ЕРИР.

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

  • 0 — не передавать данные в ЕРИР;
  • 1 — передавать данные в ЕРИР (маркировка включена).

platformType

Тип площадки.

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

  • 0 — приложение;
  • 1 — сайт;
  • 2 — информационная система.

contractorID

ID контрагента.

url

Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения.

isMobileApp

Площадка является приложением с мобильной медиацией.

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

  • 0 — нет;
  • 1 — да.

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

Запрос:

https://adfox.yandex.ru/api/v1?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/>
    <webmaster>
    <adNetworkID/>
    <adNetworkName/>
    <categoryID/>
    <categoryName/>
    <loadsToday>0</loadsToday>
    <impressionsToday>0</impressionsToday>
    <impressionsDefaultToday>0</impressionsDefaultToday>
    <clicksToday>0</clicksToday>
    <CTRToday>0.0000</CTRToday>
    <isReferrerByURL>0</isReferrerByURL>
    <templateTypeID>0</templateTypeID>
    <template/>
    <dateAdded>2021-11-27</dateAdded>
    <sendToErir>1</sendToErir>
    <platformName>Сайт</platformName>
    <platformType>1</platformType>
    <contractorID>0</contractorID>
    <url>https://url.ru</url>
    <isMobileApp>1</isMobileApp>
  </row0>
</result>
</data>
</response>

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

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

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