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