advertiser

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

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

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

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

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

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

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

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
 <data>
  <row0>
   <ID>{integer}</ID>
   <account>{string}</account>
   <company>{string}</company>
   <firstName>{string}</firstName>
   <lastName>{string}</lastName>
   <eMail>{string}</eMail>
   <country>{string}</country>
   <state/>
   <city>{string}</city>
   <ZIPCode>{string}</ZIPCode>
   <address1>{string}</address1>
   <address2>{string}</address2>
   <phone>{string}</phone>
   <fax/>
   <dateAdded>{string}</dateAdded>
   <isByAssistantCreated>{integer}</isByAssistantCreated>
  </row0>
 </data>
</result>
</response>

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

code

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

rows

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

rowN

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

ID

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

account
Учетная запись рекламодателя.
company

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

firstName

Имя рекламодателя.

eMail

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

country

Страна.

state

Регион.

city

Город.

ZIPCode

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

address1

Адрес.

address2

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

phone

Телефон.

fax

Факс.

dateAdded

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

isByAssistantCreated

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

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

Запрос:

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

Ответ:

<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>
   <isByAssistantCreated>0</isByAssistantCreated>
  </row0>
 </data>
</result>
</response>

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

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