Budget Orders

AI-generated Key Takeaways

• The provided code snippets demonstrate how to retrieve various types of budget order information using the AdsApp in Google Ads scripts.

• One function shows how to calculate the base spending limit for each budget order, accounting for unlimited limits or adjustments.

• Another function illustrates how to specifically retrieve the currently active budget order.

• A simple function is provided to retrieve all available budget orders.

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