update
Изменяет параметры рекламодателей — клиентов агентства, а также настройки пользователей — главных представителей рекламодателя.
Примечание
В запросе к сервису AgencyClients
:
- В HTTP-заголовке
Authorization
укажите токен, полученный для представителя агентства. - HTTP-заголовок
Client-Login
не указывайте.
Узнайте больше
- Клиент (Client)
- Роли и доступы пользователей Директа
- Как работает метод update
- Как обрабатывать ошибки
Ограничения
Не более 1000 клиентов в одном вызове метода.
Запрос
Примечание
Параметры ClientInfo
, Notification
, Phone
относятся к главному представителю рекламодателя (см. раздел Роли и доступы пользователей Директа). Параметры ClientId
, Grants
, Settings
относятся к рекламодателю.
Структура запроса в формате JSON:
{
"method": "update",
"params": { /* params */
"Clients": [{ /* AgencyClientUpdateItem */
"ClientId": (long), /* required */
"ClientInfo": (string),
"Grants": [{ /* GrantItem */
"Privilege": ( "EDIT_CAMPAIGNS" | "IMPORT_XLS" | "TRANSFER_MONEY" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"Notification": { /* NotificationUpdate */
"Lang": ( "RU" | "UK" | "EN" | "TR" ),
"Email": (string),
"EmailSubscriptions": [{ /* EmailSubscriptionItem */
"Option": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ]
},
"Phone": (string),
"Settings": [{ /* ClientSettingUpdateItem */
"Option": ( "DISPLAY_STORE_RATING" | "CORRECT_TYPOS_AUTOMATICALLY" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"TinInfo" : { /* TinInfoUpdate */
"TinType" : ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ),
"Tin" : (string) /* nillable */
}, /* nillable */
"ErirAttributes": { /* ErirAttributesUpdate */
"Organization": { /* OrganizationUpdate */
"Name": (string), /* nillable */
"EpayNumber": (string), /* nillable */
"RegNumber": (string), /* nillable */
"OksmNumber": (string), /* nillable */
"OkvedCode": (string) /* nillable */
}, /* nillable */
"Contract": { /* ContractUpdate */
"Number": (string), /* nillable */
"Date": (string), /* nillable */
"Type": ( "CONTRACT" | "INTERMEDIARY_CONTRACT" | "ADDITIONAL_AGREEMENT" ), /* nillable */
"ActionType": ( "COMMERCIAL" | "DISTRIBUTION" | "CONCLUDE" | "OTHER" ), /* nillable */
"SubjectType": ( "REPRESENTATION" | "MEDIATION" | "DISTRIBUTION" | "ORG_DISTRIBUTION" | "OTHER" ), /* nillable */
"Price": { /* PriceUpdate */
"Amount": (decimal), /* required */
"IncludingVat": ( "YES" | "NO" ) /* required */
} /* nillable */
}, /* nillable */
"Contragent": { /* ContragentUpdate */
"Name": (string), /* nillable */
"Phone": (string), /* nillable */
"EpayNumber": (string), /* nillable */
"RegNumber": (string), /* nillable */
"OksmNumber": (string), /* nillable */
"TinInfo": { /* TinInfoUpdate */
"TinType": ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ),
"Tin": (string) /* nillable */
} /* nillable */
} /* nillable */
} /* nillable */
}] /* required */
}
}
Параметр |
Тип |
Описание |
Обязательный |
Структура params (для JSON) / UpdateRequest (для SOAP) |
|||
|
array of AgencyClientUpdateItem |
Параметры рекламодателей — клиентов агентства и настройки пользователей — главных представителей рекламодателя, которые требуется изменить. |
Да |
Структура AgencyClientUpdateItem |
|||
|
long |
Идентификатор рекламодателя. |
Да |
|
string |
Название клиента (до 255 символов). |
Нет |
|
array of GrantItem |
Полномочия рекламодателя по управлению кампаниями. |
Нет |
|
NotificationUpdate |
Настройки SMS- и email-уведомлений пользователя Директа. |
Нет |
|
string |
Номер телефона пользователя Директа (до 50 символов, содержит только цифры и должен начинаться с кода страны). |
Нет |
|
array of ClientSettingUpdateItem |
Настройки рекламодателя, допускающие только значения YES или NO. |
Нет |
|
TinInfoUpdate |
Налоговые данные конечного рекламодателя. |
Нет |
|
ErirAttributesUpdate |
Дополнительные данные рекламодателя для маркировки рекламы. |
Нет |
Структура GrantItem |
|||
|
PrivilegeEnum |
Имя полномочия:
Для полномочия IMPORT_XLS можно указать значение YES только при условии, что для полномочия EDIT_CAMPAIGNS установлено значение YES, в противном случае возвращается ошибка. Для полномочия EDIT_CAMPAIGNS можно указать значение NO только при условии, что для полномочия IMPORT_XLS установлено значение NO, в противном случае возвращается ошибка. |
Да |
|
YesNoEnum |
Есть ли у клиента данное полномочие. |
Да |
Структура NotificationUpdate |
|||
|
LangEnum |
Язык уведомлений. |
Нет |
|
string |
Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 255 символов). |
Нет |
|
array of EmailSubscriptionItem |
Типы уведомлений, отправляемых по электронной почте. |
Нет |
Структура EmailSubscriptionItem |
|||
|
EmailSubscriptionEnum |
Тип уведомления:
|
Да |
|
YesNoEnum |
Отправлять ли уведомления данного типа. |
Да |
Структура ClientSettingUpdateItem |
|||
|
ClientSettingUpdateEnum |
Имя настройки:
|
Да |
|
YesNoEnum |
Значение настройки. |
Да |
Структура TinInfoUpdate |
|||
|
TinTypeEnum |
Тип организации:
|
Нет |
|
string |
Номер налогоплательщика либо его аналог в стране регистрации. |
Нет |
Структура ErirAttributesUpdate |
|||
|
OrganizationUpdate |
Информация об организации конечного рекламодателя. |
Нет |
|
ContractUpdate |
Информация о договоре клиента-контрагента с конечным рекламодателем. |
Нет |
|
ContragentUpdate |
Информация о контрагенте конечного рекламодателя. |
Нет |
Структура OrganizationUpdate |
|||
|
string |
Наименование организации (до 255 символов). |
Нет |
|
string |
Номер электронного средства платежа (до 255 символов). |
Нет |
|
string |
Регистрационный номер либо его аналог (до 255 символов). |
Нет |
|
string |
Код страны регистрации юрлица в соответствии с ОКСМ (до 3 символов, содержит только цифры). |
Нет |
|
string |
Код вида деятельности по ОКВЭД. |
Нет |
Структура ContractUpdate |
|||
|
string |
Номер договора (до 255 символов). |
Нет |
|
string |
Дата договора в формате YYYY-MM-DD (не раньше 01.01.1991). |
Нет |
|
ContractTypeEnum |
Тип договора:
|
Нет |
|
ContractActionTypeEnum |
Тип осуществляемых посредником-представителем действий:
|
Нет |
|
ContractSubjectTypeEnum |
Предмет договора:
|
Нет |
|
ContractPrice |
Цена договора (не более двух знаков после разделителя). |
Нет |
Структура ContractPrice |
|||
|
decimal |
Стоимость договора. |
Да |
|
YesNoEnum |
Включен ли в стоимость НДС. |
Да |
Структура ContragentUpdate |
|||
|
string |
Наименование (до 255 символов). |
Нет |
|
string |
Номер телефона (до 50 символов, содержит только цифры и должен начинаться с кода страны). |
Нет |
|
string |
Номер электронного средства платежа (до 255 символов). |
Нет |
|
string |
Регистрационный номер либо его аналог (до 255 символов). |
Нет |
|
string |
Код страны регистрации юрлица в соответствии с ОКСМ (до 3 символов, содержит только цифры). |
Нет |
|
TinInfoUpdate |
Налоговые данные контрагента. |
Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"UpdateResults": [{ /* ClientsActionResult */
"ClientId": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
]
}, ... ] /* required */
}
}
Параметр |
Тип |
Описание |
Структура result (для JSON) / UpdateResponse (для SOAP) |
||
|
array of ClientsActionResult |
Результат изменения параметров рекламодателей — клиентов агентства, а также настроек пользователей — главных представителей рекламодателя. |
Структура ClientsActionResult |
||
|
long |
Идентификатор рекламодателя. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
|
array of ExceptionNotification |
Предупреждения, возникшие при выполнении операции. |
|
array of ExceptionNotification |
Ошибки, возникшие при выполнении операции. |