get

For an advertiser's representative, returns advertiser parameters and user settings; for an agency's representative, returns agency parameters and user settings.

  1. Request
  2. Response
Request on behalf of an advertiser's representative

Any representative of an advertiser can get the advertiser's parameters and their own personal settings.

The advertiser's chief representative can also get the settings of another representative. To do this, pass the representative's username in the Client-Login request header.

Request on behalf of an agency's representative

Any agency representative can also get the advertiser parameters for a client of the agency and the user settings for the advertiser's representative. To do this, pass the username of the advertiser's representative in the Client-Login request header.

Any agency representative can also get the agency parameters and their own personal settings.

The agency's chief representative can also get the settings of another agency representative. To do this, pass the representative's username in the Client-Login request header.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "FieldNames": [( "AccountQuality" | "Archived" | "ClientId" | "ClientInfo" | "CountryId" | "CreatedAt" | "Currency" | "Grants" | "Login" | "Notification" | "OverdraftSumAvailable" | "Phone" | "Representatives" | "Restrictions" | "Settings" | "Type" | "VatRate" )] /* required */
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
FieldNamesarray of ClientFieldEnum

The names of parameters to get.

Restriction. The response does not return the agency parameters AccountQuality, Currency, Grants, OverdraftSumAvailable, Restrictions, Settings.
Yes

Response

Note.

The Login, ClientInfo, CreatedAt, Notification, and Phone parameters belong to the representative, not to the advertiser or agency:

  • The user the request is made on behalf of, if the HTTP Client-Login header is not included in the request.

  • The user whose username is specified in the HTTP Client-Login header, if the request has the HTTP Client-Login header.

The other parameters are related to the advertiser or the agency, regardless of who the representative is.

Response structure in JSON format:

{
  "result": { /* result */
    "Clients": [{  /* ClientGetItem */
      "AccountQuality": (decimal), /* nillable */
      "Archived": ( "YES" | "NO" ),
      "ClientId": (long),
      "ClientInfo": (string),
      "CountryId": (int),
      "CreatedAt": (string),
      "Currency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" ),
      "Grants": [{  /* GrantGetItem */
        "Privilege": ( "EDIT_CAMPAIGNS" | "IMPORT_XLS" | "TRANSFER_MONEY" ), /* required */
        "Value": ( "YES" | "NO" ), /* required */
        "Agency": (string)
      }, ... ],
      "Login": (string),
      "Notification": {  /* NotificationGet */
        "Lang": ( "RU" | "UK" | "EN" | "TR" ), /* required */
        "SmsPhoneNumber": (string), /* required */
        "Email": (string), /* required */
        "EmailSubscriptions": [{  /* EmailSubscriptionItem */
          "Option": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ]
      },
      "OverdraftSumAvailable": (long),
      "Phone": (string),
      "Representatives": [{  /* Representative */
        "Login": (string), /* required */
        "Email": (string), /* required */
        "Role": ( "CHIEF" | "DELEGATE" | "LIMITED" | "UNKNOWN" ) /* required */
      }, ... ],
      "Restrictions": [{  /* ClientRestrictionItem */
        "Element": ( "CAMPAIGNS_TOTAL_PER_CLIENT" | "CAMPAIGNS_UNARCHIVED_PER_CLIENT" | "ADGROUPS_TOTAL_PER_CAMPAIGN" | "ADS_TOTAL_PER_ADGROUP" | "KEYWORDS_TOTAL_PER_ADGROUP" | "AD_EXTENSIONS_TOTAL" | "STAT_REPORTS_TOTAL_IN_QUEUE" | "FORECAST_REPORTS_TOTAL_IN_QUEUE" | "WORDSTAT_REPORTS_TOTAL_IN_QUEUE" | "API_POINTS" ), /* required */
        "Value": (int) /* required */
      }, ... ],
      "Settings": [{  /* ClientSettingGetItem */
        "Option": ( "CORRECT_TYPOS_AUTOMATICALLY" | "DISPLAY_STORE_RATING" | "SHARED_ACCOUNT_ENABLED" ), /* required */
        "Value": ( "YES" | "NO" ) /* required */
      }, ... ],
      "Type": (string),
      "VatRate": (decimal) /* nillable */
    }, ... ]
  }
}
ParameterTypeFor an advertiserFor an agency
Result structure (for JSON) / GetResponse (for SOAP)
Clientsarray of ClientGetItemAdvertiser parameters and user settings for the advertiser's representative.Agency parameters and user settings for the agency's representative.
ClientGetItem structure
AccountQualitydecimal, nillableIndicates the quality of the account (see the section Account quality index in the Help for Yandex.Direct).
ArchivedYesNoEnumIndicates that the advertiser is archived (inactive).Indicates that the agency is archived (inactive).
ClientIdlongAdvertiser ID.Agency ID.
ClientInfostring

First and last name of the Yandex.Direct user (no more than 255 characters).

First and last name of the Yandex.Direct user (no more than 255 characters).
CountryIdintID of the advertiser's country from the reference list of regions.

To get the list of regions, use the Dictionaries.get method.

ID of the agency's country from the reference list of regions.

To get the list of regions, use the Dictionaries.get method.

CreatedAtstring

Date the user was registered in Yandex.Direct, in the format YYYY-MM-DD.

Date the user was registered in Yandex.Direct, in the format YYYY-MM-DD.
CurrencyCurrencyEnum

The advertiser's currency.

To get the list of currencies, use the Dictionaries.get method.

Grantsarray of GrantGetItemThe advertiser's permissions for campaign management.
LoginstringUsername of the Yandex.Direct user.Username of the Yandex.Direct user.
NotificationNotificationGet

The Yandex.Direct user's settings for SMS and email notifications.

The Yandex.Direct user's settings for SMS and email notifications.
OverdraftSumAvailablelong

The overdraft limit currently available to the advertiser (see Payment deferral in the Help for Yandex.Direct).

Returned as an integer that represents the overdraft limit in the advertiser's currency, multiplied by 1,000,000.

PhonestringPhone number of the Yandex.Direct user (255 characters maximum).Phone number of the Yandex.Direct user (255 characters maximum).
Representativesarray of Representative

The advertiser's representatives (see Registering representatives in the Help for Yandex.Direct).

Returns all the representatives for the chief representative, or just the chief representative for a normal representative.

Agency representatives (see Managing agency representatives in the Help for Yandex.Direct).

For the chief representative, returns all the representatives; for all other representatives, returns just the chief representative.

Restrictionsarray of ClientRestrictionItemLimits on the number of objects for an advertiser.
Settingsarray of ClientSettingGetItemAdvertiser settings that only allow YES or NO values.
Typestring

Type of client:

  • CLIENT — Direct advertiser.

  • SUBCLIENT — An advertiser that is an agency client.

See Client (Client).

Type of client: AGENCY.
VatRatedecimal, nillableThe VAT rate of the client who is making the payment, meaning the advertiser or agency.The agency's VAT rate.
GrantGetItem structure
PrivilegePrivilegeEnum

Name of the permission:

ValueYesNoEnumWhether the client has this permission.
AgencystringThe name of the advertising agency, if the permission is granted by an agency.
NotificationGet structure
LangLangEnumLanguage for notifications.Language for notifications.
SmsPhoneNumberstringThe phone number for sending SMS notifications from the user's Yandex profile (see Mobile numbers in the Help for Yandex.Passport).The phone number for sending SMS notifications from the user's Yandex profile (see Mobile numbers in the Help for Yandex.Passport).
Emailstring

The email address for sending notifications related to the account (no more than 255 characters).

The email address for sending notifications related to the account (no more than 255 characters).
EmailSubscriptionsarray of EmailSubscriptionItemTypes of notifications to send by email.
EmailSubscriptionItem structure
OptionEmailSubscriptionEnum

Type of notification:

  • RECEIVE_RECOMMENDATIONS — Yandex.Direct news and recommendations.

  • TRACK_MANAGED_CAMPAIGNS — Notifications for campaigns that have a personal manager.

  • TRACK_POSITION_CHANGES — Warnings about traffic forecasts falling lower than the bid provided at the time of configuration.

ValueYesNoEnumWhether to send this type of notification.
Representative structure
LoginstringUsername.Username.
EmailstringEmail address to send notifications to.Email address to send notifications to.
RoleRepresentativeRoleEnum

The user's role:

  • CHIEF — Chief representative of the advertiser.
  • DELEGATE — Other representative of the advertiser.
  • UNKNOWN — This role isn't supported in this version of the API.

See Roles and access of Yandex.Direct users

The user's role:

  • CHIEF — Chief representative of the agency.
  • DELEGATE — Representative of the agency.
  • LIMITED — Representative of the agency who manages clients.
  • UNKNOWN — This role isn't supported in this version of the API.

See Roles and access of Yandex.Direct users

ClientRestrictionItem structure
ElementClientRestrictionEnum

Name of the restriction:

  • CAMPAIGNS_TOTAL_PER_CLIENT — The maximum number of campaigns per advertiser.

  • CAMPAIGNS_UNARCHIVED_PER_CLIENT — The maximum number of unarchived campaigns per advertiser.

  • ADGROUPS_TOTAL_PER_CAMPAIGN — The maximum number of groups per campaign.

  • ADS_TOTAL_PER_ADGROUP — The maximum number of ads per group.

  • KEYWORDS_TOTAL_PER_ADGROUP — The maximum number of keywords per group.

  • AD_EXTENSIONS_TOTAL — The maximum number of ad extensions per advertiser.

  • STAT_REPORTS_TOTAL_IN_QUEUE — The maximum number of statistical reports being generated simultaneously.

  • FORECAST_REPORTS_TOTAL_IN_QUEUE — The maximum number of budget forecast reports stored on the server.

  • WORDSTAT_REPORTS_TOTAL_IN_QUEUE — The maximum number of search query statistics reports stored on the server.

  • API_POINTS — The daily limit of points.

ValueintThe limit value.
ClientSettingGetItem structure
OptionClientSettingGetEnum

Setting name:

  • CORRECT_TYPOS_AUTOMATICALLY — Automatically fix errors and typos.

  • DISPLAY_STORE_RATING — Add data from external sources to the ad (see Data from third parties in the Help for Yandex.Direct).

  • SHARED_ACCOUNT_ENABLED — The shared account is enabled.

ValueYesNoEnumSetting value.