Update

Изменяет настройки общих счетов.

Ограничения

Изменять настройки дневного бюджета можно не более 3 раз в сутки.

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

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

Внимание

Значения неуказанных параметров не изменяются.

{
   "method": "AccountManagement",
   "param": {
      /* AccountManagementRequest */
      "Action": (string),
      "Accounts": [
         {  /* Account */
            "AccountID": (int),
            "AccountDayBudget": {
               /* AccountDayBudgetInfo */
               "Amount": (float), 
               "SpendMode": (string)
            },
            "SmsNotification": {
               /* SmsNotificationInfo */
               "MoneyInSms": (string),
               "MoneyOutSms": (string),
               "PausedByDayBudgetSms": (string),
               "SmsTimeFrom": (string),
               "SmsTimeTo": (string)
            },
            "EmailNotification": {
               /* EmailNotificationInfo */
               "Email": (string),
               "MoneyWarningValue": (int),
               "PausedByDayBudget": (string)
            }
         }
         ...
      ]
   }
}

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

Параметр

Описание

Требуется

Объект AccountManagementRequest

Action

Выполняемая операция: Update.

Да

Accounts

Массив объектов Account. Каждый объект содержит информацию о настройках общего счета.

Нет

Объект Account

AccountID

Идентификатор общего счета, настройки которого необходимо изменить.

Да

AccountDayBudget

Объект AccountDayBudgetInfo с параметрами дневного ограничения на общий счет.

Нет

SmsNotification

Объект SmsNotificationInfo с параметрами отправки SMS-уведомлений.

Чтобы получать уведомления, необходимо подписаться на них (см. раздел справки Подпишитесь на SMS-уведомленияSubscribe to SMS notifications). Телефонный номер для отправки берется из персональных данных пользователя (см. раздел справки Номера телефоновMobile numbers).

Нет

EmailNotification

Объект EmailNotificationInfo с параметрами отправки уведомлений по электронной почте.

Нет

Объект AccountDayBudgetInfo

Amount

Дневной бюджет общего счета (в валюте общего счета).

Минимальное допустимое значение можно получить с помощью метода Dictionaries.get API версии 5, указав в запросе имя справочника Currencies.

Значение 0 — сброс дневного бюджета.

Да

SpendMode

Режим показа объявлений:

  • Default — стандартный.

  • Stretched — распределенный.

См. подраздел Дневной бюджетDaily budget раздела “Общий счет”“Shared account” помощи Директа.

Режим действует для всех кампаний, соответствующая настройка кампании игнорируется.

Да

Объект SmsNotificationInfo

MoneyInSms

Сообщать о зачислении средств на общий счет — Yes/No. Предустановленное значение — No.

Нет

MoneyOutSms

Сообщать об исчерпании средств на общем счете — Yes/No. Предустановленное значение — No.

Нет

PausedByDayBudgetSms

Сообщать об остановке кампаний по достижении дневного ограничения на общий счет — Yes/No. Предустановленное значение — Yes.

Нет

SmsTimeFrom

Время, начиная с которого разрешено отправлять SMS о событиях, связанных с общим счетом. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”.

Нет

SmsTimeTo

Время, до которого разрешено отправлять SMS о событиях, связанных с общим счетом. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45). Например, “19:45”.

Нет

Объект EmailNotificationInfo

Email

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

Нет

MoneyWarningValue

Минимальный баланс, при уменьшении до которого отправляется уведомление. Задается в процентах от суммы последнего платежа. Предустановленное значение — 20.

Нет

PausedByDayBudget

Сообщать об остановке кампаний по достижении дневного ограничения на общий счет — Yes/No. Предустановленное значение — Yes.

Нет

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

Внимание

Ошибка при изменении настроек одного из общих счетов не влечет отмену всей операции и не влияет на успешность изменения настроек остальных общих счетов.

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

{
   "data": {
      /* AccountManagementResponse */
      "ActionsResult": [
         {  /* AccountActionResult */
            "AccountID": (int),            
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ]
   }
}

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

Параметр

Описание

Объект AccountManagementResponse

ActionsResult

Массив объектов AccountActionResult. Каждый объект соответствует элементу входного массива Accounts и содержит:

  • в случае успешного изменения настроек — идентификатор общего счета;
  • в случае ошибки — массив Errors.

Элементы массива следуют в том же порядке, что и объекты входного массива Accounts.

Объект AccountActionResult

AccountID

Идентификатор общего счета, настройки которого успешно изменены.

Errors

Массив объектов Error — ошибок, возникших при переводе средств.

Объект Error

FaultCode

Код ошибки.

FaultString

Текст сообщения об ошибке.

FaultDetail

Подробное описание причины ошибки.

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

Python

{
   'Action': 'Update',
   'Accounts': [
      {
         'AccountID': 1327944,
         'SmsNotification': {
            'MoneyInSms': 'Yes',
            'MoneyOutSms': 'Yes'
         },
         'EmailNotification': {
            'Email': 'agrom@yandex.ru',
            'MoneyWarningValue': 25
         }
      }
   ]
}

PHP

array(
   'Action' => 'Update',
   'Accounts' => array(
      array(
         'AccountID' => 1327944,
         'SmsNotification' => array(
            'MoneyInSms' => 'Yes',
            'MoneyOutSms' ='Yes'
         ),
         'EmailNotification' => array(
            'Email' => 'agrom@yandex.ru',
            'MoneyWarningValue' =25
         )
      )
   )
)

Perl

{
   'Action' => 'Update',
   'Accounts' => [
      {
         'AccountID' => 1327944,
         'SmsNotification' ={
            'MoneyInSms' => 'Yes',
            'MoneyOutSms' ='Yes'
         },
         'EmailNotification' ={
            'Email' => 'agrom@yandex.ru',
            'MoneyWarningValue' =25
         }
      }
   ]
}
Предыдущая
Следующая