Documentation
API version 4 and Live 4
Methods
Disabled methods

GetClientInfo (Live)

Returns Yandex.Direct accounts.
Attention! 

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

When calling this method, error 59 is returned periodically.

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

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

New in the Live 4 version

Added the output parameters OverdraftSumAvailable
[no-highlight[

The overdraft limit, in Yandex units, that the client can use at the moment.

If the campaign operates in a real currency, the returned value is converted from the campaign‘s currency to Yandex units and mathematically rounded down to the second decimal place.

Use the PayCampaigns method to pay for campaigns by overdraft.

]no-highlight]
and Currency
[no-highlight[

The currency that the overdraft is in. This parameter was added for future use.

]no-highlight]
.
Added the output parameters ClientCurrencies
[no-highlight[

Array containing a client‘s currencies.

If the client is a direct advertiser or an agency client (the Client role):

  • If the client uses Yandex units, the parameter is not returned (omitted or NULL).
  • If the client uses a real currency, the array contains the only currency that the client can use for creating new campaigns.

If the client is an agency (the Agency role), the array contains the currencies available to the agency. The agency can register subclients in these currencies. Acceptable values: cu (Yandex units), RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

]no-highlight]
and VATRate
[no-highlight[

The VAT rate of the client who is making the payment, meaning the advertiser or agency. If the client is an agency, the agency‘s VAT is returned.

]no-highlight]
(also see the section Real currencies instead of Yandex units).
Added the SharedAccountEnabled
[no-highlight[

Whether the client has the shared account enabled — Yes/No.

]no-highlight]
output parameter.
Added the DisplayStoreRating
[no-highlight[

Show the store‘s rating in ads — Yes/No.

]no-highlight]
output parameter.
Added the OverdraftSumAvailableInCurrency
[no-highlight[

The overdraft limit that the client can use at the moment, shown in the client‘s currency.

The value in real currency does not include VAT.

]no-highlight]
output parameter.

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.

If a non-existent username is specified, error message 259 is returned.

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
[no-highlight[

The Yandex username.

]no-highlight]
": (string), "DateCreate
[no-highlight[

Date of user registration, YYYY-MM-DD.

]no-highlight]
": (date), "Phone
[no-highlight[

Contact phone number in any format. We recommend using international phone number format, for example: +7(495)137-33-33.

]no-highlight]
": (string), "FIO
[no-highlight[

Last name and initials.

]no-highlight]
": (string), "Email
[no-highlight[

The email address to send notifications and news to.

]no-highlight]
": (string), "StatusArch
[no-highlight[

The user‘s account is archived (inactive) — Yes/No.

]no-highlight]
": (string), "SharedAccountEnabled
[no-highlight[

Whether the client has the shared account enabled — Yes/No.

]no-highlight]
": (string), "Discount
[no-highlight[

Personal discount. Currently not used.

]no-highlight]
": (float), "OverdraftSumAvailable
[no-highlight[

The overdraft limit, in Yandex units, that the client can use at the moment.

If the campaign operates in a real currency, the returned value is converted from the campaign‘s currency to Yandex units and mathematically rounded down to the second decimal place.

Use the PayCampaigns method to pay for campaigns by overdraft.

]no-highlight]
": (float), "OverdraftSumAvailableInCurrency
[no-highlight[

The overdraft limit that the client can use at the moment, shown in the client‘s currency.

The value in real currency does not include VAT.

]no-highlight]
": (float), "Currency
[no-highlight[

The currency that the overdraft is in. This parameter was added for future use.

]no-highlight]
": (string), "ClientCurrencies
[no-highlight[

Array containing a client‘s currencies.

If the client is a direct advertiser or an agency client (the Client role):

  • If the client uses Yandex units, the parameter is not returned (omitted or NULL).
  • If the client uses a real currency, the array contains the only currency that the client can use for creating new campaigns.

If the client is an agency (the Agency role), the array contains the currencies available to the agency. The agency can register subclients in these currencies. Acceptable values: cu (Yandex units), RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

]no-highlight]
": [ (string) ... ], "VATRate
[no-highlight[

The VAT rate of the client who is making the payment, meaning the advertiser or agency. If the client is an agency, the agency‘s VAT is returned.

]no-highlight]
": (float), "SmsPhone
[no-highlight[

Phone number for sending SMS notifications to. Taken from the user‘s Yandex account.

]no-highlight]
": (string), "CampaignEmails
[no-highlight[

Array of email addresses for all the user‘s campaigns.

]no-highlight]
": [ (string) ... ], "ClientRights
[no-highlight[

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.

]no-highlight]
": [ { /* ClientRight */ "RightName
[no-highlight[

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.
]no-highlight]
": (string), "Value
[no-highlight[

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

]no-highlight]
": (string), } ... ], "Role
[no-highlight[

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.
]no-highlight]
": (string), "NonResident
[no-highlight[

Non-resident — Yes/No.

]no-highlight]
": (string), "SendNews
[no-highlight[

Send Yandex.Direct news — Yes/No.

]no-highlight]
": (string), "SendAccNews
[no-highlight[

Send status notifications for campaigns that have a personal Yandex manager — Yes/No.

]no-highlight]
": (string), "SendWarn
[no-highlight[

Send a notification when ads are moved to lower positions than desired — Yes/No.

]no-highlight]
": (string), "DisplayStoreRating
[no-highlight[

Show the store‘s rating in ads — Yes/No.

]no-highlight]
": (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.

SharedAccountEnabled Whether the client has the shared account enabled — Yes/No.
Discount

Personal discount. Currently not used.

OverdraftSumAvailable

The overdraft limit, in Yandex units, that the client can use at the moment.

If the campaign operates in a real currency, the returned value is converted from the campaign's currency to Yandex units and mathematically rounded down to the second decimal place.

Use the PayCampaigns
[no-highlight[

Paying for campaigns using an advertising agency‘s credit limit.

More PayCampaigns

]no-highlight]
method to pay for campaigns by overdraft.
OverdraftSumAvailableInCurrency

The overdraft limit that the client can use at the moment, shown in the client's currency.

The value in real currency does not include VAT.

Currency

The currency that the overdraft is in. This parameter was added for future use.

ClientCurrencies

Array containing a client's currencies.

If the client is a direct advertiser or an agency client (the Client role):

  • If the client uses Yandex units, the parameter is not returned (omitted or NULL).
  • If the client uses a real currency, the array contains the only currency that the client can use for creating new campaigns.

If the client is an agency (the Agency role), the array contains the currencies available to the agency. The agency can register subclients in these currencies. Acceptable values: cu (Yandex units), RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

VATRate The VAT rate of the client who is making the payment, meaning the advertiser or agency. If the client is an agency, the agency's VAT is returned.
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.

DisplayStoreRating Show the store's rating in ads — Yes/No.
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

['agrom','larry']
array('agrom','larry')