AccountBudget

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 (e.g. spending limit), these differences are juxtaposed via '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

resource_name

string

Output only. The resource name of the account-level budget. AccountBudget resource names have the form:

customers/{customer_id}/accountBudgets/{account_budget_id}

id

Int64Value

Output only. The ID of the account-level budget.

billing_setup

StringValue

Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form:

customers/{customer_id}/billingSetups/{billing_setup_id}

status

AccountBudgetStatus

Output only. The status of this account-level budget.

name

StringValue

Output only. The name of the account-level budget.

proposed_start_date_time

StringValue

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.

approved_start_date_time

StringValue

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.

total_adjustments_micros

Int64Value

Output only. The total adjustments amount.

An example of an adjustment is courtesy credits.

amount_served_micros

Int64Value

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).

purchase_order_number

StringValue

Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.

notes

StringValue

Output only. Notes associated with the budget.

pending_proposal

PendingAccountBudgetProposal

Output only. The pending proposal to modify this budget, if applicable.

Union field

proposed_end_time

proposed_end_time. The proposed end time of the account-level budget. proposed_end_time can be only one of the following:

proposed_end_date_time

StringValue

Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.

proposed_end_time_type

TimeType

Output only. The proposed end time as a well-defined type, e.g. FOREVER.

approved_end_time

Union field approved_end_time. The approved end time of the account-level budget.

approved_end_time. The approved end time of the account-level budget.

For example, if a budget's end time is updated and the proposal is approved after the proposed end time, the approved end time is the time of approval. approved_end_time can be only one of the following:

approved_end_time can be only one of the following:

approved_end_date_time

StringValue

Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.

approved_end_time_type

TimeType

Output only. The approved end time as a well-defined type, e.g. FOREVER.

Union field

proposed_spending_limit

proposed_spending_limit. The proposed spending limit. proposed_spending_limit can be only one of the following:

proposed_spending_limit_micros

Int64Value

Output only. The proposed spending limit in micros. One million is equivalent to one unit.

proposed_spending_limit_type

SpendingLimitType

Output only. The proposed spending limit as a well-defined type, e.g. INFINITE.

approved_spending_limit

Union field approved_spending_limit. The approved spending limit.

approved_spending_limit. The approved spending limit.

For example, if the amount already spent by the account exceeds the proposed spending limit at the time the proposal is approved, the approved spending limit is set to the amount already spent. approved_spending_limit can be only one of the following:

approved_spending_limit can be only one of the following:

approved_spending_limit_micros

Int64Value

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.

approved_spending_limit_type

SpendingLimitType

Output only. The approved spending limit as a well-defined type, e.g. INFINITE. This will only be populated if the approved spending limit is INFINITE.

adjusted_spending_limit

Union field adjusted_spending_limit. The spending limit after adjustments have been applied. Adjustments are stored in total_adjustments_micros.

adjusted_spending_limit. The spending limit after adjustments have been applied. Adjustments are stored in total_adjustments_micros.

This value has the final say on how much the account is allowed to spend. adjusted_spending_limit can be only one of the following:

adjusted_spending_limit can be only one of the following:

adjusted_spending_limit_micros

Int64Value

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.

adjusted_spending_limit_type

SpendingLimitType

Output only. The adjusted spending limit as a well-defined type, e.g. 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.