AdsApp.​VideoAdIterator

  • VideoAdIterator is used to iterate through a collection of video ads.

  • The hasNext() method checks if there are more elements in the iterator, returning a boolean.

  • The next() method returns the next VideoAd object in the sequence.

  • The totalNumEntities() method provides the total count of entities matched by the selector, which may differ from the number of elements the iterator can provide due to limits.

 An iterator of video ads.

Typical usage: 

while (videoAdIterator.hasNext()) {
  var videoAd = videoAdIterator.next();
}
 Related:

Methods:

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

Return values:

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