GetBalance (Live)

Notifies you of the campaign balance and the total amount transferred to the campaign over the course of its existence.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.

New in the Live 4 version

Added the SumAvailableForTransfer output parameter.

Input data

The input data structure in JSON is shown below.

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

The param parameter contains an array of IDs for campaigns that you need to get information for.

Output data

The output data structure in JSON is shown below.

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

Parameters are described below.

ParameterDescription
CampaignBalanceInfo object
CampaignIDThe campaign ID.
Sum

If the client has the shared account enabled, this is the total amount of funds spent over the campaign's existence.

If the shared account is disabled, this is the amount of funds added to the campaign over the campaign's existence.

The value is in Yandex units.

If the campaign operates in a real currency, the returned value is converted from the campaign's currency to units and mathematically rounded to the second decimal place (see the section Real currencies instead of Yandex units).

Rest

The current balance of the shared account + the amount refunded to the campaign (if the advertiser has the shared account enabled) or the current campaign balance (if the shared account is disabled).

Note. The amount of money returned for clicks that the system determines to be fraudulent or mistaken; this amount can be spent only within the same campaign.

The value is in Yandex units.

If the campaign operates in a real currency, the returned value is converted from the campaign's currency to units and mathematically rounded to the second decimal place (see the section Real currencies instead of Yandex units).

SumAvailableForTransfer

The amount available to transfer using the TransferMoney method. It is returned only if the shared account is not enabled. It may be less than the campaign balance.

The value is in Yandex units.

If the campaign operates in a real currency, the returned value is converted from the campaign's currency to units and mathematically rounded to the second decimal place (see the section Real currencies instead of Yandex units).