Get

Возвращает параметры общих счетов.

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

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

{
   "method": "AccountManagement",
   "param": {
      /* AccountManagementRequest */
      "Action": (string),
      "SelectionCriteria": {
         /* AccountSelectionCriteria */
         "Logins": [
            (string)
            ...
         ],
         "AccountIDS": [
            (int)
            ...
         ]
      }
   }
}

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

ПараметрОписаниеТребуется
Объект AccountManagementRequest
ActionВыполняемая операция: Get.Да
SelectionCriteriaОбъект AccountSelectionCriteria, содержащий критерии отбора общих счетов.Для агентств
Объект AccountSelectionCriteria
Logins

Для агентств — массив, содержащий логины рекламодателей (не более 50), чьи общие счета нужно получить.

Для рекламодателей допустимо указать единственный (свой) логин.

Для агентств — один из параметров Logins и AccountIDS
AccountIDSМассив идентификаторов общих счетов (не более 100).
Примечание
  1. Для рекламодателей оба параметра Logins и AccountIDS необязательны, но можно указать один из них. В случае пустой или отсутствующей структуры SelectionCriteria будут получены все общие счета (в редких случаях у рекламодателя может быть несколько общих счетов).

  2. Для агентств должен быть задан один из параметров: либо Logins, либо AccountIDS.

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

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

{
   "data": {
      /* AccountManagementResponse */
      "Accounts": [
         {  /* Account */
            "AccountID": (int),
            "Amount": (float),
            "AmountAvailableForTransfer": (float),
            "Currency": (string),
            "Login": (string),
            "Discount": (float),
            "AgencyName": (string),
            "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)
            }
         }
         ...
      ],
      "ActionsResult": [
         {  /* AccountActionResult */
            
            "AccountID": (int),
            "Login": (string),
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ]
   }
}

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

ПараметрОписание
Объект AccountManagementResponse
AccountsМассив объектов Account. Каждый объект содержит параметры общего счета.
ActionResult

Массив объектов AccountActionResult. Содержит данные об ошибках, возникших при получении информации об общих счетах.

Объект Account
AccountIDИдентификатор общего счета.
AmountТекущий баланс общего счета (в валюте общего счета, указанной в параметре Currency).
AmountAvailableForTransferСумма, доступная для перевода с помощью операции TransferMoney (в валюте, указанной в параметре Currency).
Currency

Валюта общего счета.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

LoginЛогин рекламодателя — владельца общего счета.
DiscountТекущая скидка рекламодателя (в процентах). В настоящее время не применяется.
AgencyNameНазвание рекламного агентства, обслуживающего счет. Для счетов, обслуживаемых рекламодателем самостоятельно, параметр отсутствует или равен NULL.
AccountDayBudget

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

SmsNotification

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

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

EmailNotification

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

Объект AccountDayBudgetInfo
Amount

Дневной бюджет общего счета (в валюте общего счета, указанной в параметре Currency).

Минимальное допустимое значение представлено в таблице Валютные параметры и ограничения.

SpendMode

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

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

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

См. подраздел Дневной бюджет раздела «Общий счет» помощи Директа.

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

Объект SmsNotificationInfo
MoneyInSmsСообщать об зачислении средств на общий счет — Yes/No.
MoneyOutSmsСообщать об исчерпании средств на общем счете — Yes/No.
PausedByDayBudgetSmsСообщать об остановке кампаний по достижении дневного ограничения на общий счет — Yes/No.
SmsTimeFromВремя, начиная с которого разрешено отправлять SMS о событиях, связанных с общим счетом. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45).
SmsTimeToВремя, до которого разрешено отправлять SMS о событиях, связанных с общим счетом. Указывается в формате HH:MM, минуты задают кратно 15 (0, 15, 30, 45).
Объект EmailNotificationInfo
EmailАдрес электронной почты для отправки уведомлений, связанных с общим счетом.
MoneyWarningValueМинимальный баланс, при уменьшении до которого отправляется уведомление. Задается в процентах от суммы последнего платежа. Предустановленное значение — 20.
PausedByDayBudgetСообщать об остановке кампаний по достижении дневного ограничения на общий счет — Yes/No.
Объект AccountActionResult
AccountIDИдентификатор общего счета, для которого возникла ошибка (если был задан входной массив AccountIDS).
LoginЛогин рекламодателя, для которого возникла ошибка (если был задан входной массив Logins).
ErrorsМассив объектов Error — ошибок, возникших при получении информации.
Объект Error
FaultCodeКод ошибки.
FaultStringТекст сообщения об ошибке.
FaultDetailПодробное описание причины ошибки.

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

Python

{
   'Action': 'Get',
   'SelectionCriteria': {
      'AccountIDS': [1327944, 1327974]
   }
}

PHP

array(
   'Action' => 'Get',
   'SelectionCriteria' => array(
      'AccountIDS' => array(1327944, 1327974)
   )
)

Perl

{
   'Action' => 'Get',
   'SelectionCriteria' => {
      'AccountIDS' => [1327944, 1327974]
   }
}