AdsApp.​AdIterator

  • This page describes an AdIterator, which allows you to iterate through a collection of ads.

  • You can use hasNext() to check if there are more ads and next() to retrieve the next ad in the iteration.

  • totalNumEntities() provides the total count of ads matched by the selector, which may exceed the actual number of ads iterated due to limits.

  • This iterator is often obtained using AdSelector.get(), and each retrieved element is an Ad object.

 An iterator of ads.

Typical usage: 

while (adIterator.hasNext()) {
  var ad = adIterator.next();
}
 Related:

Methods:

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

Return values:

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