Working with the shared account
Enabling the shared account
Enabling the shared account or performing any operations with it is not possible if the advertiser does not have any campaigns.
Direct advertisers and clients of advertising agencies must use the web interface to enable the shared account.
An agency can use the EnableSharedAccount (Live) method to enable the shared account for its clients.
To find out whether an advertiser has the shared account enabled, use the GetClientInfo (Live) and GetClientsList (Live) methods (the SharedAccountEnabled output parameter).
To get data on the shared account, use the AccountManagement (Live) method (the Get operation).
The shared account can't be disabled.
Adding funds to the shared account
Use the AccountManagement (Live) method to:
- Add funds to the shared account using the agency's credit limit or the advertiser's overdraft (Deposit operation).
- Create an invoice (Invoice operation).
- Transfer funds between the shared accounts of agency clients (TransferMoney operation).
During the transitional period, the old financial methods PayCampaigns (Live), CreateInvoice (Live), TransferMoney (Live) work with the overall score as follows. If the method call specifies the number of a campaign whose owner has already enabled the shared account, funds will be credited to the shared account (or deducted from the shared account, as appropriate). In addition, the TransferMoney (Live) method has an additional restriction: the method can be used by agencies for transferring funds between two clients, one of which (or both) uses the shared account. If the method call specifies campaigns for more than two clients, and at least one of these clients has the shared account enabled, it returns an error message with the code 353.
Setting a daily budget
The optional AccountDayBudget structure contains the Amount and SpendMode parameters. To reset the daily budget, set the Amount parameter to 0.
Notification settings
Use the AccountManagement (Live) method (Update operation) to set up notifications for events related to the shared account.
Notification settings are applied to the shared account and to campaigns in the following way.
| Parameters | For the shared account | For campaigns |
|---|---|---|
| MoneyInSms, MoneyOutSms, MoneyWarningValue | Configured only for the shared account, since the corresponding events are related to the shared account. | Not used when the shared account is enabled. The methods GetCampaignParams () and GetCampaignsParams (Live) return values of the corresponding parameters of the General account. |
| PausedByDayBudget, PausedByDayBudgetSms | Configured only for the shared account, since the corresponding events are related to the shared account. | Not used. |
| SmsTimeFrom, SmsTimeTo | Set the acceptable time range for SMS notifications about credited and deducted funds on the shared account. | Set the acceptable time range for SMS notifications about campaign-related events: results of site monitoring and ad moderation. |
| The email address for notification of events related to the shared account. | The email address for notification of events related to the campaign. |
| Parameters | For the shared account | For campaigns |
|---|---|---|
| MoneyInSms, MoneyOutSms, MoneyWarningValue | Configured only for the shared account, since the corresponding events are related to the shared account. | Not used when the shared account is enabled. The methods GetCampaignParams () and GetCampaignsParams (Live) return values of the corresponding parameters of the General account. |
| PausedByDayBudget, PausedByDayBudgetSms | Configured only for the shared account, since the corresponding events are related to the shared account. | Not used. |
| SmsTimeFrom, SmsTimeTo | Set the acceptable time range for SMS notifications about credited and deducted funds on the shared account. | Set the acceptable time range for SMS notifications about campaign-related events: results of site monitoring and ad moderation. |
| The email address for notification of events related to the shared account. | The email address for notification of events related to the campaign. |
Finance token
When performing the Deposit, Invoice, and TransferMoney actions for the AccountManagement (Live) method, you must specify the sequential number of the transaction and the finance token.
When generating a finance token for these actions, you must also append the action name to the method name. This means the finance token is an SHA256-encoded string obtained by concatenating the following substrings:
- The master token.
- The transaction number (operation_num parameter).
- The method name: AccountManagement.
- The operation name: Deposit, Invoice, or TransferMoney.
The standardized username that the API request is on behalf of.
Attention. If the username contains dots or uppercase characters (capital letters), the username should be standardized by replacing them with hyphens and lowercase characters, respectively.