get

Возвращает список рекламодателей — клиентов агентства, их параметры и настройки главных представителей рекламодателя.

  1. Запрос
  2. Ответ
Примечание. В запросе к сервису AgencyClients:
  • В HTTP-заголовке Authorization укажите токен, полученный для представителя агентства.
  • HTTP-заголовок Client-Login не указывайте.

Запрос

Структура запроса в формате JSON:

{
  "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)
    }
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria AgencyClientsSelectionCriteria

Критерии отбора клиентов.

Чтобы получить параметры всех клиентов агентства, необходимо указать пустую структуру SelectionCriteria.

Да
FieldNames array of AgencyClientFieldEnum

Имена параметров, которые требуется получить.

Да
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура AgencyClientsSelectionCriteria
Logins array of string Отбирать клиентов с указанными логинами представителей. Не более 10 000 элементов в массиве. Нет
Archived YesNoEnum Отбирать клиентов по признаку нахождения в архиве: YES — архивные клиенты, NO — активные клиенты. Нет

Ответ

Примечание.
  • Параметры Login, ClientInfo, CreatedAt, Notification, Phone относятся к главному представителю рекламодателя (см. раздел Роли и доступы пользователей Директа). Остальные параметры относятся к рекламодателю.

  • Если в запросе в параметре Logins указан логин представителя рекламодателя, который не является главным представителем, то ответ будет содержать логин главного представителя, отличающийся от логина в запросе.

  • Если в запросе в параметре Logins указано несколько логинов представителей одного рекламодателя, рекламодатель (и его главный представитель) будет присутствовать в ответе только один раз.

  • Список всех представителей рекламодателя представлен в параметре ответа Representatives.

Структура ответа в формате JSON:

{
  "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" | "YND_FIXED" ),
      "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)
  }
}
Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
Clients array of ClientGetItem Рекламодатели — клиенты агентства и их главные представители.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура ClientGetItem
AccountQuality decimal, nillable Показатель качества аккаунта (см. раздел Показатель качества аккаунта помощи Директа).
Archived YesNoEnum Признак того, что рекламодатель помещен в архив (не активен).
ClientId long Идентификатор рекламодателя.
ClientInfo string

Название клиента (до 255 символов).

CountryId int

Идентификатор страны рекламодателя из справочника регионов.

Справочник регионов можно получить с помощью метода Dictionaries.get.

CreatedAt string

Дата регистрации пользователя в Директе, в формате YYYY-MM-DD.

Currency CurrencyEnum

Валюта рекламодателя.

Справочник валют можно получить с помощью метода Dictionaries.get.

Grants array of GrantGetItem Полномочия рекламодателя по управлению кампаниями.
Login string

Логин пользователя Директа.

Notification NotificationGet

Настройки SMS- и email-уведомлений пользователя Директа.

OverdraftSumAvailable long

Лимит овердрафта, которым рекламодатель может воспользоваться в текущий момент времени (см. раздел Отсрочка платежа помощи Директа).

Возвращается в виде целого числа, которое представляет собой лимит овердрафта в валюте рекламодателя, умноженный на 1 000 000.

Phone string

Номер телефона пользователя Директа (до 255 символов).

Representatives array of Representative

Представители рекламодателя.

См. Роли и доступы пользователей Директа.

Restrictions array of ClientRestrictionItem Количественные ограничения на объекты рекламодателя.
Settings array of ClientSettingGetItem Настройки рекламодателя, допускающие только значения YES или NO.
Type string

Тип клиента: SUBCLIENT.

VatRate decimal, nillable Ставка НДС агентства.
Структура GrantGetItem
Privilege PrivilegeEnum

Имя полномочия:

Value YesNoEnum Есть ли у клиента данное полномочие.
Agency string Название рекламного агентства, если полномочие предоставлено агентством.
Структура NotificationGet
Lang LangEnum Язык уведомлений.
SmsPhoneNumber string Телефонный номер для отправки SMS-уведомлений из профиля пользователя на Яндексе (см. раздел Мои телефоны помощи Яндекс.Паспорта).
Email string

Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 255 символов).

EmailSubscriptions array of EmailSubscriptionItem Типы уведомлений, отправляемых по электронной почте.
Структура EmailSubscriptionItem
Option EmailSubscriptionEnum

Тип уведомления:

  • RECEIVE_RECOMMENDATIONS — новости Директа и рекомендации.

  • TRACK_MANAGED_CAMPAIGNS — уведомления по кампаниям, обслуживаемым персональным менеджером.

  • TRACK_POSITION_CHANGES — предупреждения о снижении прогноза трафика относительно того, который обеспечивали ставки на момент установки.

Value YesNoEnum Отправлять ли уведомления данного типа.
Структура Representative
Login string Логин пользователя.
Email string Адрес электронной почты для отправки уведомлений.
Role RepresentativeRoleEnum

Роль пользователя:

  • CHIEF — главный представитель рекламодателя.
  • DELEGATE — обычный представитель рекламодателя.
  • UNKNOWN — роль не поддерживается в данной версии API.

См. Роли и доступы пользователей Директа.

Структура ClientRestrictionItem
Element ClientRestrictionEnum

Имя ограничения:

  • 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 — максимальное количество хранимых на сервере отчетов о статистике поисковых запросов.

Value int Значение ограничения.
Структура ClientSettingGetItem
Option ClientSettingGetEnum

Имя настройки:

  • CORRECT_TYPOS_AUTOMATICALLY — автоматически исправлять ошибки и опечатки.

  • DISPLAY_STORE_RATING — дополнять объявления данными из внешних источников (см. раздел Данные из внешних источников помощи Директа).

  • SHARED_ACCOUNT_ENABLED — подключен общий счет.

Value YesNoEnum Значение настройки.