AdsApp.​BudgetOrder

AI-generated Key Takeaways

• Google Ads budget orders manage client budgets at the account level and are associated with a billing account for consolidated billing.

• You can retrieve the budget order's associated billing account, end date, ID, name, purchase order number, resource name, effective spending limit, start date, and total adjustments using specific methods.

• The getSpendingLimit() method returns the effective spending limit including all adjustments applied to the budget order, or null if there is no limit.

• The getTotalAdjustments() method returns the total adjustments applied to the spending limit in the account's currency, or null if no adjustments have been applied.

Represents a Google Ads budget order. Budget orders are used for managing client budgets at the account level.

Each budget order is associated with a billing account which can take invoices for consolidated billing. For details about budget orders and billing accounts, see Billing.

Methods:

Member	Type	Description
getBillingAccount()	AdsApp.BillingAccount	Returns the associated billing account.
getEndDateTime()	AdsApp.GoogleAdsDate	Returns the budget order's end date or null if there is no end date.
getId()	String	Returns the ID of the budget order.
getName()	String	Returns the name of the budget order.
getPoNumber()	String	Returns the purchase order number or null if there is no purchase order number.
getResourceName()	String	Returns the resource name of the budget order.
getSpendingLimit()	double	Returns the effective spending limit in the account's currency, including all adjustments that have been applied to the budget order.
getStartDateTime()	AdsApp.GoogleAdsDate	Returns the budget order's start date.
getTotalAdjustments()	double	Returns the total adjustments that have been applied to the spending limit, in the account's currency.

getBillingAccount()

Returns the associated billing account. Will be null if billing setup is still pending.

Return values:

Type	Description
AdsApp.BillingAccount	The budget order's start date.

getEndDateTime()

Returns the budget order's end date or null if there is no end date.

Return values:

Type	Description
AdsApp.GoogleAdsDate	The budget order's end date or null if there is no end date.

getId()

Returns the ID of the budget order.

Return values:

Type	Description
String	The ID of the budget order.

getName()

Returns the name of the budget order.

Return values:

Type	Description
String	Name of the budget order.

getPoNumber()

Returns the purchase order number or null if there is no purchase order number.

Return values:

Type	Description
String	The purchase order number or null if there is no purchase order number.

getResourceName()

Returns the resource name of the budget order.

Return values:

Type	Description
String	The resource name of the budget order.

getSpendingLimit()

Returns the effective spending limit in the account's currency, including all adjustments that have been applied to the budget order. null indicates no limits. Code example.

Return values:

Type	Description
double	The effective spending limit or null if there is no limit.

getStartDateTime()

Returns the budget order's start date.

Return values:

Type	Description
AdsApp.GoogleAdsDate	The budget order's start date.

getTotalAdjustments()

Returns the total adjustments that have been applied to the spending limit, in the account's currency. To get the base spending limit, subtract this from the effective spending limit. null indicates no adjustments have been applied.

Return values:

Type	Description
double	The net sum of adjustments since the creation of the budget order.