get

Returns a list of advertisers who are agency clients, their parameters, and settings for each advertiser's chief representative.

  1. Request
  2. Response
Note. For requests to the AgencyClients service:
  • In the Authorization header, specify the access token you received for the agency representative.
  • Don't specify the Client-Login header.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* AgencyClientsSelectionCriteria */
      "Logins": [(string), ... ],
      "Archived": ( "YES" | "NO" )
    }, /* required */   
    "FieldNames": [( "AccountQuality" | "Archived" | "ClientId" | "ClientInfo" | "CountryId" | "CreatedAt" | "Currency" | "Grants" | "Login" | "Notification" | "OverdraftSumAvailable" | "Phone" | "Representatives" | "Restrictions" | "Settings" | "Type" | "VatRate" )], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaAgencyClientsSelectionCriteria

Client selection criteria.

To get parameters for all of the agency's clients, specify an empty SelectionCriteria structure.

Yes
FieldNamesarray of AgencyClientFieldEnum

The names of parameters to get.

Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
AgencyClientsSelectionCriteria structure
Loginsarray of stringSelects clients with the specified representative usernames. Maximum of 10,000 items in the array.No
ArchivedYesNoEnumSelects clients based on whether they are archived: YES – archived clients; NO – active clients.No

Response

Note.
  • The Login, ClientInfo, CreatedAt, Notification, and Phone parameters belong to the advertiser's chief representative (see Roles and access of Yandex.Direct users). The other parameters relate to the advertiser.

  • If the Logins parameter in the request specifies the username of a representative other than the chief representative, the response contains the username of the advertiser's chief representative instead of the username from the request.

  • If the Logins parameter in the request specifies multiple representative usernames for the same advertiser, this advertiser (and chief representative) is only listed once in the response.

  • All the advertiser's representatives are listed in the Representatives parameter.

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 */
        }, ... ] /* required */
      },
      "OverdraftSumAvailable": (long),
      "Phone": (string),
      "Representatives": [{  /* Representative */
        "Login": (string), /* required */
        "Email": (string), /* required */
        "Role": ( "CHIEF" | "DELEGATE" | "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" ), /* 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 */
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
Clientsarray of ClientGetItemAdvertisers – agency clients and their chief representatives.
LimitedBylongSequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
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).
ClientIdlongAdvertiser ID.
ClientInfostring

Client name (maximum of 255 characters).

CountryIdint

ID of the advertiser'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.

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.
Loginstring

Username of the Yandex.Direct user.

NotificationNotificationGet

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.

Phonestring

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

Representativesarray of Representative

Representatives of the advertiser.

See Roles and access of Yandex.Direct users

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

Client type: SUBCLIENT.

VatRatedecimal, nillableThe 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.
SmsPhoneNumberstringThe 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).

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.
EmailstringEmail 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

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.

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.