GetClientInfo (Live)

Возвращает учетные записи в Яндекс Директе.

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Прямой рекламодатель может получать свою учетную запись и учетные записи представителей. Рекламное агентство может дополнительно получать учетные записи своих клиентов.

Новое в версии Live 4

Добавлены результирующие параметры OverdraftSumAvailable и Currency.

Добавлены результирующие параметры ClientCurrencies и VATRate (см. также раздел Реальные валюты вместо у. е.).

Добавлен результирующий параметр SharedAccountEnabled.

Добавлен результирующий параметр DisplayStoreRating.

Добавлен результирующий параметр OverdraftSumAvailableInCurrency.

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "GetClientInfo",
   "param": [
      (string)
      ...
   ]
}

Массив param содержит логины учетных записей в Яндекс Директе (совпадают с логинами пользователей в Яндексе). Можно указать не более 1000 логинов.

При указании несуществующего логина возвращается сообщение об ошибке 259.

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

Результирующие данные

Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* ClientInfo */
         "Login": (string),
         "DateCreate": (date),
         "Phone": (string),
         "FIO": (string),
         "Email": (string),
         "StatusArch": (string),
         "SharedAccountEnabled": (string),
         "Discount": (float),
         "OverdraftSumAvailable": (float),
         "OverdraftSumAvailableInCurrency": (float),
         "Currency": (string),
         "ClientCurrencies": [
            (string)
            ...
         ],
         "VATRate": (float),
         "SmsPhone": (string),
         "CampaignEmails": [
            (string)
            ...
         ],
         "ClientRights": [
            {  /* ClientRight */
               "RightName": (string),
               "Value": (string),
            }
            ...
         ],
         "Role": (string),
         "NonResident": (string),
         "SendNews": (string),
         "SendAccNews": (string),
         "SendWarn": (string),
         "DisplayStoreRating": (string)
     }
      ...
   ]
}

Ниже приведено описание параметров.

Параметр Описание
Объект ClientInfo
Login

Логин пользователя на Яндексе.
Phone

Контактный телефон в произвольном формате. Рекомендуется указывать номер в международном формате, например +7(495)137-33-33.
DateCreate

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

Фамилия и инициалы.
Email

Адрес электронной почты для отправки новостей и уведомлений.
StatusArch

Учетная запись пользователя помещена в архив (не активна) — Yes/No.
SharedAccountEnabled Подключен ли у клиента общий счет — Yes/No.
Discount

Персональная скидка. В настоящее время не применяется.
OverdraftSumAvailable

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

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

Оплата кампаний за счет овердрафта выполняется с помощью метода PayCampaigns.
OverdraftSumAvailableInCurrency

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

Значение в реальной валюте не включает НДС.
Currency

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

ClientCurrencies

Массив, содержащий обозначения валют клиента.

Если клиент является прямым рекламодателем или клиентом агентства (роль Client), то:

  • если клиент работает в у. е., то параметр не возвращается (отсутствует или равен NULL);
  • если клиент работает в реальной валюте, то массив содержит единственную валюту, в которой клиент может создавать новые кампании.

Если клиент является агентством (роль Agency), массив содержит доступные агентству валюты. Агентство может регистрировать субклиентов в этих валютах. Возможные значения: cu (условные единицы), RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

VATRate Ставка НДС клиента, осуществляющего оплату: прямого рекламодателя или агентства. Если клиент является клиентом агентства, возвращается НДС агентства.
SmsPhone

Телефонный номер для отправки sms-уведомлений. Берется из учетной записи пользователя в Яндексе.
CampaignEmails

Массив адресов электронной почты всех кампаний пользователя.
Role

Роль в Яндекс Директе:

  • Client — клиент рекламного агентства, или прямой рекламодатель, или представитель прямого рекламодателя;
  • Agency — рекламное агентство или представитель агентства.
NonResident

Нерезидент — Yes/No.
SendNews

Сообщать о новостях Яндекс Директа — Yes/No.
SendAccNews

Сообщать о состоянии кампаний, обслуживаемых персональным менеджером в Яндексе, — Yes/No.
SendWarn

Сообщать о перемещении объявлений на более низкие позиции относительно желаемых — Yes/No.
ClientRights

Массив объектов ClientRight. Они определяют полномочия клиента рекламного агентства по управлению кампаниями, которые агентство создало для него.

Параметр доступен только для рекламных агентств.
DisplayStoreRating Показывать рейтинг магазина в объявлениях — Yes/No.
Объект ClientRight
RightName

Название полномочий, которые предоставляются или отменяются:

  • AllowEditCampaigns — разрешать изменение параметров кампаний;
  • AllowTransferMoney — разрешать перевод средств между кампаниями;
  • AllowImportXLS — разрешать загрузку данных из файлов MS Excel.
Value

Значение Yes — предоставить указанные полномочия, значение No — отменить.
Параметр Описание
Объект ClientInfo
Login

Логин пользователя на Яндексе.
Phone

Контактный телефон в произвольном формате. Рекомендуется указывать номер в международном формате, например +7(495)137-33-33.
DateCreate

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

Фамилия и инициалы.
Email

Адрес электронной почты для отправки новостей и уведомлений.
StatusArch

Учетная запись пользователя помещена в архив (не активна) — Yes/No.
SharedAccountEnabled Подключен ли у клиента общий счет — Yes/No.
Discount

Персональная скидка. В настоящее время не применяется.
OverdraftSumAvailable

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

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

Оплата кампаний за счет овердрафта выполняется с помощью метода PayCampaigns.
OverdraftSumAvailableInCurrency

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

Значение в реальной валюте не включает НДС.
Currency

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

ClientCurrencies

Массив, содержащий обозначения валют клиента.

Если клиент является прямым рекламодателем или клиентом агентства (роль Client), то:

  • если клиент работает в у. е., то параметр не возвращается (отсутствует или равен NULL);
  • если клиент работает в реальной валюте, то массив содержит единственную валюту, в которой клиент может создавать новые кампании.

Если клиент является агентством (роль Agency), массив содержит доступные агентству валюты. Агентство может регистрировать субклиентов в этих валютах. Возможные значения: cu (условные единицы), RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

VATRate Ставка НДС клиента, осуществляющего оплату: прямого рекламодателя или агентства. Если клиент является клиентом агентства, возвращается НДС агентства.
SmsPhone

Телефонный номер для отправки sms-уведомлений. Берется из учетной записи пользователя в Яндексе.
CampaignEmails

Массив адресов электронной почты всех кампаний пользователя.
Role

Роль в Яндекс Директе:

  • Client — клиент рекламного агентства, или прямой рекламодатель, или представитель прямого рекламодателя;
  • Agency — рекламное агентство или представитель агентства.
NonResident

Нерезидент — Yes/No.
SendNews

Сообщать о новостях Яндекс Директа — Yes/No.
SendAccNews

Сообщать о состоянии кампаний, обслуживаемых персональным менеджером в Яндексе, — Yes/No.
SendWarn

Сообщать о перемещении объявлений на более низкие позиции относительно желаемых — Yes/No.
ClientRights

Массив объектов ClientRight. Они определяют полномочия клиента рекламного агентства по управлению кампаниями, которые агентство создало для него.

Параметр доступен только для рекламных агентств.
DisplayStoreRating Показывать рейтинг магазина в объявлениях — Yes/No.
Объект ClientRight
RightName

Название полномочий, которые предоставляются или отменяются:

  • AllowEditCampaigns — разрешать изменение параметров кампаний;
  • AllowTransferMoney — разрешать перевод средств между кампаниями;
  • AllowImportXLS — разрешать загрузку данных из файлов MS Excel.
Value

Значение Yes — предоставить указанные полномочия, значение No — отменить.

Примеры входных данных

Perl

['agrom','larry']

PHP

array('agrom','larry')