AdsApp.​BudgetOrderIterator

  • Provides a way to iterate through a collection of budget orders retrieved by a selector.

  • Offers methods like hasNext(), next(), and totalNumEntities() to navigate and access budget order details.

  • hasNext() checks for the presence of more budget orders, while next() retrieves the next budget order in the iteration sequence.

  • totalNumEntities() provides the total count of budget orders matched by the selector, which might exceed the number of accessible budget orders due to limitations.

 An iterator of budget orders.

Typical usage: 

while (budgetOrderIterator.hasNext()) {
  var budgetOrder = budgetOrderIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.BudgetOrder Returns the next BudgetOrder 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 BudgetOrder in the iterator.

Return values:

TypeDescription
AdsApp.BudgetOrder The next BudgetOrder 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.