GetSubClients

Returns a list of subclients of the specified user.

Attention.

This method is outdated and will soon be disabled. Use version 5 of the API.

For information about the compatibility of methods between versions 4 and 5, see the Migration guide.

For an advertising agency, returns a list of clients and delegates. For a direct advertiser, returns a list of delegates.

Input data

The input data structure in JSON is shown below.

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

Parameters are described below.

Parameter Description Required
GetSubClientsRequest object
Login

Username of the Yandex user that the list of subclients is requested for.

yes
Filter The ClientFilter object, which sets conditions for filtering subclients. no
ClientFilter object
StatusArch Yes — Select only subclients whose accounts are archived. No — Select only active subclients. yes

Output data

Returns an array of ShortClientInfo objects with data for associated subclients. The output data structure in JSON is shown below.

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

Parameters are described below.

ShortClientInfo object
Login

The Yandex username.

FIO

Last name and initials.

Role

Subclient's role:

  • UnlimitedRepClient — Representative of a direct advertiser.
  • UnlimitedRepAgency — Agency delegate who can manage advertising campaigns for any clients.
  • LimitedRepAgency — Agency delegate who can manage the advertising campaigns of specific clients (the chief representative defines the list of clients in the web interface).
  • ChiefRepSubClient — Agency client.

Examples of input data

Python

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

PHP

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

Perl

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