Работа с общим счетом
Подключение общего счета
Подключение общего счета и любые операции с ним невозможны, если у рекламодателя нет ни одной кампании.
Прямые рекламодатели и клиенты агентств могут подключить общий счет только в веб-интерфейсе.
Агентство может подключать общий счет своим клиентам с помощью метода EnableSharedAccount (Live).
Узнать, подключен ли у рекламодателя общий счет, можно с помощью методов GetClientInfo (Live) и GetClientsList (Live) (результирующий параметр SharedAccountEnabled).
Получить данные общего счета можно с помощью метода AccountManagement (Live) (операция Get).
Отключение общего счета недоступно.
Пополнение общего счета
Метод AccountManagement (Live) позволяет:
- пополнить общий счет из кредитного лимита агентства или из овердрафта рекламодателя (операция Deposit);
- выставить счет на оплату (операция Invoice);
- перевести средства между общими счетами клиентов агентства (операция TransferMoney).
В течение переходного периода старые финансовые методы PayCampaigns (Live), CreateInvoice (Live), TransferMoney (Live) работают с общим счетом следующим образом. Если при вызове метода указан номер кампании, владелец которой уже подключил общий счет, то средства будут зачислены на общий счет (или, соответственно, списаны с общего счета). При этом для метода TransferMoney (Live) действует дополнительное ограничение: метод может использоваться агентствами для перевода средств между двумя клиентами, один из которых (или оба) используют общий счет. Если при вызове метода указаны кампании более чем двух клиентов и хотя бы у одного из этих клиентов подключен общий счет, возвращается сообщение об ошибке с кодом 353.
Дневной бюджет
Необязательная структура AccountDayBudget содержит параметры Amount и SpendMode. Сброс дневного бюджета осуществляется при передаче значения 0 в параметре Amount.
Настройки информирования
Настроить информирование о событиях, связанных с общим счетом, можно с помощью метода AccountManagement (Live) (операция Update).
Настройки информирования на общем счете и на кампаниях применяются следующим образом.
| Параметры | Для общего счета | Для кампании |
|---|---|---|
| MoneyInSms, MoneyOutSms, MoneyWarningValue | Настраиваются только для общего счета, так как соответствующие события относятся к общему счету. | Не используются при подключенном общем счете. Методы GetCampaignParams (Live) и GetCampaignsParams (Live) возвращают значения соответствующих параметров общего счета. |
| PausedByDayBudget, PausedByDayBudgetSms | Настраиваются только для общего счета, так как соответствующие события относятся к общему счету. | Не используются. |
| SmsTimeFrom, SmsTimeTo | Указывают допустимый интервал времени для SMS-информирования о зачислении и исчерпании средств на общем счете. | Указывают допустимый интервал времени для SMS-информирования о событиях, связанных с кампанией: результатах мониторинга сайтов и модерации объявлений. |
| Адрес электронной почты для информирования о событиях, связанных с общим счетом. | Адрес электронной почты для информирования о событиях, связанных с кампанией. |
| Параметры | Для общего счета | Для кампании |
|---|---|---|
| MoneyInSms, MoneyOutSms, MoneyWarningValue | Настраиваются только для общего счета, так как соответствующие события относятся к общему счету. | Не используются при подключенном общем счете. Методы GetCampaignParams (Live) и GetCampaignsParams (Live) возвращают значения соответствующих параметров общего счета. |
| PausedByDayBudget, PausedByDayBudgetSms | Настраиваются только для общего счета, так как соответствующие события относятся к общему счету. | Не используются. |
| SmsTimeFrom, SmsTimeTo | Указывают допустимый интервал времени для SMS-информирования о зачислении и исчерпании средств на общем счете. | Указывают допустимый интервал времени для SMS-информирования о событиях, связанных с кампанией: результатах мониторинга сайтов и модерации объявлений. |
| Адрес электронной почты для информирования о событиях, связанных с общим счетом. | Адрес электронной почты для информирования о событиях, связанных с кампанией. |
Финансовый токен
При выполнении операций Deposit, Invoice и TransferMoney метода AccountManagement (Live) необходимо указывать порядковый номер операции и финансовый токен.
При формировании финансового токена для этих операций в дополнение к названию метода необходимо указать также название операции. Таким образом, финансовый токен представляет собой зашифрованную методом SHA256 строку, полученную конкатенацией следующих подстрок:
- мастер-токен;
- номер операции (параметр operation_num);
- название метода: AccountManagement;
- название операции: Deposit, Invoice или TransferMoney;
нормализованный логин пользователя, от имени которого делается запрос к API.
Внимание. Если логин пользователя содержит точки и символы верхнего регистра (заглавные буквы), то для получения нормализованного логина их следует заменить, соответственно, дефисами и символами нижнего регистра.