GetClientsList
Возвращает учетные записи всех клиентов рекламного агентства.
Для метода существует версия GetClientsList (Live).
Метод доступен только рекламным агентствам и не доступен прямым рекламодателям.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetClientsList",
"param": {
/* ClientInfoRequest */
"Filter": {
/* ClientFilter */
"StatusArch": (string)
}
}
}
В параметре param
указывают условия отбора клиентов, описанные ниже. Вызов без param
возвращает данные всех клиентов.
Параметр |
Описание |
Требуется |
Объект ClientInfoRequest |
||
|
Содержит объект |
Нет |
Объект ClientFilter |
||
|
Значение Yes — отобрать пользователей, учетные записи которых помещены в архив. Значение No — отобрать только активных пользователей. |
Нет |
Результирующие данные
Ниже показана структура результирующих данных в формате JSON.
{
"data": [
{ /* ClientInfo */
"Login": (string),
"DateCreate": (date),
"Phone": (string),
"FIO": (string),
"Email": (string),
"StatusArch": (string),
"Discount": (float),
"SmsPhone": (string),
"CampaignEmails": [
(string)
...
],
"ClientRights": [
{ /* ClientRight */
"RightName": (string),
"Value": (string),
}
...
],
"Role": (string),
"NonResident": (string),
"SendNews": (string),
"SendAccNews": (string),
"SendWarn": (string),
}
...
]
}
Ниже приведено описание параметров.
Параметр |
Описание |
Объект ClientInfo |
|
|
Логин пользователя на Яндексе. |
|
Контактный телефон в произвольном формате. Рекомендуется указывать номер в международном формате, например |
|
Дата регистрации пользователя, |
|
Фамилия и инициалы. |
|
Адрес электронной почты для отправки новостей и уведомлений. |
|
Учетная запись пользователя помещена в архив (не активна) — Yes/No. |
|
Персональная скидка. В настоящее время не применяется. |
|
Телефонный номер для отправки sms-уведомлений. Берется из учетной записи пользователя в Яндексе. |
|
Массив адресов электронной почты всех кампаний пользователя. |
|
Роль в Яндекс Директе:
|
|
Нерезидент — Yes/No. |
|
Сообщать о новостях Яндекс Директа — Yes/No. |
|
Сообщать о состоянии кампаний, обслуживаемых персональным менеджером в Яндексе, — Yes/No. |
|
Сообщать о перемещении объявлений на более низкие позиции относительно желаемых — Yes/No. |
|
Массив объектов Параметр доступен только для рекламных агентств. |
Объект ClientRight |
|
|
Название полномочий, которые предоставляются или отменяются:
|
|
Значение Yes — предоставить указанные полномочия, значение No — отменить. |
Примеры входных данных
Python
{
'Filter': {
'StatusArch': 'No'
}
}
PHP
array(
'Filter' => array(
'StatusArch' ='No'
)
)
Perl
{
'Filter' ={
'StatusArch' ='No'
}
}