Budget Orders

AI-generated Key Takeaways

• This script provides functions to retrieve budget order information from Google Ads, including the base spending limit, active budget order, and all budget orders.

• getBaseSpendingLimit() calculates and logs the base spending limit of each budget order, considering total adjustments.

• getActiveBudgetOrder() identifies and logs the currently active budget order within the Google Ads account.

• getAllBudgetOrders() retrieves and returns an iterator containing all budget orders associated with the account.

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;
}