AdsApp.​BudgetIterator

  • BudgetIterator allows you to iterate through a collection of Budget objects, typically obtained using a BudgetSelector.

  • You can use hasNext() to check if there are more budgets to iterate over and next() to retrieve the next Budget object.

  • The totalNumEntities() method provides the total number of budgets matched by the selector, but this may exceed the number of budgets you can actually iterate through due to system limitations.

 An iterator of budgets.

Typical usage: 

while (budgetIterator.hasNext()) {
  var budget = budgetIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.Budget Returns the next Budget in the iterator.
totalNumEntities() int Returns the total number of entities matched by the selector which generated this iterator.

hasNext()

Returns true if the iterator has more elements.

Return values:

TypeDescription
boolean true if the iterator has more elements.

next()

Returns the next Budget in the iterator.

Return values:

TypeDescription
AdsApp.Budget The next Budget in the iterator.

totalNumEntities()

Returns the total number of entities matched by the selector which generated this iterator.

Note that the returned number disregards limits, and that the iterator is not guaranteed to have this many elements — hasNext will start to return false and next will start to throw exceptions as soon as the limit for entity reads has been reached, even if the selector matched more entities.

Return values:

TypeDescription
int The number of entities matched by the selector which generated this iterator.