|
|
BudgetingService
BudgetingService provides operations for managing the daily spend limits
of accounts and campaigns.
Operations
- getAccountDailySpendLimit
- getAccountDailySpendLimitStatus
- getCampaignDailySpendLimit
- getCampaignDailySpendLimitStatus
- updateAccountDailySpendLimit
- updateCampaignDailySpendLimit
- updateCampaignDailySpendLimitStatus
getAccountDailySpendLimit
Return the account daily spend limit for the account (specified by accountID).
Capability required: AccountRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
Response
SpendLimit - The daily spend limit and status of the account, including the spend cap per tactic.
getAccountDailySpendLimitStatus
Return a flag that indicates if the account daily spend limit is enabled or disabled for the account (specified by accountID).
Capability required: AccountRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
Response
boolean - If true, daily spend limiting is enabled. If false, daily spend limiting is disabled.
getCampaignDailySpendLimit
Return the campaign daily spend limit for the campaign (specified by campaignID).
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
SpendLimit - The daily spend limit and status of the campaign, including the spend cap per tactic.
getCampaignDailySpendLimitStatus
Return a flag that indicates if the campaign daily spend limit is enabled or disabled for the campaign (specified by campaignID).
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
Response
boolean - If true, daily spend limiting is enabled. If False, daily spend limiting is disabled.
updateAccountDailySpendLimit
Enable and/or update the account daily spend limit for the account (specified by accountID)
and, optionally, set a cap on the daily spend per tactic.
If the account daily spend limit is disabled, use this operation to enable and set
the account daily spend limit. (To determine the previous account daily spend limit
amount, if any, use the getAccountDailySpendLimit operation.)
If the account daily spend limit is already enabled, use this operation to update
the account daily spend limit and/or to set a hard cap on the spend limit.
Once the account daily spend limit is enabled it cannot be disabled.
Capability required: AccountWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
| limit | SpendLimit | The spend limit and status of the account, including the spend cap per tactic. |
Response
none
updateCampaignDailySpendLimit
Enable and/or update the campaign daily spend limit for the campaign (specified by
campaignID) and, optionally, set a hard cap on the daily spend per tactic.
If the campaign daily spend limit is disabled, use this operation to enable and set
the campaign daily spend limit. (To determine the previous campaign daily spend limit,
if any, use the getCampaignDailySpendLimit operation.)
If the campaign daily spend limit is already enabled, use this operation to
update the daily spend limit and/or to set a hard cap on the spend limit.
The campaign daily spend limit overrides (but will not exceed) the
account daily spend limit.
Note: If you enable campaign optimization, the campaign daily spend limit is
controlled and automatically adjusted for you; calling this operation will generate an error
(see Campaign Optimization and Spend Limits).
If you subsequently disable campaign optimization, the campaign daily spend limit
remains set to the last value used during optimization. Use this operation to
re-set the amount, if desired.
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The ID of the campaign whose limit needs to be altered. |
| limit | SpendLimit | The spend limit and status of the campaign, including the spend cap per tactic. |
Response
none
updateCampaignDailySpendLimitStatus
Enable or disable the campaign daily spend limit for the campaign (specified by campaignID).
Note: If you enable campaign optimization, the campaign daily spend limit is controlled and automatically adjusted for you; calling this operation will generate an error (see Campaign Optimization and Spend Limits).
Capability required: CampaignWrite
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| campaignID | long | The campaign ID. |
| status | boolean | True to enable daily spend limiting. False to disable daily spend limiting. |
Response
none