Budget Orders
Stay organized with collections
Save and categorize content based on your preferences.
Retrieve base spending limit of budget order
function
getBaseSpendingLimit
()
{
const
budgetOrderIterator
=
AdsApp
.
budgetOrders
()
.
get
();
for
(
const
budgetOrder
of
budgetOrderIterator
)
{
let
limitText
=
""
;
if
(
budgetOrder
.
getSpendingLimit
()
==
null
)
{
limitText
=
"unlimited"
;
}
else
if
(
budgetOrder
.
getTotalAdjustments
()
==
null
)
{
limitText
=
budgetOrder
.
getSpendingLimit
();
}
else
{
limitText
=
budgetOrder
.
getSpendingLimit
()
-
budgetOrder
.
getTotalAdjustments
();
}
console
.
log
(
"Budget Order ["
+
budgetOrder
.
getName
()
+
"] base spending limit: "
+
limitText
);
}
}
Retrieve the active budget order
function
getActiveBudgetOrder
()
{
//
There
will
only
be
one
active
budget
order
at
any
given
time
.
const
budgetOrderIterator
=
AdsApp
.
budgetOrders
()
.
withCondition
(
'account_budget.status = "ACTIVE"'
)
.
get
();
for
(
const
budgetOrder
of
budgetOrderIterator
)
{
const
budgetOrder
=
budgetOrderIterator
.
next
();
console
.
log
(
`
Budget
Order
[
$
{
budgetOrder
.
getName
()}]
is
currently
active
.
`
);
}
}
Retrieve all budget orders
function
getAllBudgetOrders
()
{
const
budgetOrderIterator
=
AdsApp
.
budgetOrders
()
.
get
();
return
budgetOrderIterator
;
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThis script provides functions to retrieve budget order information from Google Ads, including the base spending limit, active budget order, and all budget orders.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetBaseSpendingLimit()\u003c/code\u003e calculates and logs the base spending limit of each budget order, considering total adjustments.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetActiveBudgetOrder()\u003c/code\u003e identifies and logs the currently active budget order within the Google Ads account.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetAllBudgetOrders()\u003c/code\u003e retrieves and returns an iterator containing all budget orders associated with the account.\u003c/p\u003e\n"]]],[],null,["# Budget Orders\n\nRetrieve base spending limit of budget order\n--------------------------------------------\n\n```gdscript\nfunction getBaseSpendingLimit() {\n const budgetOrderIterator = AdsApp.budgetOrders().get();\n for (const budgetOrder of budgetOrderIterator) {\n let limitText = \"\";\n if (budgetOrder.getSpendingLimit() == null) {\n limitText = \"unlimited\";\n } else if (budgetOrder.getTotalAdjustments() == null) {\n limitText = budgetOrder.getSpendingLimit();\n } else {\n limitText = budgetOrder.getSpendingLimit() -\n budgetOrder.getTotalAdjustments();\n }\n console.log(\"Budget Order [\" + budgetOrder.getName() +\n \"] base spending limit: \" + limitText);\n }\n}\n```\n\nRetrieve the active budget order\n--------------------------------\n\n```gdscript\nfunction getActiveBudgetOrder() {\n // There will only be one active budget order at any given time.\n const budgetOrderIterator = AdsApp.budgetOrders()\n .withCondition('account_budget.status = \"ACTIVE\"')\n .get();\n for (const budgetOrder of budgetOrderIterator) {\n const budgetOrder = budgetOrderIterator.next();\n console.log(`Budget Order [${budgetOrder.getName()}] is currently active.`);\n }\n}\n```\n\nRetrieve all budget orders\n--------------------------\n\n```gdscript\nfunction getAllBudgetOrders() {\n const budgetOrderIterator = AdsApp.budgetOrders().get();\n return budgetOrderIterator;\n}\n```"]]
