AdsApp.​VideoAdIterator

  • This is an iterator used to access video ads, typically used with a while loop to iterate through each video ad.

  • It provides methods like hasNext() to check for more ads, next() to get the next ad, and totalNumEntities() for the total matched ads.

  • The iterator might not contain all matched entities due to limits, and hasNext() will return false if the limit is reached.

 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.