assistant

Получить список пользователей с типом «ассистент».

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

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

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

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

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

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
    <ID>{integer}</ID>
    <account>{string}</account>
    <company>{string}</company>
    <firstName>{string}</firstName>
    <lastName>{string}</lastName>
    <eMail>{string}</eMail>
    <country>{string}</country>
    <state>{string}</state>
    <city>{string}</city>
    <ZIPCode>{string}</ZIPCode>
    <address1>{string}</address1>
    <address2>{string}</address2>
    <phone>{string}</phone>
    <fax>{string}</fax>
    <dateAdded>{string}</dateAdded>
     <modules>
      <isViewOwnCampaigns>{integer}</isViewOwnCampaigns>
      <isCreateOwnCampaigns>{integer}</isCreateOwnCampaigns>
      <isModifyOwnCampaigns>{integer}</isModifyOwnCampaigns>
      <isAdvertisers>{integer}</isAdvertisers>
      <isViewAllCampaigns>{integer}</isViewAllCampaigns>
      <isModifyAllCampaigns>{integer}</isModifyAllCampaigns>
      <isModifyWebsites>{integer}</isModifyWebsites>
      <isWebsites>{integer}</isWebsites>
      <isPlacementPrices>{integer}</isPlacementPrices>
      <isHideInformation>{integer}</isHideInformation>
      <isCommonReports>{integer}</isCommonReports>
      <isExtendedReports>{integer}</isExtendedReports>
      <isFinancialReports>{integer}</isFinancialReports>
     </modules>
    </row0>
</response>

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

code

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

rows

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

rowN

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

ID

Уникальный идентификатор пользователя с типом «ассистент».

account
Учетная запись ассистента.
company

Название компании.

firstName

Имя ассистента.

eMail

Адрес электронной почты, на которую зарегистрирован доступ ассистента.

country

Страна.

state

Регион.

city

Город.

ZIPCode

Почтовый индекс.

address1

Адрес.

address2

Адрес (дополнение).

phone

Телефон.

fax

Факс.

dateAdded

Дата добавления пользователя с типом «ассистент».

modules

Настройка прав доступа.

isViewOwnCampaigns

Просмотр приписанных к ассистенту кампаний.

isCreateOwnCampaigns

Создание приписанных к ассистенту кампаний.

isModifyOwnCampaigns

Управление приписанными к ассистенту кампаниями.

isAdvertisers

Создание собственных рекламодателей.

isViewAllCampaigns

Просмотр всех кампаний.

isModifyAllCampaigns

Управление всеми кампаниями.

isModifyWebsites

Управление всеми сайтами.

isWebsites

Просмотр всех сайтов.

isPlacementPrices

Просмотр цен на размещение.

isHideInformation

Скрыть приоритеты кампаний.

isCommonReports

Просмотр общих отчетов.

isExtendedReports

Просмотр отчетов для планирования.

isFinancialReports

Доступ к отчетам «управление/бухгалтерия».

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

Запрос:

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

Ответ:

<response>
<status>
  <code>0</code>
</status>
<result>
 <data>
  <row0>
   <ID>203478</ID>
   <account>ivanov</account>
   <company>ООО Example</company>
   <firstName>Иван</firstName>
   <lastName>Иванов</lastName>
   <eMail>ivanov@yandex.ru</eMail>
   <country>Российская Федерация</country>
   <state/>
   <city>Москва</city>
   <ZIPCode>123456</ZIPCode>
   <address1>ул. Строителей, д. 3</address1>
   <address2>оф. 305</address2>
   <phone>+7 (495) 555-55-55</phone>
   <fax/>
   <dateAdded>0000-00-00</dateAdded>
   <modules>
    <isViewOwnCampaigns>0</isViewOwnCampaigns>
    <isCreateOwnCampaigns>0</isCreateOwnCampaigns>
    <isModifyOwnCampaigns>0</isModifyOwnCampaigns>
    <isAdvertisers>0</isAdvertisers>
    <isViewAllCampaigns>0</isViewAllCampaigns>
    <isModifyAllCampaigns>0</isModifyAllCampaigns>
    <isModifyWebsites>0</isModifyWebsites>
    <isWebsites>0</isWebsites>
    <isPlacementPrices>0</isPlacementPrices>
    <isHideInformation>0</isHideInformation>
    <isCommonReports>0</isCommonReports>
    <isExtendedReports>0</isExtendedReports>
    <isFinancialReports>0</isFinancialReports>
   </modules>
  </row0>
 </data>
</result>
</response>

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

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