GetClientInfo

Returns Yandex Direct accounts.

Attention.

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 GetClientInfo (Live) version also exists for this method.

Direct advertisers can get their accounts and the accounts of their delegates. Advertising agencies can also get their clients' accounts.

Input data

The input data structure in JSON is shown below.

{
   "method": "GetClientInfo",
   "param": [
      (string)
      ...
   ]
}

The param array contains the usernames of Yandex Direct accounts (the same as the Yandex usernames). A maximum of 1000 usernames can be specified.

Calling without param returns data for the user that the request was made on behalf of.

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: +7(495)137-33-33.

DateCreate

Date of user registration, YYYY-MM-DD.

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:

  • Client — The client of an advertising agency, or a direct advertiser, or the representative of a direct advertiser.
  • Agency — An advertising agency or representative of an agency.
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:

  • AllowEditCampaigns — allow making changes to campaign parameters.
  • AllowTransferMoney — allow transferring funds between campaigns.
  • AllowImportXLS — allow downloading data from MS Excel files.
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: +7(495)137-33-33.

DateCreate

Date of user registration, YYYY-MM-DD.

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:

  • Client — The client of an advertising agency, or a direct advertiser, or the representative of a direct advertiser.
  • Agency — An advertising agency or representative of an agency.
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:

  • AllowEditCampaigns — allow making changes to campaign parameters.
  • AllowTransferMoney — allow transferring funds between campaigns.
  • AllowImportXLS — allow downloading data from MS Excel files.
Value

Yes indicates granting the specified rights, and No indicates revoking them.

Examples of input data

Perl

['agrom','agrom']

PHP

array('agrom','agrom')