AdsApp.​AdIterator

  • AdIterator is an iterator used to traverse through a collection of ads.

  • The hasNext() method checks if there are more ads available in the iterator.

  • The next() method retrieves the next ad in the sequence.

  • The totalNumEntities() method provides the total count of entities matched by the selector that created the iterator.

 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.