GetClientsList
Returns the accounts of all clients of the advertising agency.
Disabled method. Use version 5 of the API.
For information about the compatibility of methods between versions 4 and 5, see the Migration guide.
The GetClientsList (Live) version also exists for this method.
This method is available only to advertising agencies, not to direct advertisers.
Input data
The input data structure in JSON is shown below.
{
"method": "GetClientsList",
"param": {
/* ClientInfoRequest */
"Filter": {
/* ClientFilter */
"StatusArch": (string)
}
}
}
The param parameter is used for specifying the conditions for filtering clients, as described below. A call without param returns data for all clients.
Parameter | Description | Required |
ClientInfoRequest object | ||
---|---|---|
Filter | Contains the ClientFilter object that sets user filter conditions. | No |
ClientFilter object | ||
StatusArch | Yes — Select only users whose accounts are archived. No — Select only active users. | No |
Parameter | Description | Required |
ClientInfoRequest object | ||
---|---|---|
Filter | Contains the ClientFilter object that sets user filter conditions. | No |
ClientFilter object | ||
StatusArch | Yes — Select only users whose accounts are archived. No — Select only active users. | No |
Output data
The output data structure in JSON is shown below.
{
"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),
}
...
]
}
Parameters are described below.
Parameter | Description |
ClientInfo object | |
---|---|
Login | The Yandex username. |
Phone | Contact phone number in any format. We recommend using international phone number format, for example: |
DateCreate | Date of user registration, |
FIO | Last name and initials. |
Email | The email address to send notifications and news to. |
StatusArch | The user's account is archived (inactive) — Yes/No. |
Discount | Personal discount. Currently not used. |
SmsPhone | Phone number for sending SMS notifications to. Taken from the user's Yandex account. |
CampaignEmails | Array of email addresses for all the user's campaigns. |
Role | Role in Yandex Direct:
|
NonResident | Non-resident — Yes/No. |
SendNews | Send Yandex Direct news — Yes/No. |
SendAccNews | Send status notifications for campaigns that have a personal Yandex manager — Yes/No. |
SendWarn | Send a notification when ads are moved to lower positions than desired — Yes/No. |
ClientRights | Array of ClientRight objects. They define the rights of an advertising agency's client for managing campaigns that the agency created for this client. This parameter is only available to advertising agencies. |
ClientRight object | |
RightName | Name of the permission that is being granted or revoked:
|
Value | Yes indicates granting the specified rights, and No indicates revoking them. |
Parameter | Description |
ClientInfo object | |
---|---|
Login | The Yandex username. |
Phone | Contact phone number in any format. We recommend using international phone number format, for example: |
DateCreate | Date of user registration, |
FIO | Last name and initials. |
Email | The email address to send notifications and news to. |
StatusArch | The user's account is archived (inactive) — Yes/No. |
Discount | Personal discount. Currently not used. |
SmsPhone | Phone number for sending SMS notifications to. Taken from the user's Yandex account. |
CampaignEmails | Array of email addresses for all the user's campaigns. |
Role | Role in Yandex Direct:
|
NonResident | Non-resident — Yes/No. |
SendNews | Send Yandex Direct news — Yes/No. |
SendAccNews | Send status notifications for campaigns that have a personal Yandex manager — Yes/No. |
SendWarn | Send a notification when ads are moved to lower positions than desired — Yes/No. |
ClientRights | Array of ClientRight objects. They define the rights of an advertising agency's client for managing campaigns that the agency created for this client. This parameter is only available to advertising agencies. |
ClientRight object | |
RightName | Name of the permission that is being granted or revoked:
|
Value | Yes indicates granting the specified rights, and No indicates revoking them. |
Examples of input data
Python
{
'Filter': {
'StatusArch': 'No'
}
}
PHP
array(
'Filter' => array(
'StatusArch' => 'No'
)
)
Perl
{
'Filter' => {
'StatusArch' => 'No'
}
}