get

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

  1. Запрос
  2. Ответ
Запрос от имени представителя рекламодателя

Любой представитель рекламодателя может получать параметры рекламодателя и собственные настройки.

Главный представитель рекламодателя может также получать настройки другого представителя: для этого необходимо передать логин представителя в HTTP-заголовке запроса Client-Login.

Запрос от имени представителя агентства

Любой представитель агентства может получать параметры рекламодателя — клиента агентства и настройки пользователя — представителя рекламодателя: для этого необходимо передать логин представителя рекламодателя в HTTP-заголовке запроса Client-Login.

Любой представитель агентства может получать параметры агентства и собственные настройки.

Главный представитель агентства может также получать настройки другого представителя агентства: для этого необходимо передать логин представителя в HTTP-заголовке запроса Client-Login.

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "FieldNames": [( "AccountQuality" | "Archived" | "ClientId" | "ClientInfo" | "CountryId" | "CreatedAt" | "Currency" | "Grants" | "Login" | "Notification" | "OverdraftSumAvailable" | "Phone" | "Representatives" | "Restrictions" | "Settings" | "Type" | "VatRate" ), ... ] /* required */
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
FieldNames array of ClientFieldEnum

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

Ограничение. При получении параметров агентства параметры AccountQuality, Currency, Grants, OverdraftSumAvailable, Restrictions, Settings не возвращаются.
Да

Ответ

Примечание.

Параметры Login, ClientInfo, CreatedAt, Notification, Phone относятся не к рекламодателю или агентству, а к его представителю:

  • пользователю, от имени которого выполняется запрос, — если в запросе отсутствует HTTP-заголовок Client-Login;

  • пользователю, чей логин указан в HTTP-заголовке Client-Login, — если в запросе присутствует HTTP-заголовок Client-Login.

Остальные параметры относятся к рекламодателю или агентству и не зависят от представителя.

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

ФИО пользователя Директа (до 255 символов).

ФИО пользователя Директа (до 255 символов).
CountryId int Идентификатор страны рекламодателя из справочника регионов.

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

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

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

CreatedAt string

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

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

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

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

Grants array of GrantGetItem Полномочия рекламодателя по управлению кампаниями.
Login string Логин пользователя Директа. Логин пользователя Директа.
Notification NotificationGet

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

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

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

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

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

Представители рекламодателя (см. раздел Регистрация представителей помощи Директа).

Для главного представителя возвращаются все представители, для обычного представителя — только главный представитель.

Представители агентства (см. раздел Управление представителями агентства помощи Директа).

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

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

Тип клиента:

  • CLIENT — прямой рекламодатель;

  • SUBCLIENT — рекламодатель, являющийся клиентом агентства.

См. Клиент (Client).

Тип клиента: AGENCY.
VatRate decimal, nillable Ставка НДС клиента, осуществляющего оплату: прямого рекламодателя или агентства. Ставка НДС агентства.
Структура GrantGetItem
Privilege PrivilegeEnum

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

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

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

Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 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.

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

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

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

  • API_POINTS — суточный лимит баллов.

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

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

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

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

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

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