GetBalance (Live)

Сообщает баланс кампании и сумму, зачисленную за время существования кампании.

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Новое в версии Live 4

Добавлен результирующий параметр SumAvailableForTransfer.

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

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

{
   "method": "GetBalance",
   "param": [
      (int)
      ...
   ]
}

Параметр param содержит массив идентификаторов кампаний, для которых нужно получить сведения.

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

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

{
   "data": [
      {  /* CampaignBalanceInfo */
         "CampaignID": (int),
         "Sum": (float),
         "Rest": (float),
         "SumAvailableForTransfer": (float)
      }
      ...
   ]
}

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

Параметр Описание
Объект CampaignBalanceInfo
CampaignID Идентификатор кампании.
Sum

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

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

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).
Rest

Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен).

Примечание. Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании.

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).
SumAvailableForTransfer

Сумма, доступная для перевода с помощью метода TransferMoney. Возвращается только в случае, если общий счет не подключен. Может быть меньше баланса кампании.

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).
Параметр Описание
Объект CampaignBalanceInfo
CampaignID Идентификатор кампании.
Sum

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

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

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).
Rest

Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен).

Примечание. Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании.

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).
SumAvailableForTransfer

Сумма, доступная для перевода с помощью метода TransferMoney. Возвращается только в случае, если общий счет не подключен. Может быть меньше баланса кампании.

Значение выражено в у. е.

Если кампания ведется в реальной валюте, возвращаемое значение конвертируется из валюты кампании в у. е. и округляется по математическим правилам с точностью до второго знака после запятой (см. раздел Реальные валюты вместо у. е.).