GetSubClients

Возвращает список субклиентов указанного пользователя.

Внимание.

Метод устарел и скоро будет отключен. Используйте API версии 5.

При вызове метода периодически выдается ошибка 59.

Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.

Для рекламного агентства возвращается список клиентов и представителей. Для прямого рекламодателя возвращается список представителей.

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "GetSubClients",
   "param": {
      /* GetSubClientsRequest */
      "Login": (string),
      "Filter": {
         /* ClientFilter */
         "StatusArch": (string)
      }
   }
}

Ниже приведено описание параметров.

Параметр Описание Требуется
Объект GetSubClientsRequest
Login

Логин пользователя Яндекса, для которого запрашивается список субклиентов.

да
Filter Объект ClientFilter, задающий условия отбора субклиентов. нет
Объект ClientFilter
StatusArch Значение Yes — отобрать субклиентов, учетные записи которых помещены в архив. Значение No — отобрать активных субклиентов. да

Результирующие данные

Возвращается массив объектов ShortClientInfo с данными о субклиентах. Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* ShortClientInfo */
         "Login": (string),
         "FIO": (string),
         "Role": (string)
      }
      ...
   ]
}

Ниже приведено описание параметров.

Объект ShortClientInfo
Login

Логин пользователя на Яндексе.

FIO

Фамилия и инициалы.

Role

Роль субклиента:

  • UnlimitedRepClient — представитель прямого рекламодателя.
  • UnlimitedRepAgency — представитель агентства, который может управлять рекламными кампаниями любых клиентов;
  • LimitedRepAgency — представитель агентства, который может управлять рекламными кампаниями определенных клиентов (список клиентов определяет главный представитель в веб-интерфейсе);
  • ChiefRepSubClient — клиент агентства.

Примеры входных данных

Python

{
   'Login': 'agrom',
   'Filter': {
      'StatusArch': 'No'
   },
}

PHP

array(
   'Login' => 'agrom',
   'Filter' => array(
      'StatusArch' => 'No'
   ),
)

Perl

{
   'Login' => 'agrom',
   'Filter' => {
      'StatusArch' => 'No'
   },
}