update

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

  1. Запрос
  2. Ответ

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

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

Запрос

Примечание.

Параметры ClientInfo, Notification, Phone относятся к пользователю — представителю рекламодателя:

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

Параметр Settings относится к рекламодателю и не зависит от представителя.

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

{
  "method": "update",
  "params": { /* params */
    "Clients": [{ /* ClientUpdateItem */
      "ClientInfo": (string),
      "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": ( "CORRECT_TYPOS_AUTOMATICALLY" | "DISPLAY_STORE_RATING" ), /* 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)
Clients array of ClientUpdateItem Параметры рекламодателя и настройки пользователя, которые требуется изменить. Да
Структура ClientUpdateItem
ClientInfo string

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

Нет
Notification NotificationUpdate

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

Нет
Phone string

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

Нет
Settings array of ClientSettingUpdateItem Настройки рекламодателя, допускающие только значения YES или NO. Нет
TinInfo TinInfoUpdate Налоговые данные конечного рекламодателя. Нет
ErirAttributes ErirAttributesUpdate Дополнительные данные рекламодателя для маркировки рекламы. Нет
Структура NotificationUpdate
Lang LangEnum Язык уведомлений. Нет
Email string

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

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

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

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

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

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

Да
Value YesNoEnum Отправлять ли уведомления данного типа. Да
Структура ClientSettingUpdateItem
Option ClientSettingUpdateEnum

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

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

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

Да
Value YesNoEnum Значение настройки. Да
Структура TinInfoUpdate
TinType TinTypeEnum

Тип организации:

  • LEGAL — юридическое лицо;
  • PHYSICAL — физическое лицо;
  • INDIVIDUAL — индивидуальный предприниматель;
  • FOREIGN_LEGAL — иностранное юридическое лицо;
  • FOREIGN_PHYSICAL — иностранное физическое лицо.
Нет
Tin string Номер налогоплательщика либо его аналог в стране регистрации. Нет
Структура ErirAttributesUpdate
Organization OrganizationUpdate Информация об организации конечного рекламодателя. Нет
Contract ContractUpdate Информация о договоре клиента-контрагента с конечным рекламодателем. Нет
Contragent ContragentUpdate Информация о контрагенте конечного рекламодателя. Нет
Структура OrganizationUpdate
Name string Наименование организации. Нет
EpayNumber string Номер электронного средства платежа. Нет
RegNumber string Регистрационный номер либо его аналог. Нет
OksmNumber string Код страны регистрации юрлица в соответствии с ОКСМ. Нет
OkvedCode string Код вида деятельности по ОКВЭД. Нет
Структура ContractUpdate
Number string Номер договора. Нет
Date string Дата договора в формате YYYY-MM-DD. Нет
Type ContractTypeEnum

Тип договора:

  • CONTRACT — договор оказания услуг;

  • INTERMEDIARY_CONTRACT — посреднический договор;

  • ADDITIONAL_AGREEMENT — дополнительное соглашение.

    Внимание. Значение ADDITIONAL_AGREEMENT устарело, больше не принимается.
Нет
ActionType ContractActionTypeEnum

Тип осуществляемых посредником-представителем действий:

  • COMMERCIAL — коммерческое представительство;
  • DISTRIBUTION — действия в целях распространения рекламы;
  • CONCLUDE — заключение договоров;
  • OTHER — иное.
Нет
SubjectType ContractSubjectTypeEnum

Предмет договора:

  • REPRESENTATION — представительство;
  • MEDIATION — посредничество;
  • DISTRIBUTION — договор на распространение рекламы;
  • ORG_DISTRIBUTION — договор на организацию распространения рекламы;
  • OTHER — иное.
Нет
Price ContractPrice Цена договора. Нет
Структура ContractPrice
Amount decimal Стоимость договора. Да
IncludingVat YesNoEnum Включен ли в стоимость НДС. Да
Структура ContragentUpdate
Name string Наименование. Нет
Phone string Номер телефона. Нет
EpayNumber string Номер электронного средства платежа. Нет
RegNumber string Регистрационный номер либо его аналог. Нет
OksmNumber string Код страны регистрации юрлица в соответствии с ОКСМ. Нет
TinInfo TinInfoUpdate Налоговые данные контрагента. Нет
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / UpdateRequest (для SOAP)
Clients array of ClientUpdateItem Параметры рекламодателя и настройки пользователя, которые требуется изменить. Да
Структура ClientUpdateItem
ClientInfo string

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

Нет
Notification NotificationUpdate

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

Нет
Phone string

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

Нет
Settings array of ClientSettingUpdateItem Настройки рекламодателя, допускающие только значения YES или NO. Нет
TinInfo TinInfoUpdate Налоговые данные конечного рекламодателя. Нет
ErirAttributes ErirAttributesUpdate Дополнительные данные рекламодателя для маркировки рекламы. Нет
Структура NotificationUpdate
Lang LangEnum Язык уведомлений. Нет
Email string

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

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

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

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

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

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

Да
Value YesNoEnum Отправлять ли уведомления данного типа. Да
Структура ClientSettingUpdateItem
Option ClientSettingUpdateEnum

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

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

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

Да
Value YesNoEnum Значение настройки. Да
Структура TinInfoUpdate
TinType TinTypeEnum

Тип организации:

  • LEGAL — юридическое лицо;
  • PHYSICAL — физическое лицо;
  • INDIVIDUAL — индивидуальный предприниматель;
  • FOREIGN_LEGAL — иностранное юридическое лицо;
  • FOREIGN_PHYSICAL — иностранное физическое лицо.
Нет
Tin string Номер налогоплательщика либо его аналог в стране регистрации. Нет
Структура ErirAttributesUpdate
Organization OrganizationUpdate Информация об организации конечного рекламодателя. Нет
Contract ContractUpdate Информация о договоре клиента-контрагента с конечным рекламодателем. Нет
Contragent ContragentUpdate Информация о контрагенте конечного рекламодателя. Нет
Структура OrganizationUpdate
Name string Наименование организации. Нет
EpayNumber string Номер электронного средства платежа. Нет
RegNumber string Регистрационный номер либо его аналог. Нет
OksmNumber string Код страны регистрации юрлица в соответствии с ОКСМ. Нет
OkvedCode string Код вида деятельности по ОКВЭД. Нет
Структура ContractUpdate
Number string Номер договора. Нет
Date string Дата договора в формате YYYY-MM-DD. Нет
Type ContractTypeEnum

Тип договора:

  • CONTRACT — договор оказания услуг;

  • INTERMEDIARY_CONTRACT — посреднический договор;

  • ADDITIONAL_AGREEMENT — дополнительное соглашение.

    Внимание. Значение ADDITIONAL_AGREEMENT устарело, больше не принимается.
Нет
ActionType ContractActionTypeEnum

Тип осуществляемых посредником-представителем действий:

  • COMMERCIAL — коммерческое представительство;
  • DISTRIBUTION — действия в целях распространения рекламы;
  • CONCLUDE — заключение договоров;
  • OTHER — иное.
Нет
SubjectType ContractSubjectTypeEnum

Предмет договора:

  • REPRESENTATION — представительство;
  • MEDIATION — посредничество;
  • DISTRIBUTION — договор на распространение рекламы;
  • ORG_DISTRIBUTION — договор на организацию распространения рекламы;
  • OTHER — иное.
Нет
Price ContractPrice Цена договора. Нет
Структура ContractPrice
Amount decimal Стоимость договора. Да
IncludingVat YesNoEnum Включен ли в стоимость НДС. Да
Структура ContragentUpdate
Name string Наименование. Нет
Phone string Номер телефона. Нет
EpayNumber string Номер электронного средства платежа. Нет
RegNumber string Регистрационный номер либо его аналог. Нет
OksmNumber string Код страны регистрации юрлица в соответствии с ОКСМ. Нет
TinInfo 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)
UpdateResults array of ClientsActionResult Результат изменения параметров рекламодателя и настроек пользователя.
Структура ClientsActionResult
ClientId long Идентификатор рекламодателя. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Параметр Тип Описание
Структура result (для JSON) / UpdateResponse (для SOAP)
UpdateResults array of ClientsActionResult Результат изменения параметров рекламодателя и настроек пользователя.
Структура ClientsActionResult
ClientId long Идентификатор рекламодателя. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.