AdsApp.​SitelinkIterator

  • SitelinkIterator provides an iterator over a collection of sitelinks.

  • The hasNext() method checks if there are more sitelinks to iterate through.

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

  • The totalNumEntities() method returns the total count of sitelinks matched by the selector, ignoring limits.

 An iterator of sitelinks.

Typical usage: 

while (sitelinkIterator.hasNext()) {
  var sitelink = sitelinkIterator.next();
}
 Related:

Methods:

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

Return values:

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