An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (for example, spending limit), these differences are juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields.
This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal.
Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.
Fields | |
---|---|
|
Output only. The resource name of the account-level budget. AccountBudget resource names have the form:
|
|
Output only. The status of this account-level budget. |
|
Output only. The total adjustments amount. An example of an adjustment is courtesy credits. |
|
Output only. The value of Ads that have been served, in micros. This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see total_adjustments_micros). |
|
Output only. The pending proposal to modify this budget, if applicable. |
|
Output only. The ID of the account-level budget. |
|
Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form:
|
|
Output only. The name of the account-level budget. |
|
Output only. The proposed start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed, this is the time of request. |
|
Output only. The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval. |
|
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices. |
|
Output only. Notes associated with the budget. |
Union field
|
|
|
Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format. |
|
Output only. The proposed end time as a well-defined type, for example, FOREVER. |
|
|
|
Output only. The approved end time in yyyy-MM-dd HH:mm:ss format. |
|
Output only. The approved end time as a well-defined type, for example, FOREVER. |
Union field
|
|
|
Output only. The proposed spending limit in micros. One million is equivalent to one unit. |
|
Output only. The proposed spending limit as a well-defined type, for example, INFINITE. |
|
|
|
Output only. The approved spending limit in micros. One million is equivalent to one unit. This will only be populated if the proposed spending limit is finite, and will always be greater than or equal to the proposed spending limit. |
|
Output only. The approved spending limit as a well-defined type, for example, INFINITE. This will only be populated if the approved spending limit is INFINITE. |
|
|
|
Output only. The adjusted spending limit in micros. One million is equivalent to one unit. If the approved spending limit is finite, the adjusted spending limit may vary depending on the types of adjustments applied to this budget, if applicable. The different kinds of adjustments are described here: https://support.google.com/google-ads/answer/1704323 For example, a debit adjustment reduces how much the account is allowed to spend. |
|
Output only. The adjusted spending limit as a well-defined type, for example, INFINITE. This will only be populated if the adjusted spending limit is INFINITE, which is guaranteed to be true if the approved spending limit is INFINITE. |