add

Внимание

Метод не поддерживается. Вместо него используется метод addPassportOrganization.

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

Примечание

В запросе к сервису AgencyClients:

В HTTP-заголовке Authorization укажите токен, полученный для представителя агентства.
HTTP-заголовок Client-Login не указывайте.

Узнайте больше

Ограничения

Не более 100 клиентов в день.

Доступ к методу предоставляется по заявке.

Запрос

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

{
  "method": "add",
  "params": { /* params */
      "Login": (string), /* required */
      "FirstName": (string), /* required */
      "LastName": (string), /* required */
      "Currency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" ), /* required */
      "Grants": [{  /* GrantItem */
        "Privilege": ( "EDIT_CAMPAIGNS" | "IMPORT_XLS" | "TRANSFER_MONEY" ), /* required */
        "Value": ( "YES" | "NO" ) /* required */
      }, ... ],
      "Notification": {  /* NotificationAdd */
        "Lang": ( "RU" | "UK" | "EN" | "TR" ), /* required */
        "Email": (string), /* required */
        "EmailSubscriptions": [{  /* EmailSubscriptionItem */
          "Option": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ] /* required */
      }, /* required */
      "Settings": [{  /* ClientSettingAddItem */
        "Option": ( "CORRECT_TYPOS_AUTOMATICALLY" | "DISPLAY_STORE_RATING" ), /* required */
        "Value": ( "YES" | "NO" ) /* required */
      }, ... ],
      "TinInfo": { /* TinInfoAdd */
        "TinType": ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ), /* required */
        "Tin": (string)
      }
  }
}

Параметр	Тип	Описание	Обязательный
Структура params (для JSON) / AddRequest (для SOAP)
`Login`	string	Логин пользователя Директа — главного представителя рекламодателя. По указанному логину создается пользователь на Яндексе и в Директе, поэтому допускается только незанятый логин. Логин может состоять из латинских символов, цифр, одинарного дефиса или точки. Он должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов. Не рекомендуется использовать в логине точки (их следует заменять дефисами) и символы верхнего регистра.	Да
`FirstName`	string	Имя пользователя (не более 20 символов). Не допускаются символы &=<>.	Да
`LastName`	string	Фамилия пользователя (не более 20 символов). Не допускаются символы &=<>.	Да
`Currency`	CurrencyEnum	Валюта рекламодателя.	Да
`Grants`	array of GrantItem	Полномочия рекламодателя по управлению кампаниями. Если не заданы — полномочия отсутствуют.	Нет
`Notification`	NotificationAdd	Настройки SMS- и email-уведомлений для главного представителя рекламодателя.	Да
`Settings`	array of ClientSettingAddItem	Настройки рекламодателя, допускающие только значения YES или NO.	Нет
`TinInfo`	TinInfoAdd	Налоговые данные конечного рекламодателя.	Да
Структура GrantItem
`Privilege`	PrivilegeEnum	Имя полномочия: EDIT_CAMPAIGNS — редактирование кампаний. IMPORT_XLS — управление кампаниями с помощью файлов (см. разделы Управление кампаниями с помощью файлов формата XLS и XLSX и Загрузка кампаний из CSV-файлов помощи Директа). TRANSFER_MONEY — перенос средств между кампаниями (см. раздел Перенос средств между кампаниями). Если полномочие не указано, оно будет создано со значением NO. Для полномочия IMPORT_XLS можно указать значение YES только при условии, что для полномочия EDIT_CAMPAIGNS также указано значение YES, в противном случае возвращается ошибка.	Да
`Value`	YesNoEnum	Есть ли у рекламодателя данное полномочие.	Да
Структура NotificationAdd
`Lang`	LangEnum	Язык уведомлений.	Да
`Email`	string	Адрес электронной почты для отправки уведомлений, связанных с аккаунтом.	Да
`EmailSubscriptions`	array of EmailSubscriptionItem	Типы уведомлений, отправляемых по электронной почте.	Да
Структура EmailSubscriptionItem
`Option`	EmailSubscriptionEnum	Тип уведомления: RECEIVE_RECOMMENDATIONS — новости Директа и рекомендации. TRACK_MANAGED_CAMPAIGNS — уведомления по кампаниям, обслуживаемым персональным менеджером. TRACK_POSITION_CHANGES — предупреждения о снижении прогноза трафика относительно того, который обеспечивали ставки на момент установки. Если тип уведомления не указан, он будет создан со значением NO.	Да
`Value`	YesNoEnum	Отправлять ли уведомления данного типа.	Да
Структура ClientSettingAddItem
`Option`	ClientSettingAddEnum	Имя настройки: CORRECT_TYPOS_AUTOMATICALLY — автоматически исправлять ошибки и опечатки. DISPLAY_STORE_RATING — дополнять объявления данными из внешних источников (см. раздел Данные из внешних источников помощи Директа). Если настройка не указана, она будет создана со значением NO.	Да
`Value`	YesNoEnum	Значение настройки.	Да
Структура TinInfoAdd
`TinType`	TinTypeEnum	Тип организации: LEGAL — юридическое лицо; PHYSICAL — физическое лицо; INDIVIDUAL — индивидуальный предприниматель; FOREIGN_LEGAL — иностранное юридическое лицо; FOREIGN_PHYSICAL — иностранное физическое лицо.	Да
`Tin`	string	Номер налогоплательщика либо его аналог в стране регистрации.	Да

Ответ

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

{
  "result": { /* result */
    "Login": (string),
    "Password":  (string),
    "Email":  (string),
    "ClientId": (long),
    "Warnings": [{  /* ExceptionNotification */
      "Code": (int), /* required */
      "Message": (string), /* required */
      "Details": (string)
    }, ... ],
    "Errors": [{  /* ExceptionNotification */
      "Code": (int), /* required */
      "Message": (string), /* required */
      "Details": (string)
    }, ... ]
  }
}

Параметр	Тип	Описание
Структура result (для JSON) / AddResponse (для SOAP)
`Login`	string	Логин пользователя Директа — главного представителя рекламодателя. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
`Password`	string	Автоматически сгенерированный пароль пользователя. Возвращается в случае отсутствия ошибок.
`Email`	string	Автоматически сгенерированный на основе логина адрес электронной почты. Возвращается в случае отсутствия ошибок.
`ClientId`	long	Идентификатор созданного рекламодателя. Возвращается в случае отсутствия ошибок.
`Warnings`	array of ExceptionNotification	Предупреждения, возникшие при выполнении операции.
`Errors`	array of ExceptionNotification	Ошибки, возникшие при выполнении операции.

Была ли статья полезна?

AgencyClients: управление клиентами агентства

addPassportOrganization